logo

VOS REST API Documentation

This document contains information that is proprietary and confidential to Harmonic Inc. and is intended for the specific use of the recipient for the express purpose of operating the Harmonic VOS system. This document is provided to the recipient with the expressed understanding that the recipient will not divulge its contents to other parties or otherwise misappropriate the information contained herein. Harmonic and all Harmonic product names are trademarks of Harmonic Inc. All other trademarks are the property of their respective owners. Copyright 2021 Harmonic Inc. All rights reserved. All information subject to change without notice.

Version

1.28.0.0.66

Overview

VOS REST API enables you to control and manage VOS from any platforms.

The REST API provides resources and method to
  • Service management

    • Setup an IPTV service

    • Input grooming and source discovery

    • Setup images for logo or slate insertion

    • Get service status

    • Change slate image

    • Switch slate state

  • System maintenance

    • Query notifications

    • Schedule a time to resolve a notification

    • Download logs

Getting Started with the REST API

This tutorial shows you how to access to the API and invoke API methods using HTTP requests.

To use the API, it is important that you understand the basics of RESTful web services, JSON representations and OAuth.

Using OAuth 2.0 to access VOS REST API

VOS REST API uses OAuth 2.0 for authorization. The following grant types are supported:

Here is the high level flow for integrating with VOS REST API via the corresponding OAuth 2.0 grant:

  1. Login to VOS and create a client app with the corresponding OAuth 2.0 grant (you need to have admin privilege in VOS).

  2. Obtain an access token for the API client.

  3. API client sends the access token to an API by putting this in the HTTP header: Authorization: Bearer $access_token

  4. API client obtains a new access token after it expires.

Authorization code grant

For general understanding of authorization code grant, please visit: OAuth 2.0 Authorization Code Grant

In VOS, access token grant from authorization code contains permissions from the user who login and grant authorization code. It is aimed to represent the user to access resources.

Register API Client
  1. Login to VOS SW Cluster. Go to Settings → Client Apps → Add Client.

  2. Fill in the following configurations.

    1. Check Authorization code.

    2. Fill in a meaningful description.

    3. Fill in a redirect URI, e.g. https://{yoursite}/oauth/authorizationCode, then click ‘+’.

    4. Click ‘Add’ to create the client app.

  3. You will then obtain the client app ID & secret. Securely store them - they will be used in the subsequent procedure.

Generate Authorization Code
  1. Login to VOS SW Cluster.

  2. Go to this endpoint in web browser: https://{yoursite}/oauth/authorize?response_type=code&client_id={client_id}&redirect_uri=https://{yoursite}/oauth/authorizationCode

  3. Obtain the authorization code that is appended in the web browser address bar, e.g. https://{yoursite}/oauth/authorizationCode?code=h0Mi0s

Generate Access Token

Send a POST request to:

https://{yoursite}/oauth/token

Request

POST /oauth/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic base64encode(client_id:client_secret) (1)

code=h0Mi0s&redirect_uri=http://yourcallback.com/callback&grant_type=authorization_code (2)
  1. Basic authentication using client_id and client_secret.

  2. Authorization code.

Response

{
    "access_token": "5ee3a233-212e-412b-af99-43f623128799", (1)
    "token_type": "bearer",
    "refresh_token": "5237a3c7-feb4-415f-bdcd-3f2de428b8c4", (2)
    "expires_in": 43170
    (3)
}
  1. Access token that can be used to consume the protected resources.

  2. Refresh token that can be used to obtain a new access token.

  3. Remaining lifetime of the access token.

Calling VOS REST API with access token

You can call VOS API by putting the access token in the HTTP header:

Authorization: Bearer $access_token

The API endpoints are in the following format:

https://{yoursite}/vos-api/module/v1/resourcePath?parameter

Here is an example: list all configured services

HTTP METHOD

GET

REQUEST URI

https://{yoursite}/vos-api/configure/v1/services

REQUEST HEADER

Authorization: Bearer 5ee3a233-212e-412b-af99-43f623128799

If the request succeeds, the first line of the response is:

HTTP/1.1 200 OK

and the response body is the list of services in JSON array

Refresh Access Token

After the access token expires, send a POST request to the following to refresh it:

https://{yoursite}/oauth/token

Request

POST /oauth/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic base64encode(client_id:client_secret) (1)

refresh_token=5237a3c7-feb4-415f-bdcd-3f2de428b8c4&grant_type=refresh_token (2)
  1. Basic authentication using client_id and client_secret.

  2. Refresh token.

Response

{
    "access_token": "8f1844a8-1e35-4e75-9e31-aa82fff58e81",
    "token_type": "bearer",
    "refresh_token": "5237a3c7-feb4-415f-bdcd-3f2de428b8c4",
    "expires_in": 43170
}

Client credentials grant

For general understanding of client credentials grant please visit: OAuth 2.0 Client Credentials Grant

In VOS, access token granted from client credentials contains permissions from the user who set up the client app. Client credentials grant is aimed to serve the use case of system-to-system without any user involvement.

Register API Client
  1. Login to VOS SW Cluster. Go to Settings → Client Apps → Add Client.

  2. Fill in the following configurations.

    1. Check Client credential.

    2. Fill in a meaningful description.

    3. Click ‘Add’ to create the client app.

  3. You will then obtain the client app ID & secret. Securely store them - they will be used in the subsequent procedure.

Generate Access Token

Send a POST request to:

https://{yoursite}/oauth/token?grant_type=client_credentials

Request

POST /oauth/token?grant_type=client_credentials HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic base64encode(client_id:client_secret) (1)
  1. Basic authentication using client_Id and client_secret.

Response

{
    "access_token": "cef6d715-baa4-4788-bbd1-cd59c8490af6", (1)
    "token_type": "bearer",
    "expires_in": 3599, (2)
    "scope": "trust"
}
  1. Access token that can be used to consume the protected resources.

  2. Remaining lifetime of the access token.

Calling VOS REST API with access token

You can call VOS API by putting the access token in the HTTP header:

Authorization: Bearer $access_token

The API endpoints are in the following format:

https://{yoursite}/vos-api/module/v1/resourcePath?parameter

Here is an example: list all configured services

HTTP METHOD

GET

REQUEST URI

https://{yoursite}/vos-api/configure/v1/services

REQUEST HEADER

Authorization: Bearer 5ee3a233-212e-412b-af99-43f623128799

If the request succeeds, the first line of the response is:

HTTP/1.1 200 OK

and the response body is the list of services in JSON array

Handle access token expiry

When the access token expires, generate a new one with client_id and client_secret following the same procedure described earlier.

Service Management

Service Setup

Setting a service includes
  1. Source - IP input settings

  2. Source - Input grooming settings

  3. Source - Source discovery

  4. Destination - Output settings

  5. Service settings

Source - Input Settings

{
  "id": "24c76109-31fc-7cfa-1d2c-b34a4dd20d8f",
  "inputs": [
    {
      "id": "02db1fd5-ec4f-2cb3-67ed-82225333d5b7", (1)
      "rank": 1, (2)
      "type": "ZIXI", (3)
      "zixiSettings": { (4)
        "zixiInputType": "HARMONIC_UPLINK", (5)
        "grooming" : { ... }, (6)
        "zixiEndPointSetting": { (7)
          "zixiEndpointId": "string"
        },
        "harmonicUplinkSetting": { (8)
          "uplinkGroupId": "02585ec8-b831-4107-b567-75a826945017",
          "ipAddress": "229.1.1.1",
          "ipPort": 9876,
          "ssmIpAddresses": [
            "63.48.44.65"
          ]
        }
      }
    },
    {
      "id": "b16c939a-b715-45ef-9fb4-9d929bc17453", (1)
      "rank": 2, (2)
      "type": "ZIXI", (3)
      "slateSettings": { (9)
        "customSlateSettings": {
          "muteAudio": true
        },
        "imageId": "f4b1a974-d657-9797-a4a2-8db9b197fca8", (10)
        "type": "SIGNAL_LOSS"
      }
    }
  ]
}
  1. Unique identifier of an input. This ID is used for input monitoring.

  2. Input rank. When signal loss occurs in the current input, the input with next rank will be used. The smaller the number, the higher priority.

  3. Input type. ZIXI for ZIXI Transport, or SLATE for static image. Slate always has a lower priority.

  4. Settings for ZIXI input type.

  5. ZIXI Input type, aka the uplink type. HARMONIC_UPLINK for Harmonic Uplink integration see #<8> . ENCODER for third part ZIXI feeder.

  6. Input Grooming settings for advance input settings. Details are included in later sections.

  7. ZIXI endpoint settings. Specify the endpoint resource are allocated in ZixiEndpoint API. A new endpoint will be created and used in the channel if not specified.

  8. Harmonic uplink settings. Only required if Zixi Input type is HARMONIC_UPLINK. Specifying this to remote configure uplink, content source address, port and SSM.

  9. The slate input settings.

  10. The Unique identifier of image used in slate. Details are included in later sections.

Input Grooming

Input Grooming allows user to specify the important metadata of the input source. The metadata may be discovered by media info detection by default. While user can specify the metadata when it is missing in input source, or override if it is incorrect.

Tip
You can discovery source and detect the media info by source discovery API. It can show you the input source media information and use the information to set the values in input grooming.
Note
You can find the list of input grooming properties from API reference.

Source Discovery

Source discovery allows user to discovery the source input. It can detect MPEG streams, extract the media information, such as PID, program name, codec, etc.

A source discovery consists of 3 steps:

Tip
You can always cancel the task by making PUT request on https://{yoursite}/vos-api/source-monitor/v1/discover/{discoveryId}/cancel.

For details, please find the API definitions for Source Discovery.

Service Settings

{
    "id": "0dee27f6-7389-25dc-8c51-7b3868aa96f2", (1)
    "name": "HVN 2", (2)
    "programNum": 1,
    "serviceSources": [ (3)
      {
        "sourceId": "24c76109-31fc-7cfa-1d2c-b34a4dd20d8f",
        "rank": 1
      }
    ],
    "profileId": "6b8a0835-b8a9-a379-00ff-b6dca6443d3a",
    "destinationId": "2c295b5e-bf36-4057-a432-c1c11df85280",
    "controlState": "ACTIVATED" (4)
}
  1. Unique identifier of service.

  2. Service Name. The human-friendly name of service for easier management.

  3. Service source. The settings of channel source.

  4. Service control state. It can ACTIVATED, TEST (Processing but no output) and OFF (No processing and output).

Setup Images for Logo or Slate

Before configuring an image as logo or slate, you have to import these images into VOS. The url for images REST resource is

{
  "id": "4a169c21-b446-4ade-a0d8-f16504b45010", (1)
  "labels": [], (2)
  "url": "https://yourimage.host/images/slate.png", (3)
  "username": "", (4)
  "password": "******" (4)
}
  1. Unique identifier of an image.

  2. Labels for searching.

  3. URL of the image.

  4. Username and password is optional and is used when credential is required for the image server.

Service Monitoring & Control

Change Slate Image

Firstly, please ensure you have imported the images following Setup Images. Then, the change could be done by simply updating image id in channel configuration.

{
  "id": "24c76109-31fc-7cfa-1d2c-b34a4dd20d8f",
  "inputs": [
    ......
    {
      "id": "b16c939a-b715-45ef-9fb4-9d929bc17453",
      "rank": 2,
      "type": "ZIXI",
      "slateSettings": {
        "customSlateSettings": {
          "muteAudio": true
        },
        "imageId": "f4b1a974-d657-9797-a4a2-8db9b197fca8", (1)
        "type": "SIGNAL_LOSS"
      }
    }
  ]
}
  1. The Unique identifier of image used in slate.

Switch Slate State

Slate of a running service switch on or off automatically, based on system events like signal loss. It can be controlled manually through API.

You could query a list running services with name filter. Then, the slate on or off of a running service can be controlled by specifying service id.

Time-shift

There are three major types of time-shift applications:
  • Start-over: A presentation of an on-going live event from a specified start time.

  • Catch-up: A presentation of a past live event in a specified period of time shortly after it has been finished within retention period, saying 7 days.

  • Long-lasting Catch-up (LLCU): A presentation of a past live event in a specified period of time after it has been finished for a longer period of time, exceeding retention period.

Time-shift Playback Info in Channel Delivery Status

{
  "name":"NEWS",
  "id":"bce2939a-b715-45ef-9fb4-9d929bc17453",
  "deliverStatus":{
    "deliverStatistic":[
      {
        "deliverBitrate":6932533,
        "time":"2016-01-25T18:31:34Z"
      },
      ...
    ],
    "averageSessions": 46,
    "playbackInfos": [
      {
        "packageType": "e_HLS",
        "url": "http://fox-i.akamaihd.net/hls/live/248623/28107e25-309c-a557-2f4e-ea2000868a6e/variant.m3u8"
      },
      {
        "packageType": "e_DASH",
        "url": "http://fox-i.akamaihd.net/dash/live/924824/28107e25-309c-a557-2f4e-ea2000868a6e/manifest.mpd"
      },
      {
        "packageType": "e_SS",
        "url": "http://vos443607-s.akamaihd.net/live/240534/28107e25-309c-a557-2f4e-ea2000868a6e.isml/manifest"
      }
    ],
    "startOverPlaybackInfos": [ (1)
      {
        "packageType": "e_HLS",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/HLS/StartOver/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime})/index.m3u8"
      },
      {
        "packageType": "e_DASH",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/DASH/StartOver/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime})/manifest.mpd"
      },
      {
        "packageType": "e_SS",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/SS/StartOver/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime}).isml/Manifest"
      }
    ],
    "catchUpPlaybackInfos": [ (2)
      {
        "packageType": "e_HLS",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/HLS/CatchUp/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime},endTime={endTime})/index.m3u8"
      },
      {
        "packageType": "e_DASH",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/DASH/CatchUp/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime},endTime={endTime})/manifest.mpd"
      },
      {
        "packageType": "e_SS",
        "url": "http://fox-01.nebula.video.edgesuite.net/Content/SS/CatchUp/channel(name=f11e7874-ec4f-408f-b9cd-985ab5f95aa9,startTime={startTime},endTime={endTime}).isml/Manifest"
      }
    ]
  },
  ...
}
  1. Start-over playback info.

  2. Catch-up playback info.

Start-over

The playback URL has two parameters:
  1. serviceId: Service Id of the channel.

  2. startTime: Start time of the start-over, which is an unsigned 64 bit integer representing the number of 100-nanosecond intervals elapsed since the Unix Epoch in UTC.

Important
1. Start Time < Current Time

Catch-up

The playback URL has three parameters:
  1. serviceId: Service Id of the channel.

  2. startTime: Start time of the catch-up, which is an unsigned 64 bit integer representing the number of 100-nanosecond intervals elapsed since the Unix Epoch in UTC.

  3. endTime: End time of the catch-up, which is an unsigned 64 bit integer representing the number of 100-nanosecond intervals elapsed since the Unix Epoch in UTC.

Important
  1. Start Time < Current Time

  2. Start Time < End Time

  3. End Time < Current Time - 2 minutes

  4. End Time > Current Time - Retention

  5. End Time - Start Time < 12 hours

Long-lasting Catch-up (LLCU)

The playback URL has one parameter:
  1. assetId: Asset Id generated upon LLCU asset creation.

HLS LLCU Playback Url Format

http://{delivery-hostname}/Content/HLS/LLCU/{assetId}/index.m3u8

DASH LLCU Playback Url Format

http://{delivery-hostname}/Content/DASH/LLCU/{assetId}/manifest.mpd

SS LLCU Playback Url Format

http://{delivery-hostname}/Content/SS/LLCU/{assetId}.ism/Manifest

Asset Management of LLCU

To playback LLCU, LLCU assets need to be created before. LLCU asset is a copy of media stream of certain period, which is stored in the permanent storage and will not be deleted automatically.

LLCU asset has several states
  • Initial: Initial status means that the asset is created but the start time is not reached yet. Asset is not playable at this state.

  • IngestingAndPlayable: IngestingAndPlayable means the start time is passed and the asset is playable. But the asset is not finished ingesting yet.

  • Ingesting: Ingesting means the start time is passed and the asset is ingesting. Asset is not playable at this state.

  • Ingested: Ingested means that the ingesting process is finished.

  • Error: Error means the ingest process encountered an error.

  • Deleting: Deleting means the LLCU asset is pending to be deleted.

Create LLCU asset

Send a PUT request to:

http://{yoursite}/vos-api/origin-engine/v1/ami/llcu/asset/{assetId}

This URL has one parameter:
  1. assetId: The newly created LLCU asset will be identified by this asset ID.

The message body of the HTTP request should be an XML string with <Content> as its root element.

<Content> element should have 3 children elements:
  1. SourceUri: The service ID of the source channel to be backed up as LLCU asset.

  2. IngestStartTime: The start time of the period to be backed up.

  3. IngestEndTime: The end time of the period to be backed up.

Sample Request

PUT /vos-api/origin-engine/v1/ami/llcu/asset/50604e15-7f6a-487d-ac9e-696c9a91677f HTTP/1.1
Content-Type: application/xml (1)
Authorization: Basic base64encode(client_id:client_secret) (2)

<Content>
  <SourceUri>81c45f03-c5e6-6758-eb13-c30584e1971a</SourceUri> (3)
  <IngestStartTime>2016-05-15T08:30:00Z</IngestStartTime>
  <IngestEndTime>2016-05-15T09:30:00Z</IngestEndTime>
</Content>
  1. Content-Type should be either application/xml or text/xml.

  2. Basic authentication using client_secret.

  3. The Source URI that LLCU asset should be created from.

Sample Response

HTTP/1.1 201 Created (1)
Date: Sun, 15 May 2016 07:00:00 GMT
X-Content-Type-Options: nosniff
X-Xss-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Frame-Options: SAMEORIGIN
Set-Cookie: JSESSIONID=tlb7q43j19znsazrz0ofntmo;Path=/
Content-Length: 0
Server: Jetty(9.3.z-SNAPSHOT)
Note
The status code of sucess is 201.

Retrieve LLCU asset info

Send a GET request to:

http://{yoursite}/vos-api/origin-engine/v1/ami/llcu/asset/{assetId}

This URL has one parameter:
  1. assetId: The asset ID of the LLCU asset to be retrieved.

This request also receives one optional HTTP header parameter:
  1. X-REST-OS_AMI-Version: The AMI version to use. Default is 1.0

Sample Request

GET /vos-api/origin-engine/v1/ami/llcu/asset/50604e15-7f6a-487d-ac9e-696c9a91677f HTTP/1.1
X-REST-OS_AMI-Version: 1.0 (1)
Authorization: Basic base64encode(client_id:client_secret) (2)
Accept: application/xml (3)
  1. X-REST-OS_AMI-Version parameter.

  2. Basic authentication using client_secret.

  3. Accept the xml response.

Sample Response

HTTP/1.1 200 OK
Date: Sun, 15 May 2016 07:00:00 GMT
X-Content-Type-Options: nosniff
X-Xss-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Frame-Options: SAMEORIGIN
Set-Cookie: JSESSIONID=19dmeebslp2m81uuofxtohjxxv;Path=/
Content-Type: application/xml
Content-Length: 566
Server: Jetty(9.3.z-SNAPSHOT)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Content xmlns="urn:eventis:cpi:1.0" id="50604e15-7f6a-487d-ac9e-696c9a91677f">
    <SourceUri>81c45f03-c5e6-6758-eb13-c30584e1971a</SourceUri>
    <IngestStartTime>2016-05-15T08:30:00Z</IngestStartTime>
    <IngestEndTime>2016-05-15T09:30:00Z</IngestEndTime>
    <resourceId></resourceId>
    <ProfileName>hls_LLCU</ProfileName>
    <Status id="Initial">
        <IngestPercentage>0</IngestPercentage>
    </Status>
</Content>

Delete LLCU asset

Send a DELETE request to:

http://{yoursite}/vos-api/origin-engine/v1/ami/llcu/asset/{assetId}

This URL has one parameters:
  1. assetId: The asset ID of the LLCU asset to be retrieved.

Sample Request

DELETE /vos-api/origin-engine/v1/ami/llcu/asset/50604e15-7f6a-487d-ac9e-696c9a91677f HTTP/1.1
Authorization: Basic base64encode(client_id:client_secret) (1)
  1. Basic authentication using client_secret.

Sample Response

HTTP/1.1 200 OK
Date: Sun, 15 May 2016 07:00:00 GMT
X-Content-Type-Options: nosniff
X-Xss-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Frame-Options: SAMEORIGIN
Set-Cookie: JSESSIONID=13gk29b26d7xpa1n6rzhl3xwv;Path=/
Content-Length: 0
Server: Jetty(9.3.z-SNAPSHOT)

List all LLCU assets

Send a GET request to:

http://{yoursite}/vos-api/origin-engine/v1/ami/llcu/llcuassetlist

This request also receives two optional parameters in the query string of URL:
  1. opState: This parameter specifies the status of the LLCU asset to be listed. Value of this parameter could be one of the followings (without quote mark):

    • "Initial"

    • "InitialAndPlayable"

    • "Initial,initialAndPlayable"

    • "Initial,initialAndPlayable,error"

    • "Ingesting"

    • "IngestingAndPlayable"

    • "Ingested"

    • "Error"

    • "Pending Delete" or "Pending%20Delete" or "Deleting"

  2. queryId: If the list is too long, the list might be split into a series of responses. In such cases, there will be a "queryId" attribute in the root tag identifies the list asset query. Pass the query id in the next request to get the next part of the asset list.

Note
Query ID feature is supported by AMI 2.0 only
This request also receives one optional HTTP header parameter:
  1. X-REST-OS_AMI-Version: The AMI version to use. Default is 1.0

Sample Request

GET /vos-api/origin-engine/v1/ami/llcu/llcuassetlist HTTP/1.1
X-REST-OS_AMI-Version: 1.0 (1)
Authorization: Basic base64encode(client_id:client_secret) (2)
Accept: application/xml (3)
  1. X-REST-OS_AMI-Version parameter.

  2. Basic authentication using client_secret.

  3. Accept the xml response.

Sample Response

HTTP/1.1 200 OK
Date: Sun, 15 May 2016 07:00:00 GMT
X-Content-Type-Options: nosniff
X-Xss-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
X-Frame-Options: SAMEORIGIN
Set-Cookie: JSESSIONID=isxshwtlra956td83ruigmpn;Path=/
Content-Type: application/xml
Content-Length: 431
Server: Jetty(9.3.z-SNAPSHOT)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Contents xmlns="urn:eventis:cpi:1.0">
    <Content id="50604e15-7f6a-487d-ac9e-696c9a91677f" statusId="Initial"/>
    <Content id="7a3fef93-44cb-4532-5df7-0101ce485336" statusId="IngestingAndPlayable"/>
    <Content id="e3c367c7-402b-4710-8ca9-c5b6dee6e138" statusId="Ingested"/>
</Contents>

Asset Acquisition for VOD

Assets

Asset Example

{
  "id": "63a6a02e-e405-4c30-881b-5e9eb33b60c3", (1)
  "filePath": "/opt/harmonic/vos/objectivefs/assets/upload/3_NTSC_tv.ts", (2)
  "title": "3_NTSC_tv.ts",
  "fileSize": 25314952, (3)
  ...
  "outputs": [ (4)
    {
      "id": "d8e2a9cf-d751-4598-b80c-e06de6974ee2",
      "profileId": "dea14b07-be66-1f46-4fe8-75a89b222005", (5)
      "outputFilesPaths": [ (6)
        "/opt/harmonic/vos/objectivefs/assets/vod/3_NTSC_tv/0.ts",
        ...
        "/opt/harmonic/vos/objectivefs/assets/vod/3_NTSC_tv/5.ts"
      ],
      "playbackUrls": {
        "DASH": "https://cluster/Content/DASH/VOD/3_NTSC_tv/manifest.mpd",
        "HLS": "https://cluster/Content/HLS/VOD/3_NTSC_tv/index.m3u8",
        "SS": "https://cluster/Content/SS/VOD/3_NTSC_tv.ism/Manifest"
      },
      ...
      "percentage": 100, (7)
      "status": "FINISHED" (8)
    }
  ]
}
  1. Unique identifier of an asset. Used for applying decisions and monitoring.

  2. Path in VOS RT, where original asset file was uploaded to.

  3. Size of original asset file in bytes.

  4. List of output files that have been transcoded from original asset file, grouped per profile.

  5. Identifier of transcoding profile that relates to this set of output files.

  6. File paths of transcoded output files in VOS RT related to given profile.

  7. Percentage of transcoding completion.

  8. Task completion status.

Decision Example

{
  "assetIds": [ (1)
    "edf38d8c-4bd5-4e25-8681-de84050fd33b",
    "63a6a02e-e405-4c30-881b-5e9eb33b60c3"
  ],
  "priority": "RUSH", (2)
  "transcodingProfiles": [ (3)
    "dea14b07-be66-1f46-4fe8-75a89b222005"
  ]
}
  1. Identifiers of assets to be transcoded. Separate job is created for each asset.

  2. Transcoding priority. From highest to lowest: RUSH, NORMAL, BACKLOG.

  3. Identifiers of transcoding profiles. Separate task is created for each profile if it does not duplicate existing task.

Configuring Assets

User will probably start by uploading one or several files as assets.

Then user should specify transcoding profiles for your assets by posting decisions.

Tip
You can monitor state of transcoding process through REST endpoint.

Jobs

Job Example

{
  "id": "adae4e1e-c72d-49c1-8a7b-a4da8448a99e", (1)
  "sourceAsset": { (2)
    "title": "3_NTSC_tv.ts",
    "fileName": "3_NTSC_tv.ts",
    "fileSize": 25314952,
    ...
  },
  "tasks": [ (3)
    {
      "id": "d8e2a9cf-d751-4598-b80c-e06de6974ee2", (4)
      "profileId": "dea14b07-be66-1f46-4fe8-75a89b222005", (5)
      "percentage": 100, (6)
      "estimationInSec": 0,
      "status": "FINISHED" (7)
    }
  ],
  ...
  "jobStatus": "FINISHED" (8)
}
  1. Unique identifier of transcoding job.

  2. Asset file to be used as transcoding source.

  3. List of tasks related to this job.

  4. Unique identifier ot transcoding task.

  5. Identifier of transcoding frofile related to task.

  6. Percentage of transcoding completion. Is 0 for queued tasks, 100 for finished ones.

  7. Completion status for task. Initially is QUEUED, turns to PROCESSING when transcoding starts, and finally to FINISHED when transcoding completed. FAILED on transcoding error, CANCELING and CANCELED when transcoding aborted by user.

  8. Completion status for job. Initially is QUEUED, turns to PROCESSING when transcoding starts, and finally to FINISHED when all tasks are completed (successfully or not).

Monitoring Jobs

User can monitor transcoding job and task status by separate REST API, focused on jobs, not on assets.

Note
When asset is deleted, information on all related transcoding jobs is also deleted.

Origin Server Management

Status

Get status and health metrics of origin engine in the last 5-second sample period.

{
  "numInstances": 3, (1)
  "requestsPerSecond": 79.6, (2)
  "maxResponseTimeInMs": 636, (3)
  "throughputKiloBitsPerSecond": 26625.9376 (4)
}
  1. Number of origin server instances currently running. This may change as request volume increase.

  2. Average number of request in a second. This includes egress and health-check requests from load balancer.

  3. Maximum response time recorded on the origin server during the sample period.

  4. The average egress throughtput in a second.

System Management

Logs

Log API allows user to download logs from VOS, with query and filtering support.

Note
You can find the more details from LOG API definitions.
Tip
Always provide filter options on query to shorten the response time.

Notifications

VOS provides API on query the active notifications and its history. Upon a situation that requires user attention, VOS will assert a notification. As soon as the situation ends, the notification will remit. When a notification is asserted, user can snooze it by schedule a time to fix it.

List notifications

{
  "id": "20160127-0930484490-00005-98713", (1)
  "typeId": "Harmonic_RmpController_SourceSignalLostIndication", (2)
  "appKey": "com.harmonicinc.vos.sspe", (3)
  "objectType": "Source", (4)
  "severity": "WARNING", (5)
  "title": "Source signal loss", (6)
  "objectId": "c26c739a-9d8c-11e5-8994-feff819cdc9f", (7)
  "objectName": "Service Harmonic NASA", (8)
  "sourceComponent": "d36c739a-9d8c-11e5-8994-feff819cdc9f", (9)
  "state": "RESOLVED", (10)
  "creationTime": "2016-01-27T09:30:48Z", (11)
  "resolvedTime": "2016-01-27T09:31:29Z", (12)
  "acknowledgedBy": null, (13)
  "scheduleFixTime": null, (14)
  "scheduleFixInstruction": null, (15)
  "lastUpdateSequence": 20267 (16)
}
  1. The unique identifier of notification

  2. The notification type shows the notification type of this notification

  3. The Key of application this notification assert from

  4. The type of object the notification asserted on.

  5. Notification severity telling the importance of this notification

  6. Notification title for display

  7. The object ID the notification asserted on

  8. The name of object the notification asserted on

  9. The source of notification.

  10. The current state of notification

  11. Notifcation creation time

  12. Notification resolved time, only shows when it is resolved

  13. The user who mark the notification acknowledge. Only used when it has been scheduled fix.

  14. The time of schedule fix. Only used when it has been scheduled fix.

  15. The note of schedule fix. Only used when it has been scheduled fix.

  16. The update sequence.

Schedule fix notifications

You can schedule fix a notification by POST a request on the schedule fix API. After it is set, the notification will snooze until the schedule fix time.

{
  "acknowledgedBy": "d36c739a-9d8c-11e5-8994-feff819cdc9f", (1)
  "scheduleFixInstruction": "This will be fix on the next maintenance period.", (2)
  "scheduleFixTime": "2016-01-27T10:33:30.648Z" (3)
}
  1. The user id of the acknowledged by.

  2. The note of schedule fix.

  3. The time of schedule fix

Paths

Update existing asset. Considered to be used only by engineers with advanced knowledge of AA

PUT /asset-acquisition/v1/asset

Parameters

Type Name Description Required Schema Default

BodyParameter

asset

asset

true

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get status of external assets

GET /asset-acquisition/v1/asset/external

Parameters

Type Name Description Required Schema Default

QueryParameter

id

ID of asset to get status for

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestExternalAssetStatus array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Create external assets in DASH

POST /asset-acquisition/v1/asset/external/dash

Parameters

Type Name Description Required Schema Default

QueryParameter

asset_url

URL of external asset

true

string

QueryParameter

asset_title

Asset title

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Create external assets in HLS

POST /asset-acquisition/v1/asset/external/hls

Parameters

Type Name Description Required Schema Default

QueryParameter

asset_url

URL of external asset

true

string

QueryParameter

asset_title

Asset title

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Download asset from file server to local storage

POST /asset-acquisition/v1/asset/fileserver

Parameters

Type Name Description Required Schema Default

BodyParameter

fileServerAsset

fileServerAsset

true

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAsset

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

202

Accepted. The request has been accepted for processing, but the processing has not been started

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Create asset from LLCU

POST /asset-acquisition/v1/asset/llcu

Parameters

Type Name Description Required Schema Default

BodyParameter

restAsset

restAsset

true

com.harmonicinc.vos.asset.acquisition.rest.model.LlcuAssetBase

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition Recordings

Create record from channel

POST /asset-acquisition/v1/asset/record

Parameters

Type Name Description Required Schema Default

BodyParameter

request

request

true

com.harmonicinc.vos.asset.acquisition.rest.model.RecordCreationRequest

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition Recordings

Create asset from S3 storage

POST /asset-acquisition/v1/asset/s3

Parameters

Type Name Description Required Schema Default

QueryParameter

file_path

file_path

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Update segments by asset id

PUT /asset-acquisition/v1/asset/segments

Parameters

Type Name Description Required Schema Default

BodyParameter

restSegmentation

restSegmentation

true

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentation

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Delete source file asset

DELETE /asset-acquisition/v1/asset/source-file/{assetId}

Parameters

Type Name Description Required Schema Default

PathParameter

assetId

assetId

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get status of input assets

GET /asset-acquisition/v1/asset/url

Parameters

Type Name Description Required Schema Default

QueryParameter

id

ID of asset to get status for

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestSourceDownloadStatus array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Download asset to local storage

POST /asset-acquisition/v1/asset/url

Parameters

Type Name Description Required Schema Default

QueryParameter

asset_urls

URL of external asset. (File servers with self-signed certificate are accepted)

true

multi string array

QueryParameter

url_paths_encoded

Are special symbols (spaces, %, +, etc.) replaced with corresponding percent codes in path part of URL.

false

boolean

true

QueryParameter

asset_id

Asset id

false

string

QueryParameter

asset_title

Asset title

false

string

QueryParameter

labels

Labels

false

multi string array

QueryParameter

username

username while authentication

false

string

QueryParameter

password

password while authentication

false

string

QueryParameter

skip_ssl_certificate_validation

All SSL certificates are accepted under the client responsibility. Pass true to accept all.

false

boolean

false

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

202

Accepted

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get segments by asset id

GET /asset-acquisition/v1/asset/{assetId}/segments

Parameters

Type Name Description Required Schema Default

PathParameter

assetId

ID of asset whose segments to get

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentation

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get Asset by id

GET /asset-acquisition/v1/asset/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset to get

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Delete asset

DELETE /asset-acquisition/v1/asset/{id}

Description

Delete asset, output files and information on transcoding jobs.

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset to delete

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Action on asset

POST /asset-acquisition/v1/asset/{id}/action

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset

true

string

BodyParameter

params

params

true

com.harmonicinc.vos.asset.acquisition.rest.model.ActionParameters

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.ActionResponse

201

Created

No Content

202

Accepted. The request has been accepted for processing, but the processing has not been started

com.harmonicinc.vos.asset.acquisition.rest.model.ActionResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get Asset cue point info

GET /asset-acquisition/v1/asset/{id}/cue-point-info

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestCuePointsInfo array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Update asset cue point info

PUT /asset-acquisition/v1/asset/{id}/cue-point-info

Description

Update asset cue point info.

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset

true

string

BodyParameter

cuePointsInfo

cuePointsInfo

true

com.harmonicinc.vos.asset.acquisition.rest.model.RestCuePointsInfo array

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Returns asset destination profile details

GET /asset-acquisition/v1/asset/{id}/destination-profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an asset

true

string

Responses

HTTP Code Description Schema

200

Asset destination profile id returned

com.harmonicinc.vos.asset.acquisition.rest.model.AssetDestinationProfileDetails

401

Requester not authorized for this operation

No Content

403

Forbidden

No Content

404

Asset with given id not found

No Content

500

Internal server error occurred

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Updates asset destination profile id

PUT /asset-acquisition/v1/asset/{id}/destination-profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an asset

true

string

BodyParameter

updateRequest

updateRequest

true

com.harmonicinc.vos.asset.acquisition.rest.model.DestinationProfileUpdateRequest

Responses

HTTP Code Description Schema

200

Request successfully processed

No Content

201

Created

No Content

400

Provided destination profile is invalid

No Content

401

Requester not authorized for this operation

No Content

403

Forbidden

No Content

404

Asset with given id not found

No Content

500

Internal server error occurred

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get asset encryption settings

GET /asset-acquisition/v1/asset/{id}/drm

Description

Get asset encryption settings

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an asset

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.DrmProperties

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Set asset encryption settings

PUT /asset-acquisition/v1/asset/{id}/drm

Description

Set asset encryption settings

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an asset

true

string

BodyParameter

drmProperties

drmProperties

true

com.harmonicinc.vos.asset.acquisition.model.DrmProperties

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get asset metadata

GET /asset-acquisition/v1/asset/{id}/metadata

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.AssetMetadata

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Upload asset subtitle

POST /asset-acquisition/v1/asset/{id}/subtitle

Description

Upload subtitle for asset

Parameters

Type Name Description Required Schema Default

FormDataParameter

subtitle_file

File to be uploaded as asset subtitle

true

file

PathParameter

id

Unique identifier of an asset

true

string

QueryParameter

pac_code_page

Code page (only PAC subtitles)

false

enum (LATIN, TURKISH, JAPANESE, KOREAN, CHS, CHT, CYRILLIC, THAI, HEBREW, ARABIC, CZECH, GREEK)

QueryParameter

pac_offset

Offset (only PAC and VTT subtitles)

false

string

QueryParameter

subtitle_language

Language of subtitle

true

string

QueryParameter

subtitle_type

Type of subtitle

false

enum (NORMAL, HARD_OF_HEARING, FORCED)

NORMAL

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Asset Acquisition

Get asset thumbnail

GET /asset-acquisition/v1/asset/{id}/thumbnail

Description

Get the thumbnail of asset by specifying an asset ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an asset

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get all assets

GET /asset-acquisition/v1/assets

Description

List all existing assets and their output files. Use the limit parameter if there are more than 300 assets were ingested to system

Parameters

Type Name Description Required Schema Default

QueryParameter

title

Query assets by titles, separated by space

false

string

QueryParameter

labels

Query assets by labels, separated by space

false

string

QueryParameter

uriRegex

Query assets by uri regex (works with creationDate, skip and limit only)

false

string

QueryParameter

creationDate

Query assets by creation date (UNIX epoch timestamp in milliseconds)

false

integer (int64)

QueryParameter

skip

Skip this many first results

false

integer (int32)

QueryParameter

limit

Show at most this many results

false

integer (int32)

50

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get assets Library

GET /asset-acquisition/v1/assets/library

Description

List all existing assets in Library. Use the limit parameter if there are more than 300 assets in Library

Parameters

Type Name Description Required Schema Default

QueryParameter

title

Query assets by titles, separated by space

false

string

QueryParameter

labels

Query assets by labels, separated by space

false

string

QueryParameter

skip

Skip this many first results

false

integer (int32)

QueryParameter

limit

Show at most this many results

false

integer (int32)

50

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get assets pending decision

GET /asset-acquisition/v1/assets/need_decision

Parameters

Type Name Description Required Schema Default

QueryParameter

trimmed

Trim asset info of non-essential info to make response shorter

false

boolean

false

QueryParameter

title

Query assets by titles, separated by space

false

string

QueryParameter

skip

Skip this many first results

false

integer (int32)

0

QueryParameter

limit

Show at most this many results

false

integer (int32)

0

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Submit decision

POST /asset-acquisition/v1/decision

Description

Submit transcoding decision to be applied for assets. Job will be created for every listed asset, each job will have a task for each listed transcoding profile.

Parameters

Type Name Description Required Schema Default

BodyParameter

decision

Decision to be applied

true

com.harmonicinc.vos.asset.acquisition.rest.model.Decision

Responses

HTTP Code Description Schema

200

OK

string array

201

Created

No Content

202

Accepted. The request has been accepted for processing, but the processing has not been started

string array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Export packaged asset

POST /asset-acquisition/v1/export

Parameters

Type Name Description Required Schema Default

BodyParameter

fileServerAssetExport

fileServerAssetExport

true

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAssetExport

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Get status of asset exporting

GET /asset-acquisition/v1/export/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of asset

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.fileserver.ExportLog

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Chunk upload of file

POST /asset-acquisition/v1/file/upload

Description

Create an asset or graphic by uploading a file

Parameters

Type Name Description Required Schema Default

FormDataParameter

asset_file

File chunk to be uploaded

true

file

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Asset Acquisition

Update existing file server

PUT /asset-acquisition/v1/fileserver

Parameters

Type Name Description Required Schema Default

BodyParameter

restFileServerSetup

restFileServerSetup

true

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Register a new file server

POST /asset-acquisition/v1/fileserver

Parameters

Type Name Description Required Schema Default

BodyParameter

restFileServerSetup

restFileServerSetup

true

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Get status of input asset

GET /asset-acquisition/v1/fileserver/asset/status

Parameters

Type Name Description Required Schema Default

QueryParameter

id

ID of asset to get status for

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAssetDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Get file server by id

GET /asset-acquisition/v1/fileserver/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Delete file server

DELETE /asset-acquisition/v1/fileserver/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Get all file servers

GET /asset-acquisition/v1/fileservers

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Update graphic

PUT /asset-acquisition/v1/graphic

Description

Update existing graphic

Parameters

Type Name Description Required Schema Default

BodyParameter

graphic

graphic

true

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get graphic by id

GET /asset-acquisition/v1/graphic/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Delete graphic

DELETE /asset-acquisition/v1/graphic/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get all graphics

GET /asset-acquisition/v1/graphics

Description

List all existing graphics.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Create graphics from file server storage

POST /asset-acquisition/v1/graphics/fileserver

Parameters

Type Name Description Required Schema Default

BodyParameter

fileServerGraphic

Graphics to create from file server

true

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerGraphic

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

getLibraryGraphics

GET /asset-acquisition/v1/graphics/library

Parameters

Type Name Description Required Schema Default

QueryParameter

title

Query graphics by titles, separated by space

false

string

QueryParameter

labels

Query graphics by labels, separated by space

false

string

QueryParameter

uriRegex

Query graphics by uri regex (works with creationDate, skip and limit only)

false

string

QueryParameter

creationDate

Query graphics by creation date (UNIX epoch timestamp in milliseconds)

false

integer (int64)

QueryParameter

skip

Skip this many first results

false

integer (int32)

QueryParameter

limit

Show at most this many results

false

integer (int32)

50

QueryParameter

graphicType

Type of graphic

false

enum (GRAPHIC, LOGO, AUDIO, HTML_GRAPHIC)

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Create graphics from S3 storage

POST /asset-acquisition/v1/graphics/s3

Parameters

Type Name Description Required Schema Default

QueryParameter

file_path

file_path

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

GraphQL API endpoint

POST /asset-acquisition/v1/graphql

Parameters

Type Name Description Required Schema Default

BodyParameter

body

body

true

object

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Asset Acquisition GraphQL API

Create grooming profile

POST /asset-acquisition/v1/grooming-profile

Description

Create or update grooming profile

Parameters

Type Name Description Required Schema Default

BodyParameter

profile

profile

true

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get grooming profile

GET /asset-acquisition/v1/grooming-profile/{id}

Description

Get grooming profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

Profile id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Update grooming profile

PUT /asset-acquisition/v1/grooming-profile/{id}

Description

Update grooming profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

Profile id to update

true

string

BodyParameter

profile

profile

true

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Delete grooming profile

DELETE /asset-acquisition/v1/grooming-profile/{id}

Description

Delete grooming profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

Profile id to delete

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get list of grooming profiles

GET /asset-acquisition/v1/grooming-profiles

Description

Get the list of available grooming profiles

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get job

GET /asset-acquisition/v1/job/{id}

Description

Get job

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of job to find

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Job

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Cancel job

POST /asset-acquisition/v1/job/{id}/cancel

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of job to cancel

true

string

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get all jobs

GET /asset-acquisition/v1/jobs

Description

Get information on transcoding jobs: scheduled, ongoing and finished. Use the limit parameter if there are more than 300 jobs were processed

Parameters

Type Name Description Required Schema Default

QueryParameter

sourceFileName

Filter by source file name

false

string

QueryParameter

assetId

Filter by assetId (vodTitleId)

false

string

QueryParameter

status

Filter jobs by transcoding status list (QUEUED, PROCESSING, FINISHED)

false

multi string array

QueryParameter

taskStatus

Filter jobs by task status list (QUEUED, SUBMITTED, PROCESSING, FINISHED, FAILED, CANCELED, REJECTED)

false

multi string array

QueryParameter

fileTranscoder

Filter jobs by file transcoder (INTERNAL, HARMONIC_CLOUD)

false

enum (INTERNAL, HARMONIC_CLOUD)

QueryParameter

jobTypes

Filter jobs by job type (TRANSCODING, VQ, PACKAGING, REINDEXING)

false

multi string array

QueryParameter

submittedDate

Filter jobs by submitting date (UNIX epoch timestamp in milliseconds)

false

integer (int64)

QueryParameter

startedDate

Filter jobs by starting date (UNIX epoch timestamp in milliseconds)

false

integer (int64)

QueryParameter

completedDate

Filter jobs by completing date (UNIX epoch timestamp in milliseconds)

false

integer (int64)

QueryParameter

skip

Skip this many first results

false

integer (int32)

QueryParameter

limit

Show at most this many results

false

integer (int32)

50

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Job array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get jobs statistics

GET /asset-acquisition/v1/jobs/statistics

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.model.JobStatistics

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Save new logo template

POST /asset-acquisition/v1/logo-template

Parameters

Type Name Description Required Schema Default

BodyParameter

restLogo

restLogo

true

com.harmonicinc.vos.asset.acquisition.rest.model.Logo

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Logo

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get logo template by ID

GET /asset-acquisition/v1/logo-template/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Logo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Delete logo template

DELETE /asset-acquisition/v1/logo-template/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get all logo templates

GET /asset-acquisition/v1/logo-templates

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Logo array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Get active service info

GET /asset-acquisition/v1/servicesInfo

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.ConfigureServiceInfo array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition Recordings

Get active service info

GET /asset-acquisition/v1/servicesInfo/{id}

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID of service

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.ConfigureServiceInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition Recordings

Get settings

GET /asset-acquisition/v1/settings

Description

Get general application settings: default decision to be applied for assets, created from S3-originated files.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.GeneralSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Set settings

PUT /asset-acquisition/v1/settings

Description

Set general application settings.

Parameters

Type Name Description Required Schema Default

BodyParameter

generalSettings

Default decision

true

com.harmonicinc.vos.asset.acquisition.rest.model.GeneralSettings

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition General

Attach subtitle from file server to an existing asset

POST /asset-acquisition/v1/subtitle/fileserver

Description

Upload subtitle from file server

Parameters

Type Name Description Required Schema Default

BodyParameter

fileServerSubtitle

fileServerSubtitle

true

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerSubtitle

QueryParameter

assetId

assetId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition File Servers

Attach subtitle from S3 storage to an existing asset

POST /asset-acquisition/v1/subtitle/s3

Parameters

Type Name Description Required Schema Default

BodyParameter

subtitles

subtitles

true

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitle array

QueryParameter

assetId

assetId

true

string

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Delete subtitle

DELETE /asset-acquisition/v1/subtitle/{id}

Description

Delete subtitle

Parameters

Type Name Description Required Schema Default

PathParameter

id

Id of subtitle to delete

true

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Asset Acquisition

Get all manifest filtering profiles

GET /atm/v1/manifest-filtering/profiles

Description

Get all manifest filtering profiles

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.datatypes.Profiles

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ATM

Set manifest filtering profile

POST /atm/v1/manifest-filtering/profiles

Description

set manifest filtering profile

Parameters

Type Name Description Required Schema Default

BodyParameter

profile

profile

true

com.harmonicinc.vos.app.atm.datatypes.Profile

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ATM

Get manifest filtering profile

GET /atm/v1/manifest-filtering/profiles/{id}

Description

Get manifest filtering profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.datatypes.Profile

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ATM

Update manifest filtering profile

PUT /atm/v1/manifest-filtering/profiles/{id}

Description

Update manifest filtering profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

profile

profile

true

com.harmonicinc.vos.app.atm.datatypes.Profile

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.datatypes.Profile

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ATM

Delete manifest filtering profile

DELETE /atm/v1/manifest-filtering/profiles/{id}

Description

Delete manifest filtering profile

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ATM

Get ATM Setting.

GET /atm/v1/settings

Description

Get ATM Setting.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.AtmSettingConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ATM Setting

Set ATM Setting.

PUT /atm/v1/settings

Description

Set ATM Setting.

Parameters

Type Name Description Required Schema Default

BodyParameter

atmSettingConfig

atmSettingConfig

true

com.harmonicinc.vos.app.atm.rest.model.AtmSettingConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.AtmSettingConfig

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ATM Setting

Get all variant channels filters.

GET /atm/v1/variant-channels-filter

Description

Get all variant channels filters.

Parameters

Type Name Description Required Schema Default

QueryParameter

start_at

Skip vcfilter profile name alphabetically smaller than this

false

string

QueryParameter

limit

Show at most this many results

false

integer (int32)

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Create a variant channels filter

POST /atm/v1/variant-channels-filter

Description

Create a variant channels filter. The number of filters is limited to 20000. Error code 500 will be returned if you try to add more.

Parameters

Type Name Description Required Schema Default

BodyParameter

vcfilter

vcfilter

true

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

201

Created

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Get the status of the database that stores variant channels filters.

GET /atm/v1/variant-channels-filter-status

Description

Get the status of the database that stores variant channels filters.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilterStatus

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Get a variant channels filter.

GET /atm/v1/variant-channels-filter/{profile-name}

Description

Get a variant channels filter.

Parameters

Type Name Description Required Schema Default

PathParameter

profile-name

The name of variant channels filter.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Create or update a variant channels filter.

PUT /atm/v1/variant-channels-filter/{profile-name}

Description

Create or update a variant channels filter. The number of filters is limited to 20000. Error code 500 will be returned if you try to add more.

Parameters

Type Name Description Required Schema Default

PathParameter

profile-name

The name of variant channels filter

true

string

BodyParameter

vcfilter

vcfilter

true

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

201

Created

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Delete a variant channels filter.

DELETE /atm/v1/variant-channels-filter/{profile-name}

Description

Delete a variant channels filter.

Parameters

Type Name Description Required Schema Default

PathParameter

profile-name

The name of the variant channels filter

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels Filter

Get all content generation channels.

GET /atm/v1/vcm/content-generation-channels

Description

Get all content generation channels.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create a content generation channel

POST /atm/v1/vcm/content-generation-channels

Description

Create a content generation channel.

Parameters

Type Name Description Required Schema Default

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get a content generation channel.

GET /atm/v1/vcm/content-generation-channels/{channel-name}

Description

Get a content generation channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the content generation channel.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create or update a content generation channel

PUT /atm/v1/vcm/content-generation-channels/{channel-name}

Description

Create or update a content generation channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of content generation channel

true

string

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Delete a content generation channel.

DELETE /atm/v1/vcm/content-generation-channels/{channel-name}

Description

Delete a content generation channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the content Generation channel

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get all content replacement channels.

GET /atm/v1/vcm/content-replacement-channels

Description

Get all content replacement channels.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create a content replacement channel

POST /atm/v1/vcm/content-replacement-channels

Description

Create a content replacement channel.

Parameters

Type Name Description Required Schema Default

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get a content replacement channel.

GET /atm/v1/vcm/content-replacement-channels/{channel-name}

Description

Get a content replacement channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the content replacement channel.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create or update a content replacement channel

PUT /atm/v1/vcm/content-replacement-channels/{channel-name}

Description

Create or update a content replacement channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of content replacement channel

true

string

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Delete a content replacement channel.

DELETE /atm/v1/vcm/content-replacement-channels/{channel-name}

Description

Delete a content replacement channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the content replacement channel

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get all live event clipping channels.

GET /atm/v1/vcm/live-event-clipping-channels

Description

Get all live event clipping channels.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create a live event clipping channel

POST /atm/v1/vcm/live-event-clipping-channels

Description

Create a live event clipping channel.

Parameters

Type Name Description Required Schema Default

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get a live event clipping channel.

GET /atm/v1/vcm/live-event-clipping-channels/{channel-name}

Description

Get a live event clipping channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the live event clipping channel.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create or update a live event clipping channel

PUT /atm/v1/vcm/live-event-clipping-channels/{channel-name}

Description

Create or update a live event clipping channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of live event clipping channel

true

string

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Delete a live event clipping channel.

DELETE /atm/v1/vcm/live-event-clipping-channels/{channel-name}

Description

Delete a live event clipping channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the live event clipping channel

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get all regional ads channels.

GET /atm/v1/vcm/regional-ads-channels

Description

Get all regional ads channels.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create a regional ads channel

POST /atm/v1/vcm/regional-ads-channels

Description

Create a regional ads channel.

Parameters

Type Name Description Required Schema Default

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get a regional ads channel.

GET /atm/v1/vcm/regional-ads-channels/{channel-name}

Description

Get a regional ads channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the regional ads channel.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create or update a regional ads channel

PUT /atm/v1/vcm/regional-ads-channels/{channel-name}

Description

Create or update a regional ads channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of content generation channel

true

string

BodyParameter

channel

channel

true

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Delete a regional ads channel.

DELETE /atm/v1/vcm/regional-ads-channels/{channel-name}

Description

Delete a regional ads channel.

Parameters

Type Name Description Required Schema Default

PathParameter

channel-name

The name of the content Generation channel

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get all sourceID mappings.

GET /atm/v1/vcm/variant-channels-sourceid-mapping

Description

Get all sourceID mappings.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelSourceIDMapping array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Create or update a sourceID mapping.

PUT /atm/v1/vcm/variant-channels-sourceid-mapping

Description

Create or update a sourceID mapping.

Parameters

Type Name Description Required Schema Default

BodyParameter

mapping

mapping

true

com.harmonicinc.vos.app.atm.rest.model.VariantChannelSourceIDMapping

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelSourceIDMapping

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Get a sourceID mapping.

GET /atm/v1/vcm/variant-channels-sourceid-mapping/{sourceid}

Description

Get a sourceID mapping.

Parameters

Type Name Description Required Schema Default

PathParameter

sourceid

The ID of the sourceID mapping.

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.atm.rest.model.VariantChannelSourceIDMapping

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Delete a sourceID mapping.

DELETE /atm/v1/vcm/variant-channels-sourceid-mapping/{sourceid}

Description

Delete a sourceID mapping.

Parameters

Type Name Description Required Schema Default

PathParameter

sourceid

The ID of the sourceID mapping.

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • VCM Variant Channels

Download local backup

GET /backup-restore/v1/backup/download/{backupId}

Description

Download local backup (XOS only)

Parameters

Type Name Description Required Schema Default

PathParameter

backupId

The backupId

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

400

Bad request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

File Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • BackupRestore

Delete local backup

DELETE /backup-restore/v1/backup/local/{backupId}

Description

Delete local backup (XOS only)

Parameters

Type Name Description Required Schema Default

PathParameter

backupId

The backupId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.backuprestore.DeleteStatus

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • BackupRestore

Start manual backup

POST /backup-restore/v1/backup/start

Description

Start manual backup

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.backuprestore.rest.BackupInfo

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • BackupRestore

Start scheduled backup

POST /backup-restore/v1/backup_schedule/start

Description

Start scheduled backup

Parameters

Type Name Description Required Schema Default

BodyParameter

request

Schedule backup parameter

false

com.harmonicinc.vos.backuprestore.rest.StartScheduledBackupRequest

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.backuprestore.rest.ScheduledBackupStatus

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • BackupRestore

Get AsRun list

GET /bxf-control-adaptor/v1/asrun

Description

Gets list of AsRun files

Responses

HTTP Code Description Schema

200

OK

string array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • BxfControlAdaptor

Download existing AsRun file

GET /bxf-control-adaptor/v1/asrun/{asrun_file}

Description

Download existing AsRun file from AsRun folder

Parameters

Type Name Description Required Schema Default

PathParameter

asrun_file

BXF file name

true

string

Responses

HTTP Code Description Schema

200

AsRun File

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • BxfControlAdaptor

Upload OPC Schedule

POST /bxf-control-adaptor/v1/opc/{playlist_file}

Description

Uploads OPC schedule

Parameters

Type Name Description Required Schema Default

PathParameter

playlist_file

Playlist file name

true

string

QueryParameter

channel_id

Channel id

false

string

FormDataParameter

schedule

OPC schedule

true

file

Responses

HTTP Code Description Schema

200

OPC schedule uploaded

string

201

Created

No Content

400

Bad request or all events are past

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • BxfControlAdaptor

Get client apps

GET /client-apps/v1/apps

Description

Get client apps in the system.

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Register client app

POST /client-apps/v1/apps

Description

Register new client app to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

clientDetailsConfig

clientDetailsConfig

true

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

201

Client app registered

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

400

Client app registration Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Get the configuration of disused client app checking process

GET /client-apps/v1/apps/client-app-checker/config

Description

Get the configuration of disused client app checking process

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.rumba.clientapp.rest.model.ClientAppCheckerConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Update the configuration of disused client app checking process

PUT /client-apps/v1/apps/client-app-checker/config

Description

Update the configuration of disused client app checking process

Parameters

Type Name Description Required Schema Default

BodyParameter

config

config

true

com.harmonicinc.rumba.clientapp.rest.model.ClientAppCheckerConfig

Responses

HTTP Code Description Schema

200

Success

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Get client app

GET /client-apps/v1/apps/{clientId}

Description

Get client app in the system.

Parameters

Type Name Description Required Schema Default

PathParameter

clientId

Unique identifier of a client app

true

string

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

400

client_id can’t be empty

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Client app Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Update client app

PUT /client-apps/v1/apps/{clientId}

Description

Update client app

Parameters

Type Name Description Required Schema Default

PathParameter

clientId

Unique identifier of a client app

true

string

BodyParameter

clientDetailsConfig

clientDetailsConfig

true

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

201

Client app updated

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

400

Client app failed to update

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Remove client app

DELETE /client-apps/v1/apps/{clientId}

Description

Remove client app

Parameters

Type Name Description Required Schema Default

PathParameter

clientId

Unique identifier of a client app

true

string

Responses

HTTP Code Description Schema

200

Success

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Client app Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Reset client app secret

POST /client-apps/v1/apps/{clientId}/update_secret

Description

Reset client app secret.

Parameters

Type Name Description Required Schema Default

PathParameter

clientId

Unique identifier of a client app

true

string

Responses

HTTP Code Description Schema

200

Client app secret updated

string

201

Created

No Content

400

Client app secret resetting failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Client Apps

Get AHDR SL-HDR1 CONFIG file records

GET /configure/v1/AHDR_SL_HDR1_CONFIG

Description

List all AHDR SL-HDR1 CONFIG file records in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of image URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure AHDR SL-HDR1 Metadata

Create AHDR SL-HDR1 CONFIG file records

POST /configure/v1/AHDR_SL_HDR1_CONFIG

Description

Establish new AHDR SL-HDR1 CONFIG file record to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

AHDR_SL_HDR1_CONFIG file configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

AHDR SL-HDR1 CONFIG File Record Created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create AHDR SL-HDR1 CONFIG file record

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Can’t find AHDR SL-HDR1 CONFIG record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure AHDR SL-HDR1 Metadata

Get AHDR SL-HDR1 configuration

GET /configure/v1/AHDR_SL_HDR1_CONFIG/{id}

Description

Get AHDR SL-HDR1 configuration.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

File not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure AHDR SL-HDR1 Metadata

Delete AHDR SL-HDR1 CONFIG file record

DELETE /configure/v1/AHDR_SL_HDR1_CONFIG/{id}

Description

Delete AHDR SL-HDR1 CONFIG file record and AHDR_SL_HDR1_CONFIG file by specifying its ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

AHDR SL-HDR1 CONFIG Deleted

No Content

204

No Content

No Content

400

AHDR SL-HDR1 CONFIG Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

AHDR SL-HDR1 CONFIG Not Found

No Content

500

Can’t find AHDR SL-HDR1 CONFIG record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure AHDR SL-HDR1 Metadata

Get Dolby-Vision file records

GET /configure/v1/DOLBY_VISION_CONFIG

Description

List all Dolby-Vision file records in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of image URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Dolby Vision

Create Dolby-Vision file records

POST /configure/v1/DOLBY_VISION_CONFIG

Description

Establish new Dolby-Vision file record to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Dolby-Vision file configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

Dolby-Vision File Record Created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create Dolby-Vision file record

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Can’t find Dolby-Vision record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Dolby Vision

Get Dolby-Vision file

GET /configure/v1/DOLBY_VISION_CONFIG/{id}

Description

Get Dolby-Vision file.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

File not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Dolby Vision

Delete Dolby-Vision file record

DELETE /configure/v1/DOLBY_VISION_CONFIG/{id}

Description

Delete Dolby-Vision file record by specifying its ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Dolby-Vision file record Deleted

No Content

204

No Content

No Content

400

Dolby-Vision file record Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Dolby-Vision file record Not Found

No Content

500

Can’t find Dolby-Vision file record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Dolby Vision

Get LUT file records

GET /configure/v1/LUT

Description

List all LUT file records in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of image URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure LUT

Create LUT file records

POST /configure/v1/LUT

Description

Establish new LUT file record to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

LUT file configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

LUT File Record Created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create LUT file record

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Can’t find LUT record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure LUT

Delete LUT file record

DELETE /configure/v1/LUT/{id}

Description

Delete LUT file record and LUT file by specifying its ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

LUT Deleted

No Content

204

No Content

No Content

400

LUT Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

LUT Not Found

No Content

500

Can’t find LUT record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure LUT

Get Descrambling Keys

GET /configure/v1/descrambling-keys

Description

Get the list of defined descrambling keys (critical fields are hidden)

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.DescramblingKeys array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Descrambling Keys

Create Descrambling Keys

POST /configure/v1/descrambling-keys

Description

Create a new set of descrambling keys

Parameters

Type Name Description Required Schema Default

BodyParameter

body

body

true

com.harmonicinc.vos.app.configure.model.DescramblingKeys

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.DescramblingKeys

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Bad Request

No Content

409

Conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Descrambling Keys

Update Descrambling Keys

PUT /configure/v1/descrambling-keys/{id}

Description

Update an existing set of descrambling keys

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

body

body

true

com.harmonicinc.vos.app.configure.model.DescramblingKeys

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.DescramblingKeys

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Bad request

No Content

409

Conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Descrambling Keys

Delete Descrambling Keys

DELETE /configure/v1/descrambling-keys/{id}

Description

Delete an existing set of descrambling keys

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

Success

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Descrambling Keys

Get destinations

GET /configure/v1/destinations

Description

List destinations in the system. Destination is configuration resource for a collection of outputs with ranking.

Parameters

Type Name Description Required Schema Default

QueryParameter

name

Filter by name

false

string

QueryParameter

label

Filter by label

false

string

QueryParameter

skip

Skip N records

false

integer (int32)

QueryParameter

top

Top first M records

false

integer (int32)

QueryParameter

inUse

Filter by inUse flag

false

boolean

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.destination.Destination array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Destination

Create destination

POST /configure/v1/destinations

Description

Create new destination to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

destination

destination

true

com.harmonicinc.vos.app.configure.model.destination.Destination

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.destination.Destination

201

Destination Created

com.harmonicinc.vos.app.configure.model.destination.Destination

400

Destination Not Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Destination

Get destination

GET /configure/v1/destinations/{id}

Description

Get destination by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.destination.Destination

401

Unauthorized

No Content

403

Forbidden

No Content

404

Destination not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Destination

Update destination

PUT /configure/v1/destinations/{id}

Description

Update destination by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

destination

destination

true

com.harmonicinc.vos.app.configure.model.destination.Destination

PathParameter

id

Unique identifier of a destination

true

string

Responses

HTTP Code Description Schema

200

Destination Updated

com.harmonicinc.vos.app.configure.model.destination.Destination

201

Created

No Content

400

Destination updated failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Destination not found

No Content

409

Destination configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Destination

Delete destination

DELETE /configure/v1/destinations/{id}

Description

Delete destination by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a destination

true

string

Responses

HTTP Code Description Schema

200

Destination Deleted

No Content

204

No Content

No Content

400

Destination Not Deleted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Destination

Update destination pool ID

PUT /configure/v1/destinations/{id}/poolBinding

Description

Update pool destination by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

poolBinding

newPool

true

com.harmonicinc.vos.app.configure.model.destination.PoolBinding

PathParameter

id

Unique identifier of a destination

true

string

Responses

HTTP Code Description Schema

200

Destination Pool Updated

com.harmonicinc.vos.app.configure.model.destination.PoolBinding

201

Created

No Content

400

Destination updated failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Destination not found

No Content

409

Destination configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Destination

Get font file records

GET /configure/v1/fonts

Description

List all font file records in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of image URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Font

Create font file records

POST /configure/v1/fonts

Description

Establish new font file record to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Font file configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

Font File Record Created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create font file record

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Can’t find default font record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Font

Delete font file record

DELETE /configure/v1/fonts/{id}

Description

Delete font file record and font file by specifying its ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Font Deleted

No Content

204

No Content

No Content

400

Font Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Font Not Found

No Content

412

Font is used by active service(s)

No Content

500

Can’t find default font record

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Font

Get list of service(s) where font is used

GET /configure/v1/fonts/{id}/services

Description

Get the service that used the specified font ID

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of the font

true

string

Responses

HTTP Code Description Schema

200

Font found in service(s)

com.harmonicinc.vos.app.configure.model.service.Service array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

412

Font does not exist.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Font

Create fullService

POST /configure/v1/fullService

Description

Create new fullService to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

fullService

fullService

true

com.harmonicinc.vos.app.configure.model.fullService.FullService

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.fullService.FullService

201

FullService Created

com.harmonicinc.vos.app.configure.model.fullService.FullService

400

FullService Not Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure FullService

Delete fullService

DELETE /configure/v1/fullService

Description

Delete FullService and associated sources and destination following pattern: {serviceId, [List of sourcesIds], [List of destinationsIds]}.

Parameters

Type Name Description Required Schema Default

BodyParameter

fullServiceIds

fullServiceIds

true

com.harmonicinc.vos.app.configure.model.fullService.FullServiceIds

Responses

HTTP Code Description Schema

200

FullService Deleted

No Content

204

No Content

No Content

400

FullService Not Deleted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure FullService

Get fullService

GET /configure/v1/fullService/{id}

Description

Get fullService by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.fullService.FullService

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure FullService

Update fullService

PUT /configure/v1/fullService/{id}

Description

Update fullService by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

fullService

fullService

true

com.harmonicinc.vos.app.configure.model.fullService.FullService

PathParameter

id

Unique identifier of a FullService

true

string

QueryParameter

sourcesToDelete

sourcesToDelete

false

multi string array

QueryParameter

destinationsToDelete

destinationsToDelete

false

multi string array

Responses

HTTP Code Description Schema

200

FullService Updated

com.harmonicinc.vos.app.configure.model.fullService.FullService

201

Created

No Content

400

FullService Not Updated

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

FullService Not Updated

No Content

409

FullService configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure FullService

Get fullServices

GET /configure/v1/fullServices

Description

Get all fullService services

Parameters

Type Name Description Required Schema Default

QueryParameter

serviceName

Query value undergoes substring matching of service name

false

string

QueryParameter

sourceId

Get the services using the sourceId

false

string

QueryParameter

destinationId

Get the services using the destinationId

false

string

QueryParameter

profileId

Get the services using the profileId

false

string

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.fullService.FullService array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure FullService

Get graphics templates

GET /configure/v1/graphics-templates

Description

List all graphics templates in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of graphics template URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Graphics Template

Create graphics template

POST /configure/v1/graphics-templates

Description

Create new graphics template to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Image configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

Graphics template created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create graphics template

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Graphics Template

Get graphics template by ID

GET /configure/v1/graphics-templates/{id}

Description

Get graphics template by specifying an graphics template ID

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a graphics template

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Graphics Template

Update graphics template

PUT /configure/v1/graphics-templates/{id}

Description

Update graphics template by specifying an graphics template ID.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Image configuration

true

com.harmonicinc.vos.app.configure.model.Image

PathParameter

id

Unique identifier of an graphics template

true

string

Responses

HTTP Code Description Schema

200

Graphics template Updated

com.harmonicinc.vos.app.configure.model.Image

201

Created

No Content

400

Graphics template Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Graphics Template

Delete graphics template

DELETE /configure/v1/graphics-templates/{id}

Description

Delete graphics template by specifying an graphics template ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an graphics template

true

string

Responses

HTTP Code Description Schema

200

Graphics template Deleted

No Content

204

No Content

No Content

400

Graphics template Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

412

Graphics template is used by active services.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Graphics Template

Get list of services where graphics template is used

GET /configure/v1/graphics-templates/{id}/services

Description

Get services with special graphics template by specifying an graphics template ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an graphics template

true

string

Responses

HTTP Code Description Schema

200

Graphics template Deleted

com.harmonicinc.vos.app.configure.model.service.Service array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

412

Graphics template does not exist.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Graphics Template

Get config of image sync

GET /configure/v1/imageSync/config

Description

Get config of image(logo,graphics) sync

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.image.sync.ImageFileSyncConfig

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure ImageSync

Set config of image sync

POST /configure/v1/imageSync/config

Description

Set config of image(logo,graphics) sync

Parameters

Type Name Description Required Schema Default

BodyParameter

config

config

true

com.harmonicinc.vos.app.configure.image.sync.ImageFileSyncConfig

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure ImageSync

Get images

GET /configure/v1/images

Description

List all images in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

query

Query value undergoes substring matching of image URLs or labels

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

-1

QueryParameter

top

First M records to be returned

false

integer (int32)

-1

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.Image array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Create image

POST /configure/v1/images

Description

Create new image to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Image configuration

true

com.harmonicinc.vos.app.configure.model.Image

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

201

Image Created

com.harmonicinc.vos.app.configure.model.Image

400

Failed to create image

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Get image by ID

GET /configure/v1/images/{id}

Description

Get image by specifying an image ID

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.Image

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Image

Update image

PUT /configure/v1/images/{id}

Description

Update image by specifying an image ID.

Parameters

Type Name Description Required Schema Default

BodyParameter

image

Image configuration

true

com.harmonicinc.vos.app.configure.model.Image

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Image Updated

com.harmonicinc.vos.app.configure.model.Image

201

Created

No Content

400

Image Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Delete image

DELETE /configure/v1/images/{id}

Description

Delete image by specifying an image ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Image Deleted

No Content

204

No Content

No Content

400

Image Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

412

Image is used by active services.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Get list of services where image is used

GET /configure/v1/images/{id}/services

Description

Get services with special image by specifying an image ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Image Deleted

com.harmonicinc.vos.app.configure.model.service.Service array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

412

Image does not exist.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Get list sources where image is used

GET /configure/v1/images/{id}/sources

Description

Get sources with special image by specifying an image ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of an image

true

string

Responses

HTTP Code Description Schema

200

Image Deleted

com.harmonicinc.vos.app.configure.model.source.Source array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

412

Image does not exist.

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Image

Get list of key pairs

GET /configure/v1/key-pairs

Description

Get the list of defined key pairs

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.DescramblingKeyPair array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Descrambling Keys

Store a private key

POST /configure/v1/key-pairs

Description

Store private key from a file. Only 2048 byte long RSA private key in PEM format is supported. The key length shall be not encrypted.

Parameters

Type Name Description Required Schema Default

QueryParameter

id

id

false

string

FormDataParameter

file

file

true

file

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.DescramblingKeyPair

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Configure Descrambling Keys

Download a public Key

GET /configure/v1/key-pairs/{id}

Description

Download a public key by its id

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

Success

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Descrambling Keys

Delete a stored key pair

DELETE /configure/v1/key-pairs/{id}

Description

Delete a stored key pair by its id

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

Success

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Descrambling Keys

Get LSMs

GET /configure/v1/lsms

Description

List LSM endpoint in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

name

Filter by name

false

string

QueryParameter

label

Filter by label

false

string

QueryParameter

skip

Skip N records

false

integer (int32)

QueryParameter

top

Top first M records

false

integer (int32)

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.lsm.LSM array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure LSM

Create LSM endpoint

POST /configure/v1/lsms

Description

Create new LSM endpoint to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

lsm

lsm

true

com.harmonicinc.vos.app.configure.model.lsm.LSM

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.lsm.LSM

201

LSM Endpoint Created

com.harmonicinc.vos.app.configure.model.lsm.LSM

400

LSM Endpoint Not Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure LSM

Get LSM endpoint

GET /configure/v1/lsms/{id}

Description

Get LSM endpoint by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.lsm.LSM

401

Unauthorized

No Content

403

Forbidden

No Content

404

LSM endpoint not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure LSM

Update LSM endpoint

PUT /configure/v1/lsms/{id}

Description

Update LSM endpoint by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

lsm

lsm

true

com.harmonicinc.vos.app.configure.model.lsm.LSM

PathParameter

id

Unique identifier of a LSM endpoint

true

string

Responses

HTTP Code Description Schema

200

LSM endpoint Updated

com.harmonicinc.vos.app.configure.model.lsm.LSM

201

Created

No Content

400

LSM endpoint updated failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

LSM endpoint not found

No Content

409

LSM endpoint configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure LSM

Delete LSM endpoint

DELETE /configure/v1/lsms/{id}

Description

Delete LSM endpoint by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a LSM endpoint

true

string

Responses

HTTP Code Description Schema

200

LSM Endpoint Deleted

No Content

204

No Content

No Content

400

LSM Endpoint Not Deleted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure LSM

Get pools

GET /configure/v1/pools

Description

List divitrack pools in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

name

Filter by name

false

string

QueryParameter

label

Filter by label

false

string

QueryParameter

skip

Skip N records

false

integer (int32)

QueryParameter

top

Top first M records

false

integer (int32)

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.pool.Pool array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Pool

Create divitrack pool

POST /configure/v1/pools

Description

Create new divitrack pool to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

pool

pool

true

com.harmonicinc.vos.app.configure.model.pool.Pool

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.pool.Pool

201

Pool Created

com.harmonicinc.vos.app.configure.model.pool.Pool

400

Pool Not Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Pool

Get divitrack pool

GET /configure/v1/pools/{id}

Description

Get divitrack pool by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.pool.Pool

401

Unauthorized

No Content

403

Forbidden

No Content

404

Divitrack pool not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Pool

Update divitrack pool

PUT /configure/v1/pools/{id}

Description

Update divitrack pool by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

pool

pool

true

com.harmonicinc.vos.app.configure.model.pool.Pool

PathParameter

id

Unique identifier of a divitrack pool

true

string

Responses

HTTP Code Description Schema

200

Divitrack pool Updated

com.harmonicinc.vos.app.configure.model.pool.Pool

201

Created

No Content

400

Divitrack pool updated failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Divitrack pool not found

No Content

409

Divitrack pool configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Pool

Delete divitrack pool

DELETE /configure/v1/pools/{id}

Description

Delete divitrack pool by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a divitrack pool

true

string

Responses

HTTP Code Description Schema

200

Divitrack Pool Deleted

No Content

204

No Content

No Content

400

Divitrack Pool Not Deleted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Pool

Get saved graphics templates

GET /configure/v1/saved_graphics_templates/{id}/templates.swf

Description

Get saved graphics templates with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Graphics Template

Get saved image

GET /configure/v1/saved_images/{id}

Description

Get saved image with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Image

Get services

GET /configure/v1/services

Description

Get services in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

serviceName

Query value undergoes substring matching of service name

false

string

QueryParameter

sourceId

Get the services using the sourceId

false

string

QueryParameter

destinationId

Get the services using the destinationId

false

string

QueryParameter

profileId

Get the services using the profileId

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

QueryParameter

top

First M records to be returned

false

integer (int32)

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.service.Service array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Service

Create service

POST /configure/v1/services

Description

Create new service to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

service

service

true

com.harmonicinc.vos.app.configure.model.service.Service

QueryParameter

rollingUpgrade

rollingUpgrade

false

boolean

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.service.Service

201

Service Created

com.harmonicinc.vos.app.configure.model.service.Service

400

Service Creation Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Service

Get service sdp

GET /configure/v1/services/2110-out/{id}.sdp

Description

Get service sdp file for st2110 output.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service sdp file not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • text/plain

Tags

  • Configure Service

Get service

GET /configure/v1/services/{id}

Description

Get service.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.service.Service

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Service

Update service

PUT /configure/v1/services/{id}

Description

Update service with {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

service

service

true

com.harmonicinc.vos.app.configure.model.service.Service

PathParameter

id

Unique identifier of a service

true

string

QueryParameter

upgradeToLatestEngine

upgradeToLatestEngine

false

boolean

QueryParameter

targetEngine

targetEngine

false

string

QueryParameter

rollingUpgrade

rollingUpgrade

false

boolean

QueryParameter

forceUpgrade

forceUpgrade

false

boolean

Responses

HTTP Code Description Schema

200

Service Updated

com.harmonicinc.vos.app.configure.model.service.Service

201

Created

No Content

400

Service update failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

409

Service configuration conflict

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Service

Delete service

DELETE /configure/v1/services/{id}

Description

Delete service with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a service

true

string

QueryParameter

force

force

false

boolean

Responses

HTTP Code Description Schema

200

Service Deleted

No Content

204

No Content

No Content

400

Service Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Service

Get app general setting

GET /configure/v1/settings/general

Description

Get app general setting.

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.GeneralSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Set app general setting

PUT /configure/v1/settings/general

Description

Set app general setting.

Parameters

Type Name Description Required Schema Default

BodyParameter

setting

setting

true

com.harmonicinc.vos.app.configure.model.GeneralSettings

Responses

HTTP Code Description Schema

200

Setting Updated

com.harmonicinc.vos.app.configure.model.GeneralSettings

201

Created

No Content

400

Setting Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Get Irdeto license configuration.

GET /configure/v1/settings/irdeto

Description

Get Irdeto license configuration.

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.IrdetoLicense

401

Unauthorized

No Content

403

Forbidden

No Content

404

License not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Register new Irdeto license configuration.

POST /configure/v1/settings/irdeto

Description

Register new Irdeto license configuration.

Parameters

Type Name Description Required Schema Default

BodyParameter

license

license

true

com.harmonicinc.vos.app.configure.model.IrdetoLicense

Responses

HTTP Code Description Schema

200

Irdeto license registered

com.harmonicinc.vos.app.configure.model.IrdetoLicense

201

Created

No Content

400

Irdeto license registration failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Delete Irdeto license configuration.

DELETE /configure/v1/settings/irdeto

Description

Delete Irdeto license configuration.

Responses

HTTP Code Description Schema

200

Irdeto license configuration Deleted

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Irdeto license configuration Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Get registered Kantar SNAP Watermarking licenses

GET /configure/v1/settings/kantarSnap

Description

Get registered Kantar SNAP Watermarking licenses

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.KantarSnapWatermarkLicenseFile array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Register new Kantar SNAP Watermarking license

POST /configure/v1/settings/kantarSnap

Description

Register new Kantar SNAP Watermarking license

Parameters

Type Name Description Required Schema Default

BodyParameter

license

license

true

com.harmonicinc.vos.app.configure.model.KantarSnapWatermarkLicenseFile

Responses

HTTP Code Description Schema

200

License registered

com.harmonicinc.vos.app.configure.model.KantarSnapWatermarkLicenseFile

201

Created

No Content

400

License registration failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Delete registered Kantar SNAP Watermarking license

DELETE /configure/v1/settings/kantarSnap/{id}

Description

Delete registered Kantar SNAP Watermarking license

Parameters

Type Name Description Required Schema Default

PathParameter

id

License identifier

true

string

Responses

HTTP Code Description Schema

200

License deleted

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

License not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Get service global setting

GET /configure/v1/settings/service

Description

Get service global setting.

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.GlobalServiceSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Set service global setting

PUT /configure/v1/settings/service

Description

Set service global setting.

Parameters

Type Name Description Required Schema Default

BodyParameter

globalServiceSetting

globalServiceSetting

true

com.harmonicinc.vos.app.configure.model.GlobalServiceSetting

Responses

HTTP Code Description Schema

200

Setting Updated

com.harmonicinc.vos.app.configure.model.GlobalServiceSetting

201

Created

No Content

400

Setting Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Settings

Get sources

GET /configure/v1/sources

Description

Get sources in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

name

Filter by name

false

string

QueryParameter

label

Filter by label

false

string

QueryParameter

skip

Skip N records

false

integer (int32)

QueryParameter

top

Top first M records

false

integer (int32)

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.configure.model.source.Source array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Source

Create source

POST /configure/v1/sources

Description

Create new source to the system.

Parameters

Type Name Description Required Schema Default

BodyParameter

source

source

true

com.harmonicinc.vos.app.configure.model.source.Source

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.source.Source

201

Source Created

com.harmonicinc.vos.app.configure.model.source.Source

400

Source Not Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Source

Get source

GET /configure/v1/sources/{id}

Description

Get source by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.source.Source

401

Unauthorized

No Content

403

Forbidden

No Content

404

Source Not Updated

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Source

Update source

PUT /configure/v1/sources/{id}

Description

Update source by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

source

source

true

com.harmonicinc.vos.app.configure.model.source.Source

PathParameter

id

Unique identifier of a source

true

string

Responses

HTTP Code Description Schema

200

Source Updated

com.harmonicinc.vos.app.configure.model.source.Source

201

Created

No Content

400

Source Not Updated

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Source Not Updated

No Content

409

Source configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Source

Delete source

DELETE /configure/v1/sources/{id}

Description

Delete source by {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a source

true

string

Responses

HTTP Code Description Schema

200

Source Deleted

No Content

204

No Content

No Content

400

Source Not Deleted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Source

Update source

PUT /configure/v1/sources_ext/{id}

Description

Update source by {id}.

Parameters

Type Name Description Required Schema Default

BodyParameter

source

source

true

com.harmonicinc.vos.app.configure.model.source.Source

PathParameter

id

Unique identifier of a source

true

string

QueryParameter

triggerServiceUpdate

Need to trigger service update

true

boolean

Responses

HTTP Code Description Schema

200

Source Updated

com.harmonicinc.vos.app.configure.model.source.Source

201

Created

No Content

400

Source Not Updated

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Source Not Updated

No Content

409

Source configuration conflict

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Configure Source

Check all meta data

POST /configure/v1/validate_all_metadata

Description

Check if missing meta data in source.

Parameters

Type Name Description Required Schema Default

BodyParameter

inputGrooming

inputGrooming

true

com.harmonicinc.vos.app.configure.model.source.InputGrooming

Responses

HTTP Code Description Schema

200

Success

No Content

201

Created

No Content

400

Missing grooming info

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Source

Check audio meta data

POST /configure/v1/validate_audio_metadata

Description

Check if missing audio meta data in source.

Parameters

Type Name Description Required Schema Default

BodyParameter

audioGrooming

audioGrooming

true

com.harmonicinc.vos.app.configure.model.source.AudioGrooming

Responses

HTTP Code Description Schema

200

Success

No Content

201

Created

No Content

400

Missing grooming info

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Source

Check data meta data

POST /configure/v1/validate_data_metadata

Description

Check if missing data meta data in source.

Parameters

Type Name Description Required Schema Default

BodyParameter

dataGrooming

dataGrooming

true

com.harmonicinc.vos.app.configure.model.source.DataGrooming

Responses

HTTP Code Description Schema

200

Success

No Content

201

Created

No Content

400

Missing grooming info

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Configure Source

Get esam go config

GET /esam-pois/v1/esamGoConfig

Description

Get esam go config

Responses

HTTP Code Description Schema

200

OK

object

400

Server has been started already

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ESAM POIS App

update esam go config

PUT /esam-pois/v1/esamGoConfig

Description

update esam go config

Parameters

Type Name Description Required Schema Default

BodyParameter

config

config

true

com.harmonicinc.vos.esam.pois.config.EsamConfig

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

400

Server has been started already

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • ESAM POIS App

Get settings

GET /external-asset-potf/v1/settings

Description

Get settings

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.externalassetpotf.model.rest.settings.ExternalAssetPotfSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External Asset Storage

Update settings

PUT /external-asset-potf/v1/settings

Description

Update settings

Parameters

Type Name Description Required Schema Default

BodyParameter

settings

Settings

true

com.harmonicinc.externalassetpotf.model.rest.settings.ExternalAssetPotfSettings

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External Asset Storage

Get packaging profile and DRM setting

GET /external-ott-repackager/v1/packaging_profile

Description

Get packaging profile and DRM setting

Parameters

Type Name Description Required Schema Default

QueryParameter

expandProfile

Indicate to expand profile details (for debug purpose)

false

boolean

false

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.externalottrepackager.model.rest.profile.PackagingProfileWithPolicy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Update packaging profile and DRM setting

PUT /external-ott-repackager/v1/packaging_profile

Description

Update packaging profile and DRM setting

Parameters

Type Name Description Required Schema Default

BodyParameter

profile

Packaging Profile

true

com.harmonicinc.externalottrepackager.model.rest.profile.PackagingProfile

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

List repackaging properties

GET /external-ott-repackager/v1/repackage_properties

Description

List repackaging properties

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.externalottrepackager.model.rest.repackage.RepackageProperties array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Create repackaging properties

POST /external-ott-repackager/v1/repackage_properties

Description

Create repackaging properties

Parameters

Type Name Description Required Schema Default

BodyParameter

profile

Repackage Properties

true

com.harmonicinc.externalottrepackager.model.rest.repackage.RepackageProperties

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Get repackaging properties

GET /external-ott-repackager/v1/repackage_properties/{hostname}

Description

Get repackaging properties

Parameters

Type Name Description Required Schema Default

PathParameter

hostname

hostname

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.externalottrepackager.model.rest.repackage.RepackageProperties

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Update repackaging properties

PUT /external-ott-repackager/v1/repackage_properties/{hostname}

Description

Update repackaging properties

Parameters

Type Name Description Required Schema Default

PathParameter

hostname

hostname

true

string

BodyParameter

profile

Repackage Properties

true

com.harmonicinc.externalottrepackager.model.rest.repackage.RepackageProperties

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Delete repackaging properties

DELETE /external-ott-repackager/v1/repackage_properties/{hostname}

Description

Delete repackaging properties

Parameters

Type Name Description Required Schema Default

PathParameter

hostname

hostname

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Get resource/ scaling settings

GET /external-ott-repackager/v1/settings

Description

Get resource/ scaling settings

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.externalottrepackager.model.rest.settings.ExternalOttRepackagerSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Update resource/ scaling settings

PUT /external-ott-repackager/v1/settings

Description

Update resource/ scaling settings

Parameters

Type Name Description Required Schema Default

BodyParameter

settings

Settings

true

com.harmonicinc.externalottrepackager.model.rest.settings.ExternalOttRepackagerSettings

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • External OTT Repackager

Get live extraction jobs

GET /live-extraction/v1/jobs

Description

Get live extraction jobs.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.job.LiveExtractionJob array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Create live extraction job

POST /live-extraction/v1/jobs

Description

Create live extraction job.

Parameters

Type Name Description Required Schema Default

BodyParameter

liveExtractionParam

Live extraction param

true

com.harmonicinc.vos.app.liveextraction.LiveExtractionParam

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.job.LiveExtractionJob

201

Created

No Content

400

Bad request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

409

Conflict

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Get live extraction job detail

GET /live-extraction/v1/jobs/{id}

Description

Get live extraction job detail.

Parameters

Type Name Description Required Schema Default

PathParameter

id

The job id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.job.LiveExtractionJob

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Delete live extraction job

DELETE /live-extraction/v1/jobs/{id}

Description

Delete live extraction job.

Parameters

Type Name Description Required Schema Default

PathParameter

id

The job id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Get live extraction job metadata

GET /live-extraction/v1/jobs/{id}/metadata

Description

Get live extraction job metadata.

Parameters

Type Name Description Required Schema Default

PathParameter

id

The job id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Probe live service live output

POST /live-extraction/v1/probe

Description

Probe live service live output.

Parameters

Type Name Description Required Schema Default

BodyParameter

probeRequest

Probe request

true

com.harmonicinc.vos.app.liveextraction.util.ProbeRequest

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.util.ProbeResult

201

Created

No Content

400

Bad request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

409

Conflict

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Get live extraction settings

GET /live-extraction/v1/settings

Description

Get live extraction settings.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.settings.LiveExtractionSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Update live extraction settings

PUT /live-extraction/v1/settings

Description

Update live extraction settings.

Parameters

Type Name Description Required Schema Default

BodyParameter

settings

Live extraction settings

true

com.harmonicinc.vos.app.liveextraction.settings.LiveExtractionSettings

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Get live extraction app status

GET /live-extraction/v1/status

Description

Get live extraction app status.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveextraction.rest.LiveExtractionAppStatus

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveExtraction

Get live ingest origin settings

GET /live-ingest-origin/v1/settings

Description

Get live ingest origin settings

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.liveingestorigin.settings.LiveIngestOriginSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveIngestOrigin

Update live ingest origin settings

POST /live-ingest-origin/v1/settings

Description

Update live ingest origin settings

Parameters

Type Name Description Required Schema Default

BodyParameter

setting

setting

true

com.harmonicinc.vos.app.liveingestorigin.settings.LiveIngestOriginSetting

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • LiveIngestOrigin

Get logs

GET /logs/v1/logs

Description

List logs in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

severity

Filter by severity

false

enum (CRITICAL, WARNING, IMPORTANT)

QueryParameter

search

Filter by Lucene query

false

string

QueryParameter

start_time

Filter by start time; Up to the earliest logs if not specified

false

string (date-time)

QueryParameter

end_time

Filter by end time; Up to the the latest logs if not specified

false

string (date-time)

QueryParameter

result_after

Return logs sorted behind a specific log ID

false

string

QueryParameter

result_count

Number of logs to be returned

false

integer (int32)

QueryParameter

format

Format that logs are represented in

false

enum (JSON, PLAIN, XML)

QueryParameter

verbose

Set to true to show extra fields

false

boolean

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Logs

Download logs

GET /logs/v1/logs/download

Description

Download logs as archive file.

Parameters

Type Name Description Required Schema Default

QueryParameter

Index Pattern

Filter by index

false

string

QueryParameter

fileNameSuffix

File Name Suffix

false

string

QueryParameter

severity

Filter by severity

false

enum (CRITICAL, WARNING, IMPORTANT)

QueryParameter

search

Filter by Lucene query

false

string

QueryParameter

start_time

Filter by start time; Up to the earliest logs if not specified

false

string (date-time)

QueryParameter

end_time

Filter by end time; Up to the the latest logs if not specified

false

string (date-time)

QueryParameter

format

Format that logs are represented in

false

enum (JSON, PLAIN, XML)

QueryParameter

verbose

Set to true to show extra fields

false

boolean

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Logs

Get Active-Active service role

GET /monitor/v1/activeActiveServiceRole/{id}

Description

Get Active-Active service role.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.monitor.model.ServiceRole

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Monitor Service

Update a live Event

PUT /monitor/v1/live-events/{id}

Description

update a live Event

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

updateRequest

updateRequest

true

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventUpdateRequest

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventResponse

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Event

End live event with service id

PUT /monitor/v1/live-events/{id}/end

Description

Action to end the live event with service id

Parameters

Type Name Description Required Schema Default

PathParameter

id

Service id

true

string

Responses

HTTP Code Description Schema

200

End live event successful

No Content

201

Created

No Content

400

Failed to end live event

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

No live event with specified service Id

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Event

Go live event with service id

PUT /monitor/v1/live-events/{id}/live

Description

Action to goLive the live event with service id

Parameters

Type Name Description Required Schema Default

PathParameter

id

Service id

true

string

Responses

HTTP Code Description Schema

200

Go live event successful

No Content

201

Created

No Content

400

Failed to go live event

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

No live event with specified service Id

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Event

Offline live event with service id

PUT /monitor/v1/live-events/{id}/offline

Description

Action to offline the live event with service id

Parameters

Type Name Description Required Schema Default

PathParameter

id

Service id

true

string

Responses

HTTP Code Description Schema

200

Offline live event successful

No Content

201

Created

No Content

400

Failed to offline live event

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

No live event with specified service Id

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Event

Preview live event with service id

PUT /monitor/v1/live-events/{id}/online

Description

Action to preview the live event with service id

Parameters

Type Name Description Required Schema Default

PathParameter

id

Service id

true

string

Responses

HTTP Code Description Schema

200

Preview live event successful

No Content

201

Created

No Content

400

Failed to preview live event

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

No live event with specified service Id

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Event

Get activated services

GET /monitor/v1/services

Description

Get activated services in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

ServiceName

Query value undergoes substring matching of instance name

false

string

QueryParameter

skip

Skip N records to be returned

false

integer (int32)

QueryParameter

top

First M records to be returned

false

integer (int32)

QueryParameter

skipStats

Skip statistics

false

boolean

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.monitor.model.Service array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Monitor Service

Get activated services status

GET /monitor/v1/services-status

Description

Get services status in the system.

Parameters

Type Name Description Required Schema Default

QueryParameter

label

Return services-status with specific label

false

string

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.monitor.model.ServiceStatus array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Monitor Service

Get activated service’s status by service Id

GET /monitor/v1/services-status/{id}

Description

Get service status in the system by service Id.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

Success

com.harmonicinc.vos.app.monitor.model.ServiceStatus

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get current SCTE-104 client connections

GET /monitor/v1/services/scte-104

Description

Get current SCTE-104 client connections

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.Scte104ConnectionStatus

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get activated service

GET /monitor/v1/services/{id}

Description

Get activated service.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.Service

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get graphics status

GET /monitor/v1/services/{id}/graphics

Description

Get graphics status of service {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.GraphicsState

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Turn ON/OFF graphics

POST /monitor/v1/services/{id}/graphics

Description

Turn ON/OFF graphics with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

graphicsRequestConfig

graphicsRequestConfig

true

com.harmonicinc.vos.app.monitor.model.GraphicsRequestConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.GraphicsRequestConfig

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get logo status

GET /monitor/v1/services/{id}/logo

Description

Get logo status of service {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.LogoState

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

POST /monitor/v1/services/{id}/logo

Description

Turn ON/OFF logo with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

logoRequestConfig

logoRequestConfig

true

com.harmonicinc.vos.app.monitor.model.LogoRequestConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.LogoRequestConfig

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get mute/unmute service output state

GET /monitor/v1/services/{id}/muteOutput

Description

Get mute/unmute service {id} output state

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

boolean

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

mute/unmute service output

POST /monitor/v1/services/{id}/muteOutput

Description

mute/unmute service {id} output.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

QueryParameter

isMute

Mute service output

true

boolean

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get redundancy group status

GET /monitor/v1/services/{id}/redundancy_group

Description

Get redundancy group with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

QueryParameter

instanceId

Instance ID

false

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.RedundancyGroupState

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Join/Quite redundancy group

POST /monitor/v1/services/{id}/redundancy_group

Description

Join/Quit redundancy group with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

redundanyGroupRequestConfig

redundanyGroupRequestConfig

true

com.harmonicinc.vos.app.monitor.model.RedundanyGroupRequestConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.RedundanyGroupRequestConfig

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Remove retained program/chapter start from manifest for HLS DATERANGE

POST /monitor/v1/services/{id}/remove_retained_program_chapter_start

Description

Remove retained program/chapter start from manifest for HLS DATERANG.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

removeRetainedProgramChapterStartState

removeRetainedProgramChapterStartState

true

com.harmonicinc.vos.app.monitor.model.RemoveRetainedProgramChapterStartState

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Illegal parameters

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

reset the input status statistics

POST /monitor/v1/services/{id}/resetStatistics

Description

reset the input status statistics including the FEC 2022-1 counters of service $id

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

boolean

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Monitor Service

Get slate status

GET /monitor/v1/services/{id}/slate

Description

Get slate status with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

QueryParameter

slateType

Slate Type (ManualSlate)

false

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.SlateStatus

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Turn ON/OFF slate

POST /monitor/v1/services/{id}/slate

Description

Turn ON/OFF slate with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

slateRequestConfig

slateRequestConfig

true

com.harmonicinc.vos.app.monitor.model.SlateRequestConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.SlateStatus

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Switching the active instance of activated service

POST /monitor/v1/services/{id}/switch_active_instance

Description

Switching the active instance of activated service.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get thumbnail

GET /monitor/v1/services/{id}/thumbnail

Description

Get thumbnail with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get DRM control status

GET /monitor/v1/services/{id}/toggle_drm

Description

Get DRM control status of service {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.monitor.model.ToggleDrmState

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Force unencrypted / Default following existing DRM settings

POST /monitor/v1/services/{id}/toggle_drm

Description

Force unencrypted / Default following existing DRM settings.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

toggleDrmState

toggleDrmState

true

com.harmonicinc.vos.app.monitor.model.ToggleDrmState

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Illegal parameters

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

500

Internal error

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Get unmute service output start and end time

GET /monitor/v1/services/{id}/unmuteOutputStartEndTime

Description

Set unmute service {id} output start and end time.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.spi.operation.ServiceOutputUnmuteStartEndTime

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Set unmute service output start time

POST /monitor/v1/services/{id}/unmuteOutputStartEndTime

Description

Set unmute service {id} output start time.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

serviceOutputUnmuteStartEndTime

serviceOutputUnmuteStartEndTime

true

com.harmonicinc.vos.spi.operation.ServiceOutputUnmuteStartEndTime

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Invalid id

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

501

Not supported

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Service

Create a full transcoding service and add it to the mux with associated program parameters

POST /mux/v1/create-full-service

Description

Create a full transcoding service including sources and destination and add the service to the mux with associated program parameters. The destination pool shall match with an existing mux

Parameters

Type Name Description Required Schema Default

BodyParameter

serviceWithParameters

serviceWithParameters

true

com.harmonicinc.vos.mux.model.common.MuxFullService

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.MuxFullService

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Unauthorized operation

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Get monitoring for all SDI ports

GET /mux/v1/monitor/sdi-ports

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.sdi.MonitorSdiPort array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get monitoring for all ts inputs connected to a mux/demux

GET /mux/v1/monitor/ts-inputs

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputTS array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get blackout state for all output programs of a specific MPTS (muxServiceId)

GET /mux/v1/monitor/{muxServiceId}/blackout

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.blackout.BlackoutOutputProgramState array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Mux service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Enable blackout for some output programs of a specific MPTS (muxServiceId)

POST /mux/v1/monitor/{muxServiceId}/blackout

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

BodyParameter

blackoutOutputProgramStateList

blackoutOutputProgramStateList

true

com.harmonicinc.vos.mux.monitor.model.blackout.BlackoutOutputProgramState array

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Mux service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get eas status for all output programs for which eas is enabled (muxServiceId)

GET /mux/v1/monitor/{muxServiceId}/eas

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.eas.EasOutputProgramState array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Mux service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Send manual switch command to one or several programs (muxServiceId)

POST /mux/v1/monitor/{muxServiceId}/eas/switch

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

BodyParameter

easSwitchRequestCommand

easSwitchRequestCommand

true

com.harmonicinc.vos.mux.monitor.model.eas.EasSwitchRequestCommand

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Mux service not found

No Content

500

Internal error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get current triveni tables for a specific MPTS (muxServiceId)

GET /mux/v1/monitor/{muxServiceId}/triveni

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.triveni.TriveniTable array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Mux service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get monitoring for all ts inputs connected to a specific MPTS (muxServiceId)

GET /mux/v1/monitor/{muxServiceId}/ts-inputs

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputTS array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get monitoring for one ts input connected to a specific MPTS (muxServiceId)

GET /mux/v1/monitor/{muxServiceId}/ts-inputs/{inputObjectId}

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

PathParameter

inputObjectId

inputObjectId

true

string

Responses

HTTP Code Description Schema

200

OK

object

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

TS input not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Monitor

Get all network(s) assigned to the platform

GET /mux/v1/networks

Responses

HTTP Code Description Schema

200

successful operation

com.harmonicinc.vos.mux.model.common.Network array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Assign a new network to the platform

POST /mux/v1/networks

Parameters

Type Name Description Required Schema Default

BodyParameter

body

Network

true

com.harmonicinc.vos.mux.model.common.Network

Responses

HTTP Code Description Schema

200

Network added

com.harmonicinc.vos.mux.model.common.Network

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Get a network known by its unique identifier

GET /mux/v1/networks/{networkId}

Parameters

Type Name Description Required Schema Default

PathParameter

networkId

Unique identifier of network to get

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.Network

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Network not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Update an existing network

PUT /mux/v1/networks/{networkId}

Parameters

Type Name Description Required Schema Default

PathParameter

networkId

Unique identifier of network to update

true

string

BodyParameter

body

network

true

com.harmonicinc.vos.mux.model.common.Network

Responses

HTTP Code Description Schema

200

Updated network

com.harmonicinc.vos.mux.model.common.Network

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Network not found

No Content

405

Validation exception

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Delete a network

DELETE /mux/v1/networks/{networkId}

Parameters

Type Name Description Required Schema Default

PathParameter

networkId

Unique identifier of network to delete

true

string

Responses

HTTP Code Description Schema

200

Deleted network

No Content

204

No Content

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Network not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Mux App Configure

Get all Mux Service Configurations

GET /mux/v1/services

Description

with attached pools and destinations

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.MuxService array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Create a complete Mux Service

POST /mux/v1/services

Description

includes pools and destinations

Parameters

Type Name Description Required Schema Default

BodyParameter

muxService

muxService

true

com.harmonicinc.vos.mux.model.common.MuxService

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.MuxService

201

Created

No Content

400

Invalid configuration

No Content

401

Unauthorized

No Content

403

Unauthorized operation

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Get Mux Service Configuration

GET /mux/v1/services/{id}

Description

with attached pools and destinations

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a service

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.MuxService

401

Unauthorized

No Content

403

Forbidden

No Content

404

Service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Update Mux Service Configuration

PUT /mux/v1/services/{id}

Description

with attached pools and destinations

Parameters

Type Name Description Required Schema Default

BodyParameter

pool

muxService

true

com.harmonicinc.vos.mux.model.common.MuxService

PathParameter

id

Unique identifier of a service

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.MuxService

201

Created

No Content

400

Configuration Error

No Content

401

Unauthorized

No Content

403

Unauthorized operation

No Content

404

Service not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Delete a complete Mux Service

DELETE /mux/v1/services/{id}

Description

delete attached unused pools and destinations

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a service

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Unauthorized operation

No Content

404

Service not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Mux App Configure

Get all table generator(s) assigned to the platform

GET /mux/v1/table-generators

Responses

HTTP Code Description Schema

200

successful operation

com.harmonicinc.vos.mux.model.common.TableGenerator array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Assign a new table generator to the platform

POST /mux/v1/table-generators

Parameters

Type Name Description Required Schema Default

BodyParameter

body

PSIP Generator (Triveni)

true

com.harmonicinc.vos.mux.model.common.TableGenerator

Responses

HTTP Code Description Schema

200

Table generator added

com.harmonicinc.vos.mux.model.common.TableGenerator

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Get a table generator known by its unique identifier

GET /mux/v1/table-generators/{generatorId}

Parameters

Type Name Description Required Schema Default

PathParameter

generatorId

Unique identifier of table generator to get

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.common.TableGenerator

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Table generator not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Update an existing table generator

PUT /mux/v1/table-generators/{generatorId}

Parameters

Type Name Description Required Schema Default

PathParameter

generatorId

Unique identifier of table generator to update

true

string

BodyParameter

body

PSIP Generator (Triveni)

true

com.harmonicinc.vos.mux.model.common.TableGenerator

Responses

HTTP Code Description Schema

200

Updated Table generator

com.harmonicinc.vos.mux.model.common.TableGenerator

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Table generator not found

No Content

405

Validation exception

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Delete a table generator

DELETE /mux/v1/table-generators/{generatorId}

Parameters

Type Name Description Required Schema Default

PathParameter

generatorId

Unique identifier of table generator to delete

true

string

Responses

HTTP Code Description Schema

200

Deleted Table generator

No Content

204

No Content

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Table generator not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Mux App Configure

Get list of transport streams

GET /mux/v1/transport-streams

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.ts.OutputTS array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Get transport stream

GET /mux/v1/transport-streams/{muxServiceId}

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.mux.model.ts.OutputTS

401

Unauthorized

No Content

403

Forbidden

No Content

404

TS not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Update an existing transport stream

PUT /mux/v1/transport-streams/{muxServiceId}

Description

should refer to a mux-service object

Parameters

Type Name Description Required Schema Default

PathParameter

muxServiceId

muxServiceId

true

string

BodyParameter

updatedTs

updatedTs

true

com.harmonicinc.vos.mux.model.ts.OutputTS

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

TS not found

No Content

500

invalid configuration

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Mux App Configure

Query notifications

GET /notification/v1/notifications

Description

Query notifications by its properties, results are sorted by notification id (in the same order as the time of notification created ).

Parameters

Type Name Description Required Schema Default

QueryParameter

state

Notification State

false

enum (ACTIVE, RESOLVED, TRANSIENT)

QueryParameter

severity

Severity values that need to be considered for filter

false

enum (CRITICAL, WARNING, IMPORTANT)

QueryParameter

objectType

Notification object type

false

string

QueryParameter

is_scheduled

Scheduled fix set

false

boolean

QueryParameter

title_search

Title name

false

string

QueryParameter

result_after

result_after

false

string

QueryParameter

result_count

result_count

false

integer (int32)

0

QueryParameter

NotificationQueryMode

Notification Query Mode

false

enum (GET_NON_MASKED, GET_MASKED, GET_ALL)

GET_NON_MASKED

Responses

HTTP Code Description Schema

200

OK

object array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Notification

Schedule fix for notifications

POST /notification/v1/notifications/schedule_fix

Description

Schedule a fix time for all active notification to user. When schedule fix is set, the notification will be hidden from all users' notification feeds, unless it is overdue.

Parameters

Type Name Description Required Schema Default

BodyParameter

scheduleFixParam

The details of the schedule fix

true

com.harmonicinc.vos.notification.rest.model.NotificationScheduleFixParam

Responses

HTTP Code Description Schema

200

Schedule fix successfully

No Content

201

Created

No Content

400

Illegal parameters

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Notification Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Notification

Get notification details

GET /notification/v1/notifications/{id}

Description

Get detail info of a notification, including suggested solution and additional info.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of notification

true

string

Responses

HTTP Code Description Schema

200

Notification Found

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Notification Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Notification

Schedule fix for notifications

POST /notification/v1/notifications/{id}/schedule_fix

Description

Schedule a fix time for a notification to user. When schedule fix is set, the notification will be hidden from all users' notification feeds, unless it is overdue.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of notification

true

string

BodyParameter

scheduleFixParam

The details of the schedule fix

true

com.harmonicinc.vos.notification.rest.model.NotificationScheduleFixParam

Responses

HTTP Code Description Schema

200

Schedule fix successfully

No Content

201

Created

No Content

400

Illegal parameters

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Notification Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Notification

Update notification type severity

PUT /notification/v1/typeSeverity

Description

Update notification type severity

Parameters

Type Name Description Required Schema Default

BodyParameter

notificationTypeSeverityUpdateParams

notificationTypeSeverityUpdateParams

true

com.harmonicinc.vos.notification.rest.model.NotificationTypeSeverityUpdateItem array

Responses

HTTP Code Description Schema

200

Notification Type Severities Updated

No Content

201

Created

No Content

400

Notification Type Severities Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Notification

Get info of live/nPVR channels being served

GET /origin-engine/v1/channels

Description

Get info of live/nPVR channels being served

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Get info of a live/nPVR channel

GET /origin-engine/v1/channels/{id}

Description

Get info of a live/nPVR channel

Parameters

Type Name Description Required Schema Default

PathParameter

id

The server id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

List all LLCU assets

GET /origin-engine/v1/llcu/assets

Description

List all LLCU assets

Parameters

Type Name Description Required Schema Default

QueryParameter

opState

operation state to be listed

false

string

QueryParameter

queryId

query ID

false

string

QueryParameter

maxItemsPerRequest

max items per request

false

integer (int32)

50

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAssetList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Create a LLCU asset

POST /origin-engine/v1/llcu/assets

Description

Create a LLCU asset, extract from fromlive

Parameters

Type Name Description Required Schema Default

BodyParameter

llcuAssetBase

The content about the job

true

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAssetBase

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Get a LLCU asset

GET /origin-engine/v1/llcu/assets/{id}

Description

Get a LLCU asset

Parameters

Type Name Description Required Schema Default

PathParameter

id

LLCU asset name

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAsset

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Update an existing LLCU asset

PUT /origin-engine/v1/llcu/assets/{id}

Description

Update an existing LLCU asset

Parameters

Type Name Description Required Schema Default

PathParameter

id

LLCU asset name

true

string

BodyParameter

llcuAssetBase

The content about the job

true

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAssetBase

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Delete a LLCU asset

DELETE /origin-engine/v1/llcu/assets/{id}

Description

Delete a LLCU asset

Parameters

Type Name Description Required Schema Default

PathParameter

id

LLCU asset name

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Get LLCU asset DRM settings

GET /origin-engine/v1/llcu/assets/{id}/drm_setting

Description

Get LLCU asset DRM settings

Parameters

Type Name Description Required Schema Default

PathParameter

id

LLCU asset name

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.DrmSetting

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Update LLCU asset DRM settings

PUT /origin-engine/v1/llcu/assets/{id}/drm_setting

Description

Update LLCU asset DRM settings

Parameters

Type Name Description Required Schema Default

PathParameter

id

LLCU asset name

true

string

BodyParameter

drmSetting

DRM settings

true

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.DrmSetting

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine AssetManagement (JSON)

Get pre-warming schedule

GET /origin-engine/v1/schedule

Description

Get pre-warming schedule.

Parameters

Type Name Description Required Schema Default

QueryParameter

event_name

Event name

false

string

QueryParameter

event_status

Event status

false

multi string array

QueryParameter

limit

No. of results returned

false

integer (int32)

QueryParameter

offset

Item offset

false

integer (int32)

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.datamodel.PreWarmScheduleResponse

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Add pre-warming event

POST /origin-engine/v1/schedule/events

Description

Add pre-warming event

Parameters

Type Name Description Required Schema Default

BodyParameter

event

Event

true

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventInternal

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Get pre-warming event

GET /origin-engine/v1/schedule/events/{id}

Description

Get pre-warming event by event ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventInternal

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Update pre-warming event

PUT /origin-engine/v1/schedule/events/{id}

Description

Update pre-warming event by event ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID

true

string

BodyParameter

event

Event

true

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventConfig

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventInternal

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Delete pre-warming event

DELETE /origin-engine/v1/schedule/events/{id}

Description

Delete pre-warming event by event ID.

Parameters

Type Name Description Required Schema Default

PathParameter

id

ID

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Get origin engine settings

GET /origin-engine/v1/settings

Description

Get origin engine settings.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Configure origin engine settings

PUT /origin-engine/v1/settings

Description

Undefined config will be set to default value. Get settings then overwrite new config if you only want partial update.

Parameters

Type Name Description Required Schema Default

BodyParameter

settings

General origin engine settings

true

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Get test object information

GET /origin-engine/v1/static_resources/test_object

Description

Get information of the test object

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.unifiedoriginenginelibrary.datamodel.TestObjectInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Updates the test object

POST /origin-engine/v1/static_resources/test_object

Description

Updates a ZIP file that contains files of the test object

Parameters

Type Name Description Required Schema Default

FormDataParameter

file

Zip file

true

file

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • OriginEngine

Delete test object

DELETE /origin-engine/v1/static_resources/test_object

Description

Clear the test object data

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Delete a mapping of VOD profile ID to Labwizard destination

DELETE /origin-engine/v1/vod/profile_map/{id}

Description

Delete a mapping of VOD profile ID to Labwizard destination

Parameters

Type Name Description Required Schema Default

PathParameter

id

VOD profile id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • OriginEngine

Get list of playout channels

GET /playoutcontrol/v1/channels

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.PlayoutService array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get missing assets

GET /playoutcontrol/v1/channels/{channelId}/missing-assets

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.checker.MissingAssetList

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get channel settings

GET /playoutcontrol/v1/channels/{channelId}/settings

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.ChannelGetProperties

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Update channel settings

PUT /playoutcontrol/v1/channels/{channelId}/settings

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

pProps

Channel properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.ChannelSetProperties

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get list of events for a channel

GET /playoutcontrol/v1/events/{channelId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

QueryParameter

RefEventId

Default is the Id of the rank #1 event, which is the on-air event (or next event if no on-air event)

false

string

QueryParameter

EventOffset

Signed integer. Applies to the Reference primary event, to identify the first returned event. Default is 0

false

integer (int32)

0

QueryParameter

EventsNumber

Number of returned events. Default is 0: returns the events until the end of the playlist

false

integer (int32)

0

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PlaylistEventList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Delete a range of primary events

DELETE /playoutcontrol/v1/events/{channelId}/primaries/{firstPrimaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

firstPrimaryId

ID of the first primary event to delete

true

string

QueryParameter

lastPrimaryId

ID of the last primary event to delete

false

string

Responses

HTTP Code Description Schema

200

Events deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

First or last event doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Insert a primary event

POST /playoutcontrol/v1/events/{channelId}/primary

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

pProps

Event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertPrimaryProperties

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties

201

Event created

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Update a primary event

PUT /playoutcontrol/v1/events/{channelId}/primary/{primaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

BodyParameter

pProps

Event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.UpdatePrimaryProperties

Responses

HTTP Code Description Schema

200

Event updated

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Event not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Delete a primary event and all of its secondary events

DELETE /playoutcontrol/v1/events/{channelId}/primary/{primaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

Responses

HTTP Code Description Schema

200

Event deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Event doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Play the next event of a channel

POST /playoutcontrol/v1/events/{channelId}/primary/{primaryId}/play

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

QueryParameter

play_time_tc

Play time in timecode

false

string

Responses

HTTP Code Description Schema

200

Play next request done

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Event doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Insert a secondary event

POST /playoutcontrol/v1/events/{channelId}/primary/{primaryId}/secondary

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

BodyParameter

sProps

Event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties

201

Secondary event created

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Update a secondary event

PUT /playoutcontrol/v1/events/{channelId}/primary/{primaryId}/secondary/{secondaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

PathParameter

secondaryId

ID of the secondary event

true

string

BodyParameter

pProps

Event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

Responses

HTTP Code Description Schema

200

Event updated

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Event not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Delete a secondary event

DELETE /playoutcontrol/v1/events/{channelId}/primary/{primaryId}/secondary/{secondaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

primaryId

ID of the primary event

true

string

PathParameter

secondaryId

ID of the secondary event

true

string

Responses

HTTP Code Description Schema

200

Event deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Event doesn’t exist

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Create a new sequence

POST /playoutcontrol/v1/events/{channelId}/sequence

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

pProps

Sequence properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.CreateSequenceProperties

Responses

HTTP Code Description Schema

200

OK

string

201

Sequence created

string

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Update a sequence

PUT /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

BodyParameter

pProps

Sequence properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.UpdateSequenceProperties

Responses

HTTP Code Description Schema

200

Sequence updated

string

201

Created

No Content

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Sequence not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Delete a sequence and all its events

DELETE /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

Responses

HTTP Code Description Schema

200

Sequence deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Play the sequence for the channel

POST /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/play

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

Responses

HTTP Code Description Schema

200

Sequence inserted for playing

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized request. Check if the sequence is allowed to be played

No Content

403

Forbidden

No Content

404

Sequence or Channel doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Add a primary event in a sequence

POST /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

BodyParameter

pProps

Sequence primary event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSinglePrimaryProperties

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryProperties

201

Sequence primary event created

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryProperties

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Update a primary event in a sequence

PUT /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary/{primaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

PathParameter

primaryId

ID of the primary event

true

string

BodyParameter

pProps

Sequence primary event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.UpdateSequencePrimaryProperties

Responses

HTTP Code Description Schema

200

Sequence primary event updated

string

201

Created

No Content

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence or primary doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Delete a primary event in a sequence

DELETE /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary/{primaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

PathParameter

primaryId

ID of the primary event

true

string

Responses

HTTP Code Description Schema

200

Sequence primary event deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence or primary doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Add a secondary event in a sequence

POST /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary/{primaryId}/secondary

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

PathParameter

primaryId

ID of the primary event

true

string

BodyParameter

pProps

Sequence secondary event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryProperties

201

Sequence secondary event created

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryProperties

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence or primary doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Update a secondary event in a sequence

PUT /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary/{primaryId}/secondary/{secondaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

PathParameter

primaryId

ID of the primary event

true

string

PathParameter

secondaryId

ID of the secondary event

true

string

BodyParameter

pProps

Sequence secondary event properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

Responses

HTTP Code Description Schema

200

Sequence secondary event updated

string

201

Created

No Content

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence or primary or secondary doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Delete a secondary event in a sequence

DELETE /playoutcontrol/v1/events/{channelId}/sequence/{sequenceId}/primary/{primaryId}/secondary/{secondaryId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

ID of the sequence

true

string

PathParameter

primaryId

ID of the primary event

true

string

PathParameter

secondaryId

ID of the secondary event

true

string

Responses

HTTP Code Description Schema

200

Sequence secondary event deleted

string

204

No Content

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Channel or sequence or primary or secondary doesn’t exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Get all sequences of a channel

GET /playoutcontrol/v1/events/{channelId}/sequences

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceElement array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get sequence of a channel from a given sequence ID

GET /playoutcontrol/v1/events/{channelId}/sequences/{sequenceId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

sequenceId

Sequence ID

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceElement

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get all onair graphics for a channel

GET /playoutcontrol/v1/graphics/{channelId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.playout.zookeeper.access.instancestatus.Graphic array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Update graphic on a layer for a channel

PUT /playoutcontrol/v1/graphics/{channelId}/layer/{layer}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

layer

Layer between 1 and 8

true

integer (int32)

BodyParameter

sProps

Text fields

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.graphic.UpdateGraphicProperties

Responses

HTTP Code Description Schema

200

Update a graphic

string

201

Created

No Content

400

Unexpected issue

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

No graphic found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Start graphic on a layer for a channel

POST /playoutcontrol/v1/graphics/{channelId}/layer/{layer}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

layer

Layer between 1 and 8

true

integer (int32)

BodyParameter

sProps

Graphic name and text fields

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.graphic.StartGraphicProperties

Responses

HTTP Code Description Schema

200

Start a graphic

string

201

Created

No Content

400

Unexpected issue

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Graphic is missing

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Stop graphic on a layer for a channel

POST /playoutcontrol/v1/graphics/{channelId}/layer/{layer}/stop

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

layer

Layer between 1 and 8

true

integer (int32)

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Unload graphic on a layer for a channel

POST /playoutcontrol/v1/graphics/{channelId}/layer/{layer}/unload

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

layer

Layer between 1 and 8

true

integer (int32)

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Unload all graphics on all layers for a channel

POST /playoutcontrol/v1/graphics/{channelId}/unload

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Get live source monitoring

GET /playoutcontrol/v1/livesources/{channelId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

Responses

HTTP Code Description Schema

200

Current live source monitoring

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.LiveSourceMonitoringProperties

400

Unexpected issue

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specified channel does not exist

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Start live source monitoring

POST /playoutcontrol/v1/livesources/{channelId}/player/{player}/startmonitoring

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

player

Player

true

enum (PLAYER_1, PLAYER_2)

BodyParameter

sProps

sProps

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.StartLiveSourceMonitoringProperties

Responses

HTTP Code Description Schema

200

Monitoring of the specified source started

string

201

Created

No Content

400

Unexpected issue

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specified channel does not exist

No Content

503

The player is used to monitor a higher priority source

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Stop live source monitoring

POST /playoutcontrol/v1/livesources/{channelId}/player/{player}/stopmonitoring

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

PathParameter

player

Player

true

enum (PLAYER_1, PLAYER_2)

Responses

HTTP Code Description Schema

200

Current live source monitoring

string

201

Created

No Content

400

Unexpected issue

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specified channel does not exist

No Content

503

The player is used to monitor a higher priority source

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Update default live source to PRIMARY or SECONDARY

PUT /playoutcontrol/v1/livesources/{channelId}/switch-default-source

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

pProps

Target declaration to trigger default live source update

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.DefaultLiveSource

Responses

HTTP Code Description Schema

200

Update current default live source command triggered

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

ChannelId doesn’t exist

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Toggle source input switch for an ON-AIR or OFF-AIR source when input redundancy is used

POST /playoutcontrol/v1/livesources/{channelId}/switch_input

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

pProps

Target declaration to trigger a manual source input switch

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.ToggleSourceInput

Responses

HTTP Code Description Schema

200

Toggle source input command triggered

string

201

Created

No Content

400

Invalid request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

ChannelId, ServiceId or SourceId doesn’t exist

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Playout Backend

Send a Scte-35 message

POST /playoutcontrol/v1/scte35/{channelId}

Parameters

Type Name Description Required Schema Default

PathParameter

channelId

ID of the channel

true

string

BodyParameter

scte35MessageProperties

scte35MessageProperties

true

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.scte35.SendScte35MessageProperties

Responses

HTTP Code Description Schema

200

OK

string

201

Scte-35 message is sent

string

400

Bad or mal-formatted argument

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

ChannelId or Label not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Create a playlist trigger

POST /playoutcontrol/v1/trigger

Parameters

Type Name Description Required Schema Default

BodyParameter

triggerConfiguration

Trigger properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf

201

Trigger has been created

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Update a playlist trigger

PUT /playoutcontrol/v1/trigger/{triggerId}

Parameters

Type Name Description Required Schema Default

PathParameter

triggerId

Trigger ID

true

string

BodyParameter

triggerConfiguration

Trigger properties

true

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf

Responses

HTTP Code Description Schema

200

Trigger has been updated

string

201

Created

No Content

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

TriggerId not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Delete a playlist trigger

DELETE /playoutcontrol/v1/trigger/{triggerId}

Parameters

Type Name Description Required Schema Default

PathParameter

triggerId

Trigger ID

true

string

Responses

HTTP Code Description Schema

200

OK

string

201

Trigger has been deleted

string

204

No Content

No Content

400

Invalid Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

TriggerId not found

No Content

500

Internal Error

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Get playlist triggers

GET /playoutcontrol/v1/triggers

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Playout Backend

Update certifcate and private key

POST /scrambling/v1/drm/clientAuthCertKey

Description

Update certificate and private key for client authentication.

Parameters

Type Name Description Required Schema Default

QueryParameter

type

Type of file containing certificate and private key

false

enum (pem)

pem

FormDataParameter

file

file

true

file

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Scrambling DRM

Get All DRM Fixed Resources

GET /scrambling/v1/drm/fixedResources

Description

Get all DRM Fixed Resources.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Create DRM Fixed Resource

POST /scrambling/v1/drm/fixedResources

Description

Create a fixed DRM resource for OTT encryption.

Parameters

Type Name Description Required Schema Default

BodyParameter

drmFixedResource

drmFixedResource

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Get DRM Fixed Resource

GET /scrambling/v1/drm/fixedResources/{id}

Description

Get a DRM Fixed Resource.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm Fixed Key not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Update DRM Fixed Resource

PUT /scrambling/v1/drm/fixedResources/{id}

Description

Update a DRM Fixed Resource.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

drmFixedResource

drmFixedResource

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm Fixed Key not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Delete DRM Fixed Resource

DELETE /scrambling/v1/drm/fixedResources/{id}

Description

Delete a DRM Fixed Resource.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Get DRM Settings

GET /scrambling/v1/drm/settings

Description

Get a DRM Settings.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmSettings

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm Settings not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Update DRM Settings

PUT /scrambling/v1/drm/settings

Description

Update a DRM Settings.

Parameters

Type Name Description Required Schema Default

BodyParameter

drmSettings

drmSettings

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmSettings

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm Settings not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Get All DRM Systems

GET /scrambling/v1/drm/systems

Description

Get all DRM systems.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Create DRM System

POST /scrambling/v1/drm/systems

Description

Create a DRM system for OTT encryption.

Parameters

Type Name Description Required Schema Default

BodyParameter

drmSystem

drmSystem

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Get DRM System

GET /scrambling/v1/drm/systems/{id}

Description

Get a DRM system.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Scrambling DRM

Update DRM System

PUT /scrambling/v1/drm/systems/{id}

Description

Update a DRM system.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

BodyParameter

drmSystem

drmSystem

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Delete DRM System

DELETE /scrambling/v1/drm/systems/{id}

Description

Delete a DRM system.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

View certificate

GET /scrambling/v1/drm/systems/{systemId}/certificateManager

Description

View certificate

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of Harmonic CPIX certificate

true

enum (harmonicCpixSignRequest, harmonicCpixCheckResponseSign, harmonicCpixDeliveryKey, harmonicCpixSignRequestEndUser)

harmonicCpixSignRequest

Responses

HTTP Code Description Schema

200

OK

string array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Add certificate and private key

POST /scrambling/v1/drm/systems/{systemId}/certificateManager

Description

Add certificate and private key.

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of certificate

true

enum (harmonicCpixSignRequest, harmonicCpixCheckResponseSign, harmonicCpixDeliveryKey, harmonicCpixSignRequestEndUser)

harmonicCpixSignRequest

QueryParameter

file type

Type of file containing certificate and private key

false

enum (pem)

pem

FormDataParameter

file

file

true

file

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Scrambling DRM

Delete Harmonic CPIX certificate and private key

DELETE /scrambling/v1/drm/systems/{systemId}/certificateManager

Description

Delete Harmonic CPIX certificate and private key.

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of Harmonic CPIX certificate

true

enum (harmonicCpixSignRequest, harmonicCpixCheckResponseSign, harmonicCpixDeliveryKey, harmonicCpixSignRequestEndUser)

harmonicCpixSignRequest

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Add Resource Id

POST /scrambling/v1/drm/systems/{systemId}/drmResource

Description

Add Resource Id

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

BodyParameter

drmResource

drmResource

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmResource

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Delete Resource Id

DELETE /scrambling/v1/drm/systems/{systemId}/drmResource/{drmResourceId}

Description

Delete Resource Id

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

PathParameter

drmResourceId

drmResourceId

true

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Get Harmonic CPIX certificate and private key

GET /scrambling/v1/drm/systems/{systemId}/harmonicCpixSignature

Description

(Deprecated) Get Harmonic CPIX certificate and private key.

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of Harmonic CPIX certificate

true

enum (request, response)

request

Responses

HTTP Code Description Schema

200

OK

string array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Add Harmonic CPIX certificate and private key

POST /scrambling/v1/drm/systems/{systemId}/harmonicCpixSignature

Description

(Deprecated) Add Harmonic CPIX certificate and private key.

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of Harmonic CPIX certificate

true

enum (request, response)

request

QueryParameter

file type

Type of file containing certificate and private key

false

enum (pem)

pem

FormDataParameter

file

file

true

file

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • Scrambling DRM

Delete Harmonic CPIX certificate and private key

DELETE /scrambling/v1/drm/systems/{systemId}/harmonicCpixSignature

Description

(Deprecated) Delete Harmonic CPIX certificate and private key.

Parameters

Type Name Description Required Schema Default

PathParameter

systemId

systemId

true

string

QueryParameter

type

Type of Harmonic CPIX certificate

true

enum (request, response)

request

Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Drm System not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Scrambling DRM

Get list of discovery

GET /source-monitor/v1/discover

Description

Get list of active source monitors.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.sourcemonitor.model.DiscoverySource array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Source

Scan stream information

POST /source-monitor/v1/discover

Description

Scan stream information.

Parameters

Type Name Description Required Schema Default

BodyParameter

discoverySource

discoverySource

true

com.harmonicinc.vos.app.sourcemonitor.model.DiscoverySource

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.sourcemonitor.model.DiscoverySource

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Source

Obtain source input model converted from discovery probe result

GET /source-monitor/v1/discover/source_input/{discoveryId}/proberesult

Description

Obtain source input model converted from discovery probe result.<br/><h1>THIS IS NOT SOURCE MEDIAINFO</h1>

Parameters

Type Name Description Required Schema Default

PathParameter

discoveryId

discoveryId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.configure.model.source.Source array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Discovery request not found

No Content

500

Error in source input model conversion

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Source

Cancel discovery

PUT /source-monitor/v1/discover/{discoveryId}/cancel

Description

Cancel a discovery request in progress.

Parameters

Type Name Description Required Schema Default

PathParameter

discoveryId

discoveryId

true

string

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Discovery request not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Monitor Source

Obtain discovery probe result

GET /source-monitor/v1/discover/{discoveryId}/proberesult

Description

Obtain discovery probe result.

Parameters

Type Name Description Required Schema Default

PathParameter

discoveryId

discoveryId

true

string

QueryParameter

includeAllTLVDescriptors

includeAllTLVDescriptors

false

boolean

false

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MediaInfoProbeResult array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Discovery request not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Source

Obtain discovery progress

GET /source-monitor/v1/discover/{discoveryId}/progress

Description

Obtain progress of discovery.

Parameters

Type Name Description Required Schema Default

PathParameter

discoveryId

discoveryId

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.sourcemonitor.model.DiscoveryProgress

401

Unauthorized

No Content

403

Forbidden

No Content

404

Discovery request not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Monitor Source

Get product infomation

GET /system/v1/info

Description

Get the information of product, including product name, product version, product period and credits

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.rumba.core.ProductInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • System

Get TestReceiver

GET /uplink-hub/v1/test-receiver

Description

List all TestReceiver.

Responses

HTTP Code Description Schema

200

OK

[java.util.CollectionOfcom.harmonicinc.vos.app.uplink.hub.benchmark.TestReceiver]

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

Create TestReceiver

POST /uplink-hub/v1/test-receiver

Description

Create new TestReceiver.

Responses

HTTP Code Description Schema

200

TestReceiver Created

com.harmonicinc.vos.app.uplink.hub.benchmark.TestReceiver

201

Created

No Content

400

TestReceiver creation Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

Get TestReceiver by ID

GET /uplink-hub/v1/test-receiver/{id}

Description

Get a Uplink by specifying a uplink Id.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.benchmark.TestReceiver

401

Unauthorized

No Content

403

Forbidden

No Content

404

No such TestReceiver ID found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

Delete TestReceiver

DELETE /uplink-hub/v1/test-receiver/{id}

Description

Delete TestReceiver with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a TestReceiver

true

string

Responses

HTTP Code Description Schema

200

TestReceiver Deleted

No Content

204

No Content

No Content

400

Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

TestReceiver with such id not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

Get uplinkGroups

GET /uplink-hub/v1/uplinkGroups

Description

List all uplink groups.

Parameters

Type Name Description Required Schema Default

QueryParameter

uplinkid

uplinkid

false

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkGroup array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

GET /uplink-hub/v1/uplinks

Description

List all CloudLinks.

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.Uplink array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

POST /uplink-hub/v1/uplinks

Description

Create new uplink.

Parameters

Type Name Description Required Schema Default

BodyParameter

param0

param0

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkRequest

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.Uplink

201

Uplink Created

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.Uplink

400

Uplink Creation Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

GET /uplink-hub/v1/uplinks/{id}

Description

Get a Uplink by specifying a uplink Id.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.Uplink

401

Unauthorized

No Content

403

Forbidden

No Content

404

No such Uplink ID found in Uplink Hub

No Content

410

Uplink removed recently by ID found in Uplink Hub

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

POST /uplink-hub/v1/uplinks/{id}

Description

Delete uplink with {id}. from deleted uplinks data holder

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a uplink

true

string

Responses

HTTP Code Description Schema

200

Uplink Deleted from temp data holder

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.Uplink

201

Created

No Content

400

No such id in deleted uplinks data holder

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

DELETE /uplink-hub/v1/uplinks/{id}

Description

Delete uplink with {id}.

Parameters

Type Name Description Required Schema Default

PathParameter

id

Unique identifier of a uplink

true

string

QueryParameter

force

force

false

boolean

Responses

HTTP Code Description Schema

200

Uplink Deleted

No Content

204

No Content

No Content

400

Deletion Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

GET /uplink-hub/v1/uplinks/{id}/uplinkChannels

Description

Query a list of UplinkChannel (active streaming channel) of a uplink.

Parameters

Type Name Description Required Schema Default

PathParameter

id

id

true

string

Responses

HTTP Code Description Schema

200

OK

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkChannel array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • Uplink Hub

POST /uplink-hub/v1/uplinks/{id}/uplinkStatus

Description

Update the status of Uplink.

Parameters

Type Name Description Required Schema Default

BodyParameter

param0

param0

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatus

PathParameter

id

Unique identifier of a uplink

true

string

Responses

HTTP Code Description Schema

200

Uplink Status updated

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatus

201

Created

No Content

400

Update Failed

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • Uplink Hub

Definitions

com.harmonicinc.externalassetpotf.model.rest.settings.ContainerResourceConfig

Name Description Required Schema Default

cpu

Number of CPU cores or units of virtual CPU

false

number (double)

cpuLimitRatio

Ratio of CPU usage limit to allocated amount

false

number (double)

mallocArenaMax

Number of malloc arena for C/C++ application inside container

false

integer (int32)

memInMB

Memory in MiB, this value should include the size of cache if memory-backed cache is enabled

false

number (double)

com.harmonicinc.externalassetpotf.model.rest.settings.ExternalAssetPotfSettings

Name Description Required Schema Default

chblBalanceFactor

false

number (float)

loadBalancingMode

false

enum (ROUND_ROBIN, CONSISTENT_HASHING_WITH_BOUNDED_LOAD)

resourceConfig

Explicit resource config for potf server, set to null for automatic

false

com.harmonicinc.externalassetpotf.model.rest.settings.ContainerResourceConfig

scalingConfig

false

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig

Name Description Required Schema Default

ignoreNodeCountLimit

false

boolean

kedaAutoscaler

false

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig$KedaAutoscalerConfig

maxNumServers

false

integer (int32)

minNumServers

false

integer (int32)

mode

false

enum (MANUAL, KEDA)

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig$KedaAutoscalerConfig

Name Description Required Schema Default

responseTimeThresholdForFullScaleUp

false

number (double)

scaleDownPolicy

false

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig$KedaScalePolicy

scaleDownStabilizationWindowSeconds

false

integer (int32)

targetCpuPercent

false

integer (int32)

targetRequestRate

false

integer (int32)

targetThroughputMbps

false

integer (int32)

com.harmonicinc.externalassetpotf.model.rest.settings.PotfServerScalingConfig$KedaScalePolicy

Name Description Required Schema Default

periodSeconds

The amount of time in seconds for which the rule should hold true

true

integer (int32)

type

Allowed changed in terms of absolute number of pods or percentage of current replicas

true

enum (PODS, PERCENT)

value

No. of pods or percentage of existing replicas to scale down each time

true

integer (int32)

com.harmonicinc.externalottrepackager.model.rest.drm.Drm

Name Description Required Schema Default

enableDrm

Specify to enable encryption for package defined with DrmSettings

true

boolean

perPackageDrmSettingsList

Specify DRM setting per package. Encryption will be disabled for package without specifying with DrmSettings

false

com.harmonicinc.externalottrepackager.model.rest.drm.DrmSettings array

com.harmonicinc.externalottrepackager.model.rest.drm.DrmSettings

Name Description Required Schema Default

drmSystemId

DRM system ID, which is defined in Scrambling App. Encryption will be disabled if null or empty drmSystemId is specified, or drmSystemId does not exist in Scrambling App

false

string

packageName

Package name defined in destination profile

true

string

com.harmonicinc.externalottrepackager.model.rest.profile.PackagingProfile

Name Description Required Schema Default

cacheMaxAge

The max-age value for HTTP cache control header - maximum amount of time in seconds content should be cached

true

integer (int32)

destinationProfileId

Labwizard profile ID which refers to destination profile defining packaging properties

true

string

drm

Specify DRM settings

false

com.harmonicinc.externalottrepackager.model.rest.drm.Drm

com.harmonicinc.externalottrepackager.model.rest.profile.PackagingProfileWithPolicy

Name Description Required Schema Default

cacheMaxAge

The max-age value for HTTP cache control header - maximum amount of time in seconds content should be cached

true

integer (int32)

destinationProfileId

Labwizard profile ID which refers to destination profile defining packaging properties

true

string

drm

Specify DRM settings

false

com.harmonicinc.externalottrepackager.model.rest.drm.Drm

vodPolicy

For debug purpose

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.VodPolicyProperties

com.harmonicinc.externalottrepackager.model.rest.repackage.RepackageProperties

Name Description Required Schema Default

cmafPackageName

false

string

hlsPackageName

false

string

hostName

hostname for repackaging service

true

string

mmpProfile

MMP profile name

false

string

sourceFileName

false

string

sourceUrlPrefix

url prefix for external asset

true

string

com.harmonicinc.externalottrepackager.model.rest.settings.ContainerResourceConfig

Name Description Required Schema Default

cpu

Number of CPU cores or units of virtual CPU

false

number (double)

mallocArenaMax

Number of malloc arena for C/C++ application inside container

false

integer (int32)

memInMB

Memory in MiB, this value should include the size of cache if memory-backed cache is enabled

false

number (double)

com.harmonicinc.externalottrepackager.model.rest.settings.ExternalOttRepackagerSettings

Name Description Required Schema Default

resourceConfig

Explicit resource config for potf server, set to null for automatic

false

com.harmonicinc.externalottrepackager.model.rest.settings.ContainerResourceConfig

scalingConfig

false

com.harmonicinc.externalottrepackager.model.rest.settings.PotfServerScalingConfig

com.harmonicinc.externalottrepackager.model.rest.settings.PotfServerScalingConfig

Name Description Required Schema Default

ignoreNodeCountLimit

false

boolean

kedaAutoscaler

false

com.harmonicinc.externalottrepackager.model.rest.settings.PotfServerScalingConfig$KedaAutoscalerConfig

maxNumServers

false

integer (int32)

minNumServers

false

integer (int32)

mode

false

enum (MANUAL, KEDA)

com.harmonicinc.externalottrepackager.model.rest.settings.PotfServerScalingConfig$KedaAutoscalerConfig

Name Description Required Schema Default

scaleDownStabilizationWindowSeconds

false

integer (int32)

targetCpuPercent

false

integer (int32)

targetThroughputMbps

false

integer (int32)

com.harmonicinc.potfserver.configlib.datamodel.rest.PackageInfo

Name Description Required Schema Default

format

Packaging format

false

enum (HLS, DASH, SS, CMAF, TS, THUMBNAIL)

name

Package publishing name

false

string

playbackUrl

URL for packaging output

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.AccessStorageEvent

Name Description Required Schema Default

canAccess

false

boolean

isAccessFailTimeout

false

boolean

path

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.AppleCpixEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.Arib37ProcessingProperties

Name Description Required Schema Default

selectedArib37

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedArib37 array

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioStreamSelection

Name Description Required Schema Default

audioCodecSelection

false

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, ALL)

bitrateRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.BitrateRange_

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioTrackConfig

Name Description Required Schema Default

isDefault

false

boolean

streamId

false

string

streamName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.BitrateRange

Name Description Required Schema Default

esBitrateRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EsBitrateRange

tsBitrateRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsBitrateRange

com.harmonicinc.potfserver.configlib.mediastreamproperties.BitrateRange_

Name Description Required Schema Default

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.CMAFStreamingPackageList

Name Description Required Schema Default

audioTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioTrackConfig array

dashAnnotationType

false

string

dashInsertAudioRole

false

boolean

dashInsertCustomStreamName

false

boolean

decodeTimeShiftToPlayTime

false

boolean

displayHResolutionRounding

false

enum (TO_FLOOR, TO_CLOSEST_EVEN)

displayHdcpLevelAttribute

false

boolean

dvrWindowLength

false

integer (int32)

enableExtXGapTag

false

boolean

encryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionProperties

hlsAnnotationType

false

string

hlsGroupingProfileJson

false

string

hlsInsertCustomStreamName

false

boolean

insertAudioChannels

false

boolean

insertDefaultKIDToManifest

false

boolean

insertParAndSarAttributesInMpd

false

boolean

isEnabled

false

boolean

keyRotationSignalling

false

enum (MANIFEST_BASED_SINGLE_PERIOD, IN_BAND)

masterPlaylistName

false

string

minBufferTimeInMs

false

integer (int32)

packagePublishingName

false

string

retentionPeriod

false

integer (int32)

retentionPeriodFromLive

false

integer (int32)

scte35AnnotationTag

false

string

scte35CreateNewPeriodForNbcOverlayPlacement

false

boolean

scte35DaterangeTagsInMs

false

boolean

scte35DefaultAutoReturnDuration

false

integer (int32)

scte35GenericConfig

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte35GenericConfig

scte35SegmentationMode

false

string

segmentFileExtension

false

string

segmentLengthInMs

false

integer (int32)

subtitleTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SubtitleTrackConfig array

suggestedPresentationDelayInMSec

false

integer (int32)

suggestedPresentationDelayMode

false

enum (DISABLE, AUTO, MANUAL)

com.harmonicinc.potfserver.configlib.mediastreamproperties.CacheControlConfig

Name Description Required Schema Default

vodMaxAge

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.ChannelIndexingProperties

Name Description Required Schema Default

indexingList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.IndexingList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.ChannelIngestMediaProperties

Name Description Required Schema Default

ingestMediaList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.IngestMediaList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.ChannelIngestProperties

Name Description Required Schema Default

objectId

false

string

udpSourceGroupList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceGroupList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.ChannelProperties

Name Description Required Schema Default

channelDisplayName

false

string

channelPublishingInputProfileId

false

string

channelPublishingName

false

string

channelPublishingOutputPropertyId

false

string

objectId

false

string

opaqueDataList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.OpaqueDataList array

propertiesVersion

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ChannelStreamPackageProperties

Name Description Required Schema Default

cmafstreamingPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.CMAFStreamingPackageList array

httpLiveStreamingPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingPackageList array

mpegDASHStreamingPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.MpegDASHStreamingPackageList array

smoothStreamingPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingPackageList array

thumbnailPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ThumbnailPackageList array

tsStreamingPackageList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsStreamingPackageList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties

Name Description Required Schema Default

closedCaptionProcessingType

false

enum (CLOSED_CAPTION_PROCESSING_TYPE_NONE, CLOSED_CAPTION_PROCESSING_TYPE_608_708_TO_TTML, CLOSED_CAPTION_PROCESSING_TYPE_608_708_TO_WEBVTT, CLOSED_CAPTION_PROCESSING_TYPE_608_708_TO_IMSC_1, CLOSED_CAPTION_PROCESSING_TYPE_608_708_PASSTHROUGH)

fontColor

false

string

fontSize

false

string

fontStyleBold

false

boolean

fontStyleItalic

false

boolean

selectedCaption

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedCaption array

ttmlTemplate

false

string

ttmlTextRegionId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ComcastSCTE35ProcessingProperties

Name Description Required Schema Default

acquisitionPointIdentity

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.CustomHeader

Name Description Required Schema Default

fieldName

false

string

fieldValue

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.CustomHeader_

Name Description Required Schema Default

fieldName

false

string

fieldValue

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.DefaultDrmSetting

Name Description Required Schema Default

appendResourceIdPerAsset

false

boolean

enableDrm

false

boolean

perPackageDrmSystemIdList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageDrmSystemIdList array

perPackageDrmTrackFilterList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageDrmTrackFilterList array

perPackageResourceIdList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageResourceIdList array

resourceId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmGroup

Name Description Required Schema Default

drms

false

string array

id

false

string

name

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmSystemList

Name Description Required Schema Default

cpixVersion

false

enum (e_2_2, e_2_3)

customHeader

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.CustomHeader_

drmGroups

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmGroup array

encryptionInterfaceType

false

enum (HKMS_MIN, HKMS_FULL, WIDEVINE, KSM_CPIX, INTERNAL, FIXED_KEY, VERIMATRIX_CPIX, APPLE_CPIX, HKMS_CPIX)

enforceKeyEncryptionValidation

false

boolean

id

false

string

insertContentKeyPeriodIndex

false

boolean

insertDeliveryKeyCertificate

false

boolean

insertDrmSystemIdInRequest

false

boolean

keyManagementServers

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.KeyManagemantServers array

kmsRequestHlsTsCommonEncryptionScheme

false

enum (NONE, CBC1, CBCS)

name

false

string

requestorId

false

string

useProxy

false

boolean

widevineConfig

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.WidevineConfig

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterList

Name Description Required Schema Default

drmTrackFilterProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterProperty array

id

false

string

name

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterProfileProperties

Name Description Required Schema Default

drmTrackFilterList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterProperty

Name Description Required Schema Default

audioStreamSelections

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioStreamSelection array

clearOutput

false

boolean

name

false

string

trackType

false

string

videoStreamSelections

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.VideoStreamSelection array

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties

Name Description Required Schema Default

dvbSubtitleProcessingType

false

enum (DVB_SUBTITLE_PROCESSING_TYPE_NONE, DVB_SUBTITLE_PROCESSING_TYPE_TO_SMPTE_TT, DVB_SUBTITLE_PROCESSING_TYPE_TO_SMPTE_TT_AND_PASSTHRU, DVB_SUBTITLE_PROCESSING_TYPE_TO_WEBVTT_OCR, DVB_SUBTITLE_PROCESSING_TYPE_PASSTHRU, DVB_SUBTITLE_PROCESSING_TYPE_TO_SMPTE_TT_TEXT_OCR)

selectedDvbSubtitle

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedDvbSubtitle array

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbTtmlProcessingProperties

Name Description Required Schema Default

dvbTtmlProcessingType

false

enum (DVB_TTML_PROCESSING_TYPE_NONE, DVB_TTML_PROCESSING_TYPE_TO_SMPTE_TT, DVB_TTML_PROCESSING_TYPE_TO_WEBVTT)

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionProperties

Name Description Required Schema Default

appleCpixEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AppleCpixEncryptionProperties

commonEncryptionScheme

false

enum (CENC_CENC, CENC_CBC1, CENC_CENS, CENC_CBCS)

enableKeyRotation

false

boolean

enablePackageBasedKeyRotation

false

boolean

encryptSEI

false

boolean

encryptionMode

false

enum (ENCRYPTION_MODE_HKMS, ENCRYPTION_MODE_INTERNAL_KEY_GENERATION, ENCRYPTION_MODE_SECURE_MEDIA, ENCRYPTION_MODE_WIDEVINE, ENCRYPTION_MODE_PHLS, ENCRYPTION_MODE_ADOBE_ACCESS, ENCRYPTION_MODE_VERIMATRIX_CPIX, ENCRYPTION_MODE_APPLE_CPIX, ENCRYPTION_MODE_HARMONIC_CPIX, ENCRYPTION_MODE_KSM_CPIX)

encryptionSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionSetting

getKeyFailureMode

false

enum (GET_KEY_FAILURE_MODE_CLEAR_CONTENT, GET_KEY_FAILURE_MODE_STOP)

harmonicCpixEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HarmonicCpixEncryptionProperties

hkmsEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HkmsEncryptionProperties

hlsEncryptionMode

false

enum (NATIVE, AUTHEN_TEC_PLAY_READY, IRDETO, DISCRETIX_PLAY_READY, NATIVE_SAMPLE_BASED, COMMON, FAIRPLAY, ADOBE)

insertDrmSystemIdInRequest

false

boolean

isEnabled

false

boolean

ivSize

false

enum (IV_8_BYTES, IV_16_BYTES)

keyChangePeriod

false

integer (int32)

ksmCpixEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.KsmCpixEncryptionProperties

scramblingDrmSystemId

false

string

secureMediaEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SecureMediaEncryptionProperties

verimatrixCpixEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.VerimatrixCpixEncryptionProperties

widevineEncryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.WidevineEncryptionProperties

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionSetting

Name Description Required Schema Default

encryptionDisplayName

false

string

encryptionTemplateId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ErrorEvent

Name Description Required Schema Default

errCode

false

string

errMessage

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.EsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.EsamSCTE35ProcessingProperties

Name Description Required Schema Default

acquisitionPointIdentity

false

string

poisUrl

false

string

preferedNetworkInterface

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SourceNetworkInterface

sparseTrackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.EventProperties

Name Description Required Schema Default

accessStorageEvent

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AccessStorageEvent

errorEvent

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ErrorEvent

com.harmonicinc.potfserver.configlib.mediastreamproperties.FrameRateRange

Name Description Required Schema Default

maxFrameRate

false

integer (int32)

minFrameRate

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.GenericSCTE35ProcessingProperties

Name Description Required Schema Default

annotateOnSpliceInsertEvent

false

boolean

annotateOnTimeSignalEvent

false

boolean

segmentationUPIDType

false

string

specifySegmentationUPIDType

false

boolean

com.harmonicinc.potfserver.configlib.mediastreamproperties.GhostPidList

Name Description Required Schema Default

isSCTE35

false

boolean

pid

false

integer (int32)

programNumber

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.HarmonicCpixEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

cencDashHarmonicDrmSystemList

false

enum (MICROSOFT_PLAYREADY, GOOGLE_WIDEVINE, MARLIN, CLEAR_KEY_DASH_IF, CLEAR_KEY_AES_128, CLEAR_KEY_SAMPLE_AES) array

cencHlsHarmonicDrmSystemList

false

enum (MICROSOFT_PLAYREADY, GOOGLE_WIDEVINE, APPLE_FAIRPLAY, MARLIN, CLEAR_KEY_DASH_IF, CLEAR_KEY_AES_128, CLEAR_KEY_SAMPLE_AES) array

cpixVersion

false

enum (e_2_2, e_2_3)

customHeader

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.CustomHeader

drmTrackFilterProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmTrackFilterProperty array

enforceKeyEncryptionValidation

false

boolean

insertContentKeyPeriodIndex

false

boolean

insertDeliveryKeyCertificate

false

boolean

keyRotationSettings

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.KeyRotationSettings

kmsRequestHlsTsCommonEncryptionScheme

false

enum (NONE, CBC1, CBCS)

proxyEndpointConfig

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ProxyEndpointConfig

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.HkmsEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

customHeader

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.CustomHeader

hkmsinterfaceVersion

false

enum (HKMS_INTERFACE_VERSION_V_1_0_MIN, HKMS_INTERFACE_VERSION_V_1_0_FULL)

isFixedKey

false

boolean

requestorId

false

string

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.HorizontalResolutionRange

Name Description Required Schema Default

maxHorizontalResolution

false

integer (int32)

minHorizontalResolution

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingPackageList

Name Description Required Schema Default

addCodecsAtStreamInf

false

boolean

arib37ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Arib37ProcessingProperties

arib37ProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Arib37ProcessingProperties array

audioTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioTrackConfig array

bandwidthBasedOnEsBitrate

false

boolean

chunkDurationInMillisecond

false

integer (int32)

closedCaptionProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties

closedCaptionProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties array

decodeTimeShiftToPlayTime

false

boolean

directoryPrefixNameForStreams

false

string

displayHResolutionRounding

false

enum (TO_FLOOR, TO_CLOSEST_EVEN)

displayHdcpLevelAttribute

false

boolean

dropSgpdBox

false

boolean

dvbSubtitleProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties

dvbSubtitleProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties array

dvbTtmlProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbTtmlProcessingProperties

dvbTtmlProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbTtmlProcessingProperties array

dvrWindowLength

false

integer (int32)

enableAudioOnlyStream

false

boolean

enableAverageBandwidthAttribute

false

boolean

enableCcDeclaration

false

boolean

enableChunkedCMAF

false

boolean

enableChunkedEncoding

false

boolean

enableDiscreteIframeSegEnc

false

boolean

enableExtXGapTag

false

boolean

enableLegacySpliceInsertHandle

false

boolean

enablePlaylistTypeEventTag

false

boolean

enableWebVttSourcePositioning

false

boolean

enableWebVttStyling

false

boolean

encryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionProperties

fakeSegmentationType

false

integer (int32)

filePrefixNameForStreamSegment

false

string

filePrefixNameForStreamSegmentForFlatternedMode

false

string

firstSegmentProgramDateTime

false

boolean

floatingPointDuration

false

boolean

fromliveAbsoluteBaseURL

false

string

generateIFrameOnlyPlaylist

false

boolean

hlsGroupingProfileJson

false

string

httpLiveStreamingPackageSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingPackageSetting

httpLiveStreamingSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingSCTE35ProcessingProperties

iframeCodecs

false

enum (VIDEO, MJPG) array

iframeDiscreteSegmentInterval

false

enum (PER_SEGMENT, PER_IDR)

iframeEnableInitSection

false

boolean

indexPlaylistName

false

string

indexPlaylistNameForFlatternedMode

false

string

inputStreamSelectionProfileJson

false

string

insertAudioChannels

false

boolean

insertCustomStreamName

false

boolean

isEnabled

false

boolean

isTrimNullPacket

false

boolean

isoLanguageCode

false

enum (ISO_639_1, ISO_639_2_3)

lastModificationLinuxTimeInMs

false

string

masterPlaylistName

false

string

nameAttribute

false

enum (DEFAULT, IN_ENGLISH, IN_NATIVE)

noExtXKeyTagForUnencryptedStreams

false

boolean

optimizeForBandwidth

false

boolean

packageId

false

string

packagePublishingName

false

string

packageSplicingOptions

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PackageSplicingOptions

passthruSPSPPS

false

boolean

playlistCustomTag

false

string

preemptiveVideoIndex

false

integer (int32)

preferredAudioSrc

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PreferredAudioSrc

preferredSrc

false

string

profileHash

false

string

retentionPeriod

false

integer (int32)

retentionPeriodFromLive

false

integer (int32)

richSegmentURIInfo

false

boolean

scte27ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties

scte27ProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties array

scte35AnnotationTag

false

string

scte35DaterangeTagsInMs

false

boolean

scte35DefaultAutoReturnDuration

false

integer (int32)

scte35EnableContentIdHandling

false

boolean

scte35GoogleHlsVodAnnotationType

false

enum (NONE, PLACEMENT_OPPORTUNITY)

scte35Signaling

false

string

segmentDurationFromLive

false

integer (int32)

segmentLength

false

integer (int32)

segmentLengthInMs

false

integer (int32)

srtStlProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SrtStlProcessingProperties

streamBitrateOrder

false

enum (ASCENDING_ORDER, DESCENDING_ORDER, ASCENDING_ORDER_WITH_PREEMPTIVE_VIDEO, DESCENDING_ORDER_WITH_PREEMPTIVE_VIDEO)

subtitleTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SubtitleTrackConfig array

targetDeviceProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceProperties

targetDuration

false

integer (int32)

teletextProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties

teletextProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties array

useByteRange

false

boolean

useCmaf

false

boolean

variantPlaylistName

false

string

version

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingPackageSetting

Name Description Required Schema Default

eventSourceName

false

string

objectId

false

string

packageLabel

false

string

packageTemplateId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.HttpLiveStreamingSCTE35ProcessingProperties

Name Description Required Schema Default

esamSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EsamSCTE35ProcessingProperties

genericSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.GenericSCTE35ProcessingProperties

scte35ProcessingType

false

enum (SCTE_35_PROCESSING_TYPE_NONE, SCTE_35_PROCESSING_TYPE_ESAM, SCTE_35_PROCESSING_TYPE_GENERIC)

com.harmonicinc.potfserver.configlib.mediastreamproperties.IndexingList

Name Description Required Schema Default

rootIndexParam

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.RootIndexParam

tsIndexerList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsIndexerList array

udpSourceGroupId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.IngestMediaList

Name Description Required Schema Default

ghostPidList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.GhostPidList array

mediaInfoList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.MediaInfoList array

udpSourceGroupId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.KeyManagemantServers

Name Description Required Schema Default

httpsCertValidation

false

boolean

rank

false

integer (int32)

url

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.KeyRotationSettings

Name Description Required Schema Default

controller

false

enum (KMS, VOS)

mode

false

enum (INDEX, START_END)

numberOfKeyPeriods

false

integer (int32)

preFetchRequestRelativeTime

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.KsmCpixEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.MediaInfoList

Name Description Required Schema Default

bitrate

false

integer (int32)

hasNielsenInfo

false

boolean

language

false

string

nielsenOutputPid

false

integer (int32)

pid

false

integer (int32)

teletextPageInfoList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextPageInfoList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.MpegDASHStreamingPackageList

Name Description Required Schema Default

adaptationSetIdPattern

false

string

audioTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.AudioTrackConfig array

chunkDurationInMillisecond

false

integer (int32)

closedCaptionProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties

closedCaptionProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties array

decodetimeShiftToPlaytime

false

boolean

disableHdrEssentialProperty

false

boolean

dvbSubtitleProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties

dvbSubtitleProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties array

dvbTtmlProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbTtmlProcessingProperties

dvbTtmlProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbTtmlProcessingProperties array

dvrWindowLength

false

integer (int32)

enableAMSPlayerBehavior

false

boolean

enableChunkedCMAF

false

boolean

enableChunkedEncoding

false

boolean

enableFillGapNearPeriodStart

false

boolean

enableTimeStampRef

false

boolean

enableWebVttSourcePositioning

false

boolean

enableWebVttStyling

false

boolean

encryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionProperties

firstCodecGroupInManifest

false

enum (HEVC, AVC)

forceNonNegativeCto

false

boolean

forcePTOZero

false

boolean

forceZeroBasePtsMapping

false

boolean

imageSpriteInColumn

false

integer (int32)

imageSpriteInRow

false

integer (int32)

inputStreamSelectionProfileJson

false

string

insertAdaptationSetId

false

boolean

insertAudioRole

false

boolean

insertContentType

false

boolean

insertDefaultKIDToManifest

false

boolean

insertLabelElement

false

boolean

insertParAndSarAttributesInMpd

false

boolean

insertPrftToTimeshiftManifest

false

boolean

isEnableThumbnailGeneration

false

boolean

isEnabled

false

boolean

keyRotationSignalling

false

enum (MANIFEST_BASED_SINGLE_PERIOD, IN_BAND)

lastModificationLinuxTimeInMs

false

string

manifestName

false

string

maxSegmentDurationSignaling

false

enum (SIGNALING_NONE, SIGNALING_STANDARD)

minBufferTimeInMs

false

integer (int32)

minimumUpdatePeriod

false

integer (int32)

mpdAccessibilityComplianceMode

false

enum (DVB_DASH, DASH_IF, BYTEL)

mpdprofile

false

enum (ISO_LIVE, HBBTV_ISOBMFF_LIVE, DVB_DASH_LIVE, ATSC3_LIVE)

mpegDASHStreamingPackageSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.MpegDASHStreamingPackageSetting

packageId

false

string

packagePublishingName

false

string

packageSplicingOptions

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PackageSplicingOptions

passthruSPSPPS

false

boolean

playTimeStartFromZero

false

boolean

profileHash

false

string

retentionPeriod

false

integer (int32)

retentionPeriodFromLive

false

integer (int32)

scte27ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties

scte27ProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties array

scte35CreateNewPeriodForNbcOverlayPlacement

false

boolean

scte35DefaultAutoReturnDuration

false

integer (int32)

scte35EnableContentIdHandling

false

boolean

scte35GenericConfig

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte35GenericConfig

scte35Signaling

false

string

segmentDurationFromLive

false

integer (int32)

segmentLength

false

integer (int32)

segmentLengthInMs

false

integer (int32)

srtStlProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SrtStlProcessingProperties

subtitleTrackConfigs

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SubtitleTrackConfig array

suggestedPresentationDelayInMSec

false

integer (int32)

suggestedPresentationDelayMode

false

enum (DISABLE, AUTO, MANUAL)

targetDeviceProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceProperties

teletextProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties

teletextProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties array

thumbnailHeight

false

integer (int32)

timeStampRef

false

string

timeZone

false

object

usePtsAsPto

false

boolean

utcTimingSchemeIdUri

false

enum (NONE, HTTP_XSDATE, HTTP_ISO, HTTP_NTP, NTP, HTTP_HEAD)

utcTimingValue

false

string

videoAdaptationSetGrouping

false

enum (BY_CODEC) array

com.harmonicinc.potfserver.configlib.mediastreamproperties.MpegDASHStreamingPackageSetting

Name Description Required Schema Default

eventSourceName

false

string

objectId

false

string

packageLabel

false

string

packageTemplateId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.OpaqueDataList

Name Description Required Schema Default

key

false

string

value

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.PackageSplicingOptions

Name Description Required Schema Default

scte35Pid

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageDrmSystemIdList

Name Description Required Schema Default

drmSystemId

false

string

publishName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageDrmTrackFilterList

Name Description Required Schema Default

drmTrackFilter

false

string

publishName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.PerPackageResourceIdList

Name Description Required Schema Default

publishName

false

string

resourceId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.PreferredAudioSrc

Name Description Required Schema Default

id

false

integer (int32)

udpSourceGroupId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.Profile2PolicyMap

Name Description Required Schema Default

policyId

false

string

profileId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ProxyEndpoint

Name Description Required Schema Default

address

false

object

port

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.ProxyEndpointConfig

Name Description Required Schema Default

address

false

object

port

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.RootIndexParam

Name Description Required Schema Default

assetIndexStorageMountPoint

false

string

assetMediaStorageMountPoint

false

string

assetType

false

enum (ASSET_TYPE_LIVE, ASSET_TYPE_LIVE_EVENT, ASSET_TYPE_FROMLIVE, ASSET_TYPE_VOD, ASSET_TYPE_LLCU)

rootLocation

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ScramblingDrmSettings

Name Description Required Schema Default

enableCmafKeyRotation

false

boolean

enableDashKeyRotation

false

boolean

enableHlsKeyRotation

false

boolean

enableKeyRotation

false

boolean

enableSsKeyRotation

false

boolean

keyRotationPeriod

false

integer (int32)

proxyEndpoint

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ProxyEndpoint

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties

Name Description Required Schema Default

scte27ProcessingType

false

enum (SCTE_27_PROCESSING_TYPE_NONE, SCTE_27_PROCESSING_TYPE_TO_SMPTE_TT, SCTE_27_PROCESSING_TYPE_TO_WEBVTT_OCR, SCTE_27_PROCESSING_TYPE_TO_SMPTE_TT_TEXT_OCR)

selectedScte27

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedScte27 array

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte35GenericConfig

Name Description Required Schema Default

periodTimingSpecification

false

string array

scte35Carriage

false

string array

com.harmonicinc.potfserver.configlib.mediastreamproperties.SecureMediaEncryptionProperties

Name Description Required Schema Default

contentId

false

string

contentIdGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedArib37

Name Description Required Schema Default

pid

false

integer (int32)

streamName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedCaption

Name Description Required Schema Default

closedCaptionService

false

enum (CEA_608_CHANNEL_1, CEA_608_CHANNEL_2, CEA_608_CHANNEL_3, CEA_608_CHANNEL_4, CEA_708_SERVICE_1, CEA_708_SERVICE_2, CEA_708_SERVICE_3, CEA_708_SERVICE_4, CEA_708_SERVICE_5, CEA_708_SERVICE_6, CEA_708_SERVICE_7, CEA_708_SERVICE_8, CEA_708_SERVICE_9, CEA_708_SERVICE_10, CEA_708_SERVICE_11, CEA_708_SERVICE_12, CEA_708_SERVICE_13, CEA_708_SERVICE_14, CEA_708_SERVICE_15, CEA_708_SERVICE_16)

customStreamName

false

string

isDefault

false

boolean

language

false

string

trackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedDvbSubtitle

Name Description Required Schema Default

pid

false

integer (int32)

streamName

false

string

trackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedScte27

Name Description Required Schema Default

pid

false

integer (int32)

streamName

false

string

trackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedSrtStl

Name Description Required Schema Default

streamName

false

string

trackId

false

integer (int32)

trackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedTeletext

Name Description Required Schema Default

language

false

string

pageId

false

integer (int32)

pid

false

integer (int32)

streamName

false

string

trackName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingPackageList

Name Description Required Schema Default

audioSegmentLength

false

integer (int32)

audioSegmentLengthInMs

false

integer (int32)

closedCaptionProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties

closedCaptionProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ClosedCaptionProcessingProperties array

dvbSubtitleProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties

dvbSubtitleProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DvbSubtitleProcessingProperties array

dvrWindowLength

false

integer (int32)

enableChunkedEncoding

false

boolean

enableHEVCCodec

false

boolean

enableTimeStampRef

false

boolean

encryptionProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EncryptionProperties

inputStreamSelectionProfileJson

false

string

isEnabled

false

boolean

languageCodeLetterCase

false

enum (STREAM_INDEX_LANGUAGE_CODE_ALL_CAPITALS, STREAM_INDEX_LANGUAGE_CODE_ALL_SMALL)

lastModificationLinuxTimeInMs

false

string

packageId

false

string

packagePublishingName

false

string

packageSplicingOptions

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.PackageSplicingOptions

passthruSPSPPS

false

boolean

profileHash

false

string

retentionPeriod

false

integer (int32)

retentionPeriodFromLive

false

integer (int32)

scte27ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties

scte27ProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Scte27ProcessingProperties array

scte35Signaling

false

string

segmentDurationFromLive

false

integer (int32)

smoothStreamingPackageSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingPackageSetting

smoothStreamingSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingSCTE35ProcessingProperties

srtStlProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SrtStlProcessingProperties

streamName

false

string

targetDeviceProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceProperties

teletextProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties

teletextProcessingPropertiesList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties array

timeStampRef

false

string

timeZone

false

object

useRepeatAttribute

false

boolean

videoSegmentLength

false

integer (int32)

videoSegmentLengthInMs

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingPackageSetting

Name Description Required Schema Default

eventSourceName

false

string

objectId

false

string

packageLabel

false

string

packageTemplateId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SmoothStreamingSCTE35ProcessingProperties

Name Description Required Schema Default

comcastSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ComcastSCTE35ProcessingProperties

esamSCTE35ProcessingProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.EsamSCTE35ProcessingProperties

scte35ProcessingType

false

enum (SCTE_35_PROCESSING_TYPE_NONE, SCTE_35_PROCESSING_TYPE_COMCAST, SCTE_35_PROCESSING_TYPE_ESAM)

com.harmonicinc.potfserver.configlib.mediastreamproperties.SourceNetworkInterface

Name Description Required Schema Default

interfaceAddress

false

string

interfaceIdentifier

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.SrtStlProcessingProperties

Name Description Required Schema Default

fontColor

false

string

fontSize

false

string

fontStyleBold

false

boolean

fontStyleItalic

false

boolean

selectedSrtStl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedSrtStl array

srtStlProcessingType

false

enum (SRT_STL_PROCESSING_TYPE_NONE, SRT_STL_PROCESSING_TYPE_TO_TTML, SRT_STL_PROCESSING_TYPE_TO_WEBVTT)

com.harmonicinc.potfserver.configlib.mediastreamproperties.SubtitleTrackConfig

Name Description Required Schema Default

isDefault

false

boolean

pageId

false

string

streamId

false

string

streamName

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceCodecProfile

Name Description Required Schema Default

audioCodec

false

enum (NONE, AAC, EAC_3)

isSpecifyMaxVideoBitrate

false

boolean

isSpecifyMaxVideoResolution

false

boolean

maxVideoBitrate

false

integer (int32)

maxVideoHeight

false

integer (int32)

maxVideoWidth

false

integer (int32)

videoCodec

false

enum (NONE, H_264)

videoEncodeLevel

false

enum (LEVEL_1_0, LEVEL_1_1, LEVEL_1_2, LEVEL_1_3, LEVEL_1_B, LEVEL_2_0, LEVEL_2_1, LEVEL_2_2, LEVEL_3_0, LEVEL_3_1, LEVEL_3_2, LEVEL_4_0, LEVEL_4_1, LEVEL_4_2, LEVEL_5_0, LEVEL_5_1) array

videoEncodeProfile

false

enum (BASELINE, EXTENDED, HIGH, HIGH_10, HIGH_4_2_2, HIGH_4_4_4, MAIN) array

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceProperties

Name Description Required Schema Default

isEnabled

false

boolean

targetDeviceCodecProfile

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceCodecProfile array

targetDeviceSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceSetting

com.harmonicinc.potfserver.configlib.mediastreamproperties.TargetDeviceSetting

Name Description Required Schema Default

displayName

false

string

templateId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextPageInfoList

Name Description Required Schema Default

language

false

string

pageNumber

false

integer (int32)

streamName

false

string

teletextType

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.TeletextProcessingProperties

Name Description Required Schema Default

fontColor

false

string

fontSize

false

string

fontStyleBold

false

boolean

fontStyleItalic

false

boolean

selectedTeletext

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SelectedTeletext array

teletextProcessingType

false

enum (TELETEXT_PROCESSING_TYPE_NONE, TELETEXT_PROCESSING_TYPE_TO_TTML, TELETEXT_PROCESSING_TYPE_TO_WEBVTT, TELETEXT_PROCESSING_TYPE_TO_IMSC_1, TELETEXT_PROCESSING_TYPE_PASSTHROUGH)

ttmlTemplate

false

string

ttmlTextRegionId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.ThumbnailPackageList

Name Description Required Schema Default

dvrWindowLength

false

integer (int32)

imageFormat

false

string

imageSpriteInColumn

false

integer (int32)

imageSpriteInRow

false

integer (int32)

isEnabled

false

boolean

packageId

false

string

packagePublishingName

false

string

retentionPeriod

false

integer (int32)

retentionPeriodFromLive

false

integer (int32)

segmentLength

false

integer (int32)

targetDuration

false

integer (int32)

thumbnailHeight

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsIndexerList

Name Description Required Schema Default

assetIndexStoragePrefix

false

string

assetMediaStoragePrefix

false

string

rootIndexParam

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.RootIndexParam

udpSourceGroupId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.TsStreamingPackageList

Name Description Required Schema Default

isEnabled

false

boolean

packageId

false

string

packagePublishingName

false

string

retentionPeriodFromLive

false

integer (int32)

segmentDurationFromLive

false

integer (int32)

segmentLength

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceGroupList

Name Description Required Schema Default

desiredSourceIndex

false

integer (int32)

failoverThreshold

false

integer (int32)

isEnabled

false

boolean

switchingMode

false

enum (SWITCHING_MODE_PRIMARY_ONLY, SWITCHING_MODE_AUTOMATIC_REVERT, SWITCHING_MODE_AUTOMATIC, SWITCHING_MODE_MANUAL, SWITCHING_MODE_MANUAL_REVERT)

udpSourceGroupId

false

string

udpSourceGroupSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceGroupSetting

udpSourceList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceList array

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceGroupSetting

Name Description Required Schema Default

eventSourceName

false

string

objectId

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceList

Name Description Required Schema Default

isSourceSSMEnabled

false

boolean

sourceAddress

false

string

sourceNetworkInterface

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SourceNetworkInterface

sourcePort

false

integer (int32)

sourceSSMAddressList

false

string array

udpSourceId

false

string

udpSourceSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceSetting

com.harmonicinc.potfserver.configlib.mediastreamproperties.UdpSourceSetting

Name Description Required Schema Default

eventSourceName

false

string

udpSourcelabel

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

Name Description Required Schema Default

certValidation

false

boolean

preferedNetworkInterface

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.SourceNetworkInterface

url

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.VerimatrixCpixEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

cencDrmSystemList

false

enum (VERIMATRIX_VCAS, MICROSOFT_PLAYREADY, GOOGLE_WIDEVINE, APPLE_FAIRPLAY) array

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.potfserver.configlib.mediastreamproperties.VerticalResolutionRange

Name Description Required Schema Default

maxVerticalResolution

false

integer (int32)

minVerticalResolution

false

integer (int32)

com.harmonicinc.potfserver.configlib.mediastreamproperties.VideoStreamSelection

Name Description Required Schema Default

bitrateRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.BitrateRange

frameRateRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.FrameRateRange

horizontalResolutionRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.HorizontalResolutionRange

verticalResolutionRange

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.VerticalResolutionRange

videoCodecSelection

false

enum (H_265, H_264, ALL)

com.harmonicinc.potfserver.configlib.mediastreamproperties.VodPolicyProperties

Name Description Required Schema Default

cacheControlConfig

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.CacheControlConfig

convertedFromProfileVersion

false

enum (VERSION_1, VERSION_2)

defaultDrmSetting

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DefaultDrmSetting

drmSystemList

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.DrmSystemList array

kmsSimulatorUrlList

false

string array

mediaStreamProperties

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.MediaStreamProperties

policyId

false

string

policyName

false

string

priority

false

integer (int32)

profile2PolicyMap

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Profile2PolicyMap array

propertiesVersion

false

string

scramblingDrmSettings

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.ScramblingDrmSettings

com.harmonicinc.potfserver.configlib.mediastreamproperties.WidevineConfig

Name Description Required Schema Default

signer

false

string

signingIv

false

string

signingKey

false

string

com.harmonicinc.potfserver.configlib.mediastreamproperties.WidevineEncryptionProperties

Name Description Required Schema Default

backupUrl

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

requestorId

false

string

resourceIdentifier

false

string

resourceIdentifierGenerationType

false

enum (USER_DEFINED, ASSET_PATH, ASSET_PATH_AND_PACKAGE_PROFILE_PUBLISHING_NAME)

signingIv

false

string

signingKey

false

string

url

false

com.harmonicinc.potfserver.configlib.mediastreamproperties.Url

com.harmonicinc.rumba.clientapp.rest.model.ClientAppCheckerConfig

Name Description Required Schema Default

checkingTimeIntervalInMinute

Define the time interval of checking if there are any disused client apps or client apps should be deactivated

true

integer (int32)

deactivatedThresholdInMinute

Define how long (in minutes) a client app is considered as deactivated from the last used time

true

integer (int32)

disusedThresholdInMinute

Define how long (in minutes) a client app is considered as disused from the last used time

true

integer (int32)

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsConfig

Name Description Required Schema Default

authorized_grant_types

Grant types ( by default: AUTHORIZATION_CODE, REFRESH_TOKEN )

false

enum (AUTHORIZATION_CODE, REFRESH_TOKEN, CLIENT_CREDENTIALS, IMPLICIT, PASSWORD) array

description

Description

false

string

redirect_uri

Redirect uri

true

string array

role

Role

false

string

com.harmonicinc.rumba.clientapp.rest.model.ClientDetailsResponse

Name Description Required Schema Default

activated

false

boolean

authorized_grant_types

false

enum (AUTHORIZATION_CODE, REFRESH_TOKEN, CLIENT_CREDENTIALS, IMPLICIT, PASSWORD) array

client_id

false

string

client_secret

false

string

createdBy

false

string

createdDate

false

string

description

false

string

lastModifiedBy

false

string

lastModifiedDate

false

string

lastUsedSourceIp

false

string

lastUsedTime

false

string

parent_id

false

string

redirect_uri

false

string array

role

false

string

com.harmonicinc.rumba.core.DeploymentEnvInfo

Name Description Required Schema Default

displayName

Display name of deployment environment

false

string

name

Name of deployment environment

false

string

version

Version of deployment template

false

string

com.harmonicinc.rumba.core.ProductInfo

Name Description Required Schema Default

bundleName

Name of VOS bundle

false

string

bundleVersion

Version of VOS bundle

false

string

credits

false

string array

deploymentEnv

Deployment environment info

false

com.harmonicinc.rumba.core.DeploymentEnvInfo

instanceName

Name of particular VOS instance

false

string

name

Formal name of product

true

string

period

false

string

release

User-friendly name of VOS release

true

string

sdkVersion

Version of VOS SDK

true

string

vos360Type

false

string

xosVersion

Version of XOS flex image

false

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.PreWarmScheduleResponse

Name Description Required Schema Default

hasNext

false

boolean

limit

false

integer (int32)

offset

false

integer (int32)

schedule

false

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmScheduleInternal

com.harmonicinc.unifiedoriginenginelibrary.datamodel.TestObjectInfo

Name Description Required Schema Default

files

List all files with their full path inside the ZIP. Empty directories are not listed

true

string array

lastUpdated

The time the test object is last uploaded

true

string (date-time)

totalSize

Sum of uncompressed size of all files

true

integer (int64)

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAsset

Name Description Required Schema Default

adminState

Control an asset is online (i.e. available for egress) or not. Default is ONLINE

false

enum (ONLINE, OFFLINE)

drmSetting

Encryption settings

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.DrmSetting

errorMessage

Message describing the reason if there is error

false

string

id

UUID will be generated if not specified

false

string

ingestEndTime

End time of the LLCU asset, with format yyyy-MM-ddTHH:mm:ss.SSSZ

true

string (date-time)

ingestPercentage

LLCU extraction progress in percentage unit

false

integer (int32)

ingestStartTime

Start time of the LLCU asset, with format yyyy-MM-ddTHH:mm:ss.SSSZ

true

string (date-time)

opState

Reflects the current state of the asset. CREATED if ingestStartTime is not reached; INGESTING if ingestStartTime is passed; INGESTED if asset is indexed; ERROR otherwise

false

enum (CREATED, INGESTING, INGESTED, DELETING, ERROR)

packages

Package related info

false

com.harmonicinc.potfserver.configlib.datamodel.rest.PackageInfo array

path

Storage path of LLCU asset

false

string

reindexSetting

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.ReindexSetting

sourceUri

Service ID. The service source which LLCU asset will be extracted from

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAssetBase

Name Description Required Schema Default

adminState

Control an asset is online (i.e. available for egress) or not. Default is ONLINE

false

enum (ONLINE, OFFLINE)

drmSetting

Encryption settings

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.DrmSetting

id

UUID will be generated if not specified

false

string

ingestEndTime

End time of the LLCU asset, with format yyyy-MM-ddTHH:mm:ss.SSSZ

true

string (date-time)

ingestStartTime

Start time of the LLCU asset, with format yyyy-MM-ddTHH:mm:ss.SSSZ

true

string (date-time)

sourceUri

Service ID. The service source which LLCU asset will be extracted from

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAssetList

Name Description Required Schema Default

llcuAssets

List of LLCU asset details

true

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.LlcuAsset array

queryId

For query the next page of asset list if value is specified

false

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.ReindexSetting

Name Description Required Schema Default

inputGrooming

The re-index setting if set before and asset is not yet re-indexed. After re-indexing, this setting becomes null if no new re-index setting is set

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.InputGrooming

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.DrmSetting

Name Description Required Schema Default

enableDrm

Enable / Disable encryption

true

boolean

perPackageDrmSystemIdList

Specify list of DRM System ID per package. For differentiate KMS endpoint for different packaging profiles

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageDrmSystemId array

perPackageDrmTrackFilterList

Specify list of DRM track filter per package. For assign different DRM track filter for different packages

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageDrmTrackFilter array

perPackageResourceIdList

Specify list of resource ID per package. For assign different resource ID for different packages

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageResourceId array

resourceId

Per asset encryption resource ID. Data-path will generate a random one if not specified or empty

false

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageDrmSystemId

Name Description Required Schema Default

drmSystemId

DRM system ID

true

string

publishName

Package publish name

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageDrmTrackFilter

Name Description Required Schema Default

drmTrackFilter

DRM track filter

true

string

publishName

Package publish name

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.drm.PerPackageResourceId

Name Description Required Schema Default

publishName

Package publish name

true

string

resourceId

Resource ID

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.AudioGrooming

Name Description Required Schema Default

tracks

Essential metadata of audio tracks

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.AudioTrack array

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.AudioTrack

Name Description Required Schema Default

isDefault

Indicate this audio is default

false

boolean

language

Audio track language

false

string

skipProcessing

Indicate this audio stream will not be processed and will not be mux.

false

boolean

streamName

Audio custom stream name

false

string

trackId

PID of the audio track

true

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.CaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number of caption service in the range [1..63] if digital_cc == 1. It has no meaning if digital_cc == 0

true

integer (int32)

defaultSubtitle

Whether or not the caption service stream is the stream for default subtitle

false

boolean

digitalCc

Digital CC of caption service: 0⇒608, 1⇒708

true

integer (int32)

language

ISO 639.2/B 3 character language code of caption service. It has no meaning if digital_cc == 0

true

string

streamName

Custom stream name to insert to HLS/DASH/CMAF manifest

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DataGrooming

Name Description Required Schema Default

ccConversionMode

Prefered Closed Caption type

false

enum (AUTO, EIA608, CEA708)

tracks

Essential metadata of data tracks

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DataTrack array

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DataTrack

Name Description Required Schema Default

captionServiceData

Grooming settings for caption service

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.CaptionServiceDescriptorData array

dataTrackStreamType

Type of the data stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types

false

integer (int32)

dvbSubtitlingData

Grooming settings for DVB subtitle

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DvbSubtitlingDescriptorData array

dvbTtmlData

Grooming settings for DVB TTML subtitle

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.ISO639DescriptorData array

pid

PID of the stream

false

integer (int32)

scte27SubtitlingData

Grooming settings for SCTE-27 subtitle

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.ISO639DescriptorData array

skipProcessing

Indicate this data stream will not be processed and will not be mux.

false

boolean

streamName

Custom stream name to insert to HLS/DASH/CMAF manifest

true

string

teletextData

Grooming settings for teletext

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.TeletextDescriptorData array

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DvbSubtitlingDescriptorData

Name Description Required Schema Default

defaultSubtitle

Whether or not the DVB data stream is the stream for default subtitle

false

boolean

language

Language code of data stream

true

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.ISO639DescriptorData

Name Description Required Schema Default

defaultSubtitle

false

boolean

language

false

string

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.InputGrooming

Name Description Required Schema Default

audioGrooming

Essential metadata of audio

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.AudioGrooming

dataGrooming

Essential metadata of data services

false

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.DataGrooming

com.harmonicinc.unifiedoriginenginelibrary.datamodel.rest.grooming.TeletextDescriptorData

Name Description Required Schema Default

defaultSubtitle

Whether or not the teletext stream is the stream for default subtitle

false

boolean

language

Language code of data stream

true

string

skipProcessing

false

boolean

streamName

Custom stream name to insert to HLS/DASH/CMAF manifest

true

string

teletextHexPageNum

Verbatim hexadecimal page number of teletext stream - should be used if not null

true

string

teletextMagazineNumber

Magazine number of teletext stream

true

integer (int32)

teletextType

Type of teletext

true

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig

Name Description Required Schema Default

enableNginxLogs

Set to true to use enable push of nginx access logs to Loki

true

boolean

grpdCompliance

Enable GRPD compliance for log aggregation

false

boolean

logEndpoint

The settings for log aggregation system endpoint

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogEndpoint

logPercentage

Log percentage for Nginx Access log to write to Loki

false

number (double)

logShipper

The settings for log shipper

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogShipper

logVolumeSizeInMB

The log volume size for RAM Disk in MB

false

number (double)

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogEndpoint

Name Description Required Schema Default

token

Token of log aggregation system endpoint

false

string

url

URL of log aggregation system endpoint

false

string

user

User of log aggregation system endpoint

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogShipper

Name Description Required Schema Default

resource

The resources for log shipper

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogShipperResource

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$LogShipperResource

Name Description Required Schema Default

cpu

Number of virtual CPU cores

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$ResourceValue

memInMB

Memory in MiB

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$ResourceValue

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig$ResourceValue

Name Description Required Schema Default

limit

false

number (double)

request

false

number (double)

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToS3Config

Name Description Required Schema Default

assumeRoleDurationInMinutes

Valid duration for the credentials in AssumeRole

true

integer (int32)

enableNginxLogsInS3

Set to true to use enable push of nginx access logs to S3

true

boolean

logFlushToS3IntervalInMinutes

Log flush interval

true

integer (int32)

logPercentageExport

Log percentage export

true

integer (int32)

s3RoleArn

The Amazon Resource Name (ARN) of the role to assume for accessing S3 bucket

true

string

s3RoleSessionName

The Role Session Name for AssumeRole

true

string

upstreamUrl

The HTTP URL of the upstream

true

string

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig

Name Description Required Schema Default

coolDownPeriodSec

The cool-down period after scale-up / scale-down where no further scaling will take place

false

integer (int32)

enabled

Whether auto-scaling based on loading is enabled

true

boolean

ignoreNodeCountLimit

Whether or not nodes can be scaled beyond the number of available cluster nodes

false

boolean

kedaAutoscaler

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$KedaAutoscalerConfig

maxNumServers

The maximum number of total origin nodes to spawn when auto-scaling is enabled

false

integer (int32)

minNumServers

The minimum number of origin nodes to maintain, applies regardless of value of enabled field

true

integer (int32)

mode

false

enum (LEGACY, KEDA)

scaleDownCondition

Condition to trigger scale-down

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleDownCondition

scaleDownStepPercentage

Percentage of number of existing nodes to remove during scale-down

false

integer (int32)

scaleUpCondition

Condition to trigger scale-up

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleUpCondition

scaleUpStepPercentage

Percentage of number of existing nodes to add during scale-up

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$CronTrigger

Name Description Required Schema Default

desiredReplicas

Number of replicas to which the resource has to be scaled between the start and end of the cron schedule.

false

integer (int32)

enabled

Whether KEDA autoscaling based on Cron Schedule is enabled.

false

boolean

end

Cron expression indicating the end of the cron schedule.

false

string

start

Cron expression indicating the start of the cron schedule.

false

string

timezone

The acceptable values would be a value from the IANA Time Zone Database.

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$KedaAutoscalerConfig

Name Description Required Schema Default

cronTrigger

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$CronTrigger

responseTimeThresholdForFullScaleUp

false

number (double)

scaleDownPolicy

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$KedaScalePolicy

scaleDownStabilizationWindowSeconds

false

integer (int32)

targetCpuPercent

false

integer (int32)

targetRequestRate

false

integer (int32)

targetThroughputMbps

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$KedaScalePolicy

Name Description Required Schema Default

periodSeconds

The amount of time in seconds for which the rule should hold true

true

integer (int32)

type

Allowed changed in terms of absolute number of pods or percentage of current replicas

true

enum (PODS, PERCENT)

value

No. of pods or percentage of existing replicas to scale down each time

true

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.ConnectionDrainingConfig

Name Description Required Schema Default

durationInSeconds

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

Name Description Required Schema Default

cpu

Number of CPU cores or units of virtual CPU

false

number (double)

cpuLimitRatio

Ratio of CPU usage limit to allocated amount

false

number (double)

mallocArenaMax

Number of malloc arena for C/C++ application inside container

false

integer (int32)

memInMB

Memory in MiB, this value should include the size of cache if memory-backed cache is enabled

false

number (double)

com.harmonicinc.unifiedoriginenginelibrary.settings.DefaultManifestFilteringSettings

Name Description Required Schema Default

enabled

false

boolean

mmpProfileId

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.EdgeAuthConfig

Name Description Required Schema Default

algorithm

Indicates the encryption format of edge auth

true

enum (MD5, SHA1_HMAC, SHA256_HMAC)

enabled

Whether edge auth is enabled

true

boolean

key

Key of encryption

true

string

urlPrefix

Custom url prefix

true

string

com.harmonicinc.unifiedoriginenginelibrary.settings.G2OAuthConfig

Name Description Required Schema Default

enabled

Whether g2o authentication is enabled

true

boolean

g2oKey

Indicates the encryption format for the g2o authentication

false

string

g2oNonce

A simple string or number that tells the origin which key to use to authenticate the request

false

string

g2oTimeWindow

Allowable time difference (in second) for a request

false

integer (int32)

g2oVersion

Indicates the encryption format for the g2o authentication

false

enum (NONE, MD5, MD5_1, MD5_HMAC, SHA1_HMAC, SHA256_HMAC)

com.harmonicinc.unifiedoriginenginelibrary.settings.HideFromLiveContentConfig

Name Description Required Schema Default

hideFromLiveContentInSec

The duration of the from-live content to hide in seconds

true

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.LlcuIndexingConfig

Name Description Required Schema Default

dropInvalidDataStreamUnits

false

boolean

enableDebugLog

false

boolean

enableVelocimeterActivityDump

false

boolean

exactFrameExtraction

false

boolean

indexingSpeedInKBps

false

integer (int32)

maxConcurrentIndexingJobs

false

integer (int32)

maxIndexingJobsPerNode

false

integer (int32)

runnableNodeTypes

false

string array

timestampJumpThresholdToStop

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.MdsProxySettings

Name Description Required Schema Default

mode

The preferred mode to serve timeshift content

false

enum (BlueGreen, ActiveActive)

com.harmonicinc.unifiedoriginenginelibrary.settings.MdsSchedulingConfig

Name Description Required Schema Default

spreadEvenlyAcrossAvailabilityZones

Whether media delivery servers should be launch evenly across availability zones (Mesos/Marathon deployment only)

false

boolean

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings

Name Description Required Schema Default

accessLogToLoki

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToLokiConfig

accessLogToS3

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AccessLogToS3Config

additionalHeaderConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$AdditionalHeaderConfig

autoScaling

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig

cacheSettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$CacheSettings

cloudfrontHeader

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$CloudfrontHeader

connectionConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ConnectionConfig

connectionDrainingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ConnectionDrainingConfig

defaultManifestFilteringSettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.DefaultManifestFilteringSettings

edgeAuthConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.EdgeAuthConfig

encryptionConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$EncryptionConfig

g2oAuthConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.G2OAuthConfig

headerAuthConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HeaderAuthConfig

hideFromLiveContentConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.HideFromLiveContentConfig

httpConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HttpConfig

llcuIndexingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.LlcuIndexingConfig

loggingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$LoggingConfig

mdsPropertiesConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$MdsPropertiesConfig

mdsProxySettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.MdsProxySettings

mdsSchedulingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.MdsSchedulingConfig

ottEgressProxyConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$OttEgressProxyConfig

potfServerConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerConfig

proxyBufferSettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ProxyBufferSettings

proxyCacheLockSettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ProxyCacheLockSettings

resourceConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ResourceConfig

statisticsReportingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$StatisticsReportingConfig

storageSettings

false

com.harmonicinc.unifiedoriginenginelibrary.settings.StorageSettings

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$AdditionalHeaderConfig

Name Description Required Schema Default

headers

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$AdditionalHeaderConfig$AdditionalHeader array

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$AdditionalHeaderConfig$AdditionalHeader

Name Description Required Schema Default

name

false

string

value

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$CacheSettings

Name Description Required Schema Default

cacheBackend

false

enum (DISK, MEMORY)

cacheStroageExtraSizeInMB

false

integer (int32)

enabled

false

boolean

ignoreCacheControlHeaderForLiveContent

When responding to live service requests, ignore any "Cache-control" HTTP header passed from upstream, so that MDS only use the "Expires" header for cache expiration check

true

boolean

maxSizeInMB

false

integer (int32)

nonLiveMaxSizeInMB

false

integer (int32)

separateCacheForNonLiveContent

false

boolean

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$CloudfrontHeader

Name Description Required Schema Default

header

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ConnectionConfig

Name Description Required Schema Default

workerConnections

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$EncryptionConfig

Name Description Required Schema Default

kmsSendTimeoutSeconds

How long will MDS consider the KMS-related request is timeout

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HeaderAuthConfig

Name Description Required Schema Default

matchAny

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HeaderAuthConfig$HeaderParam array

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HeaderAuthConfig$HeaderParam

Name Description Required Schema Default

name

false

string

value

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$HttpConfig

Name Description Required Schema Default

dropCacheControlHeaderForLiveContent

When responding to live service requests, remove any "Cache-control" HTTP header passed from upstream, so that downstream will only use the "Expires" header for cache control

true

boolean

enableHttp2

The setting controls whether HTTP 2 is enabled. Default is disabled.

false

boolean

enableSmoothStreaming412ErrorCode

The setting controls whether 412 response code should be returned for error cases encountered in live Smooth Streaming egress. Default is disabled.

false

boolean

enableWeakCiphers

The setting controls whether to enable weak ciphers. Default is enabled.

false

boolean

missingSegmentResponse

HTTP response for from-live missing segment (e.g. cause by source signal loss)

false

enum (HTTP_404, HTTP_200_0_BYTE)

urlPrefix

The setting controls whether to add a cluser-id as prefix to the URL of the content. Default is disabled. Valid characters are alphanumeric, hyphen, underscore

false

string

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$LoggingConfig

Name Description Required Schema Default

collectAccessLogs

false

boolean

maxSizeForErrorLogInMB

false

integer (int32)

maxSizeInMB

false

integer (int32)

nginxErrorLogLevel

false

enum (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, EMERG)

retentionPeriodInDays

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$MdsPropertiesConfig

Name Description Required Schema Default

forceContentLength_HLS_SS_DASH

Force Content-Length in HTTP response, i.e. deactivate Chunked Transfer Encoding

false

boolean

maxNumOfIndexFileCacheEntry

Determine the cache limit for MDS to cache index files

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$OttEgressProxyConfig

Name Description Required Schema Default

cache

false

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$OttEgressProxyConfig$Cache

developerMode

false

boolean

enableEarlyStartOver

Control whether to improve timeshift playlist availability (when common segment delivery URL is enabled)

false

boolean

enablePlaylistFiltering

Control whether to improve playlist availability by enabling filtering on playlist with start time adjustment for LiveEvent

false

boolean

enablePlaylistMerger

Control whether to enable playlist merger to improve start-over playlist latency (when common segment delivery URL is enabled)

false

boolean

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$OttEgressProxyConfig$Cache

Name Description Required Schema Default

cleanUpIntervalInSec

Interval to remove expired entries in cache

false

integer (int32)

enable

Whether to enable cache

false

boolean

initEntries

Number of entry used in initial memory allocation

false

integer (int32)

initEntrySizeInByte

Entry size used in initial memory allocation

false

integer (int32)

maxCacheSizeInMB

Maximum allowed memory allocated for cache

false

integer (int32)

shards

Number of shards (must be power of 2). For concurrency enhancement

false

integer (int32)

ttlInSec

Time to expire the entry after added to cache

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ProxyBufferSettings

Name Description Required Schema Default

proxyBufferSizeInKB

The size of per-connection buffer for buffering response from proxy upstream to client. Must be multiple of 4, from 12 to 224.

true

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$ProxyCacheLockSettings

Name Description Required Schema Default

proxyCacheLockAgeForLiveInMs

false

integer (int32)

proxyCacheLockAgeForNonLiveInMs

false

integer (int32)

proxyCacheLockTimeoutForLiveInMs

false

integer (int32)

proxyCacheLockTimeoutForNonLiveInMs

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.OriginSettings$StatisticsReportingConfig

Name Description Required Schema Default

liveEventRecordingStorageScanningIntervalSeconds

Interval between each live event recording storage scanning routine, 0 to disable scanning

false

integer (int32)

vodStorageScanningIntervalSeconds

Interval between each VOD and LLCU storage scanning routine, 0 to disable scanning

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerConfig

Name Description Required Schema Default

chblBalanceFactor

false

number (float)

connectionDrainingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ConnectionDrainingConfig

enableIndependentPotfServers

false

boolean

loadBalancingMode

false

enum (ROUND_ROBIN, CONSISTENT_HASHING, CONSISTENT_HASHING_WITH_BOUNDED_LOAD)

scalingConfig

false

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerScalingConfig

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerLegacyScalingConfig

Name Description Required Schema Default

coolDownPeriodSec

The cool-down period after scale-up / scale-down where no further scaling will take place

false

integer (int32)

scaleDownCondition

Condition to trigger scale-down

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleDownCondition

scaleDownStepPercentage

Percentage of number of existing nodes to remove during scale-down

false

integer (int32)

scaleUpCondition

Condition to trigger scale-up

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleUpCondition

scaleUpStepPercentage

Percentage of number of existing nodes to add during scale-up

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerScalingConfig

Name Description Required Schema Default

ignoreNodeCountLimit

false

boolean

kedaAutoscaler

false

com.harmonicinc.unifiedoriginenginelibrary.settings.AutoScalingConfig$KedaAutoscalerConfig

legacyScalingConfig

Legacy autoscaling config

false

com.harmonicinc.unifiedoriginenginelibrary.settings.PotfServerLegacyScalingConfig

maxNumServers

false

integer (int32)

minNumServers

false

integer (int32)

mode

false

enum (MANUAL, LEGACY, KEDA)

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventConfig

Name Description Required Schema Default

endTime

false

string (date-time)

labels

false

string array

name

false

string

startTime

false

string (date-time)

streamingUnit

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventInternal

Name Description Required Schema Default

endTime

false

string (date-time)

id

false

string

labels

false

string array

lastModifiedTime

false

string (date-time)

mdsDesiredReplicas

false

integer (int32)

name

false

string

startTime

false

string (date-time)

status

false

enum (IN_PROGRESS, SCHEDULED, FINISHED)

streamingUnit

false

integer (int32)

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmScheduleInternal

Name Description Required Schema Default

events

false

com.harmonicinc.unifiedoriginenginelibrary.settings.PreWarmEventInternal array

com.harmonicinc.unifiedoriginenginelibrary.settings.ResourceConfig

Name Description Required Schema Default

asset-operator

Explicit resource config for asset-operator, set to null for automatic

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

indexer

Explicit resource config for LLCU and VOD indexer, set to null for automatic

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

media-delivery-server

Explicit resource config for media-delivery-server, set to null for automatic

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

potf-server

Explicit resource config for potf server, set to null for automatic

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

retention-worker

Explicit resource config for retention-worker, set to null for automatic

false

com.harmonicinc.unifiedoriginenginelibrary.settings.ContainerResourceConfig

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleDownCondition

Name Description Required Schema Default

numConsecutiveCycles

The number of consecutive sample periods with response latency under threshold that will actually trigger a scale-down

true

integer (int32)

responseLatencyThreshold

The value of the server response latency (Time to first response byte) to consider a scale-down

true

number (double)

com.harmonicinc.unifiedoriginenginelibrary.settings.ScaleUpCondition

Name Description Required Schema Default

numConsecutiveCycles

The number of consecutive sample periods with response latency exceeding threshold that will actually trigger a scale-up

true

integer (int32)

responseLatencyThreshold

The threshold of the server response latency (Time to first response byte) to consider a scale-up

true

number (double)

com.harmonicinc.unifiedoriginenginelibrary.settings.StorageSettings

Name Description Required Schema Default

mgs3fsCachePoolSizeRatio

Ratio of memory configured in mgs3fs cache pool size

false

number (double)

mgs3fsWorkerThreads

Number of worker threads for MGS3FS, set to null for MGS3FS' default

false

integer (int32)

preferred

The preferred storage to use for serving timeshift content

false

enum (PRIMARY, BACKUP)

com.harmonicinc.vos.app.atm.datatypes.AudioStreamSelection

Name Description Required Schema Default

audioCodecSelection

Settings of Audio Codec Selection

true

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, ALL)

bitrateRange

Filtering bitrate - min and max

true

com.harmonicinc.vos.app.atm.datatypes.AudioStreamSelection$BitrateRange

indexRanges

Filtering index - min and max

false

com.harmonicinc.vos.app.atm.datatypes.IndexRange array

languageCodes

Filtering audios with language codes, case intensive, match by same character number

false

string array

withAudioGain

Filtering audios with gain applied at the transcoding stage and audios without

false

enum (ENABLE, DISABLE, ALL)

com.harmonicinc.vos.app.atm.datatypes.AudioStreamSelection$BitrateRange

Name Description Required Schema Default

maxBitrateInbps

Settings of max bitrate in bps

false

integer (int64)

minBitrateInbps

Settings of min bitrate in bps

false

integer (int64)

com.harmonicinc.vos.app.atm.datatypes.DvrFilterByScte35

Name Description Required Schema Default

matchStart

filter start of manifest by scte35 signal.

false

com.harmonicinc.vos.app.atm.datatypes.MatchSignal

com.harmonicinc.vos.app.atm.datatypes.IndexRange

Name Description Required Schema Default

maxIndex

Settings of max index, the index is one-based.

false

integer (int32)

minIndex

Settings of min index, the index is one-based.

false

integer (int32)

type

Type of packaging

false

enum (HLS, DASH, SS)

com.harmonicinc.vos.app.atm.datatypes.MatchSignal

Name Description Required Schema Default

asserts

List of XPATH 2.0 Expression

true

string array

matchType

Match Type. One of the following values: ALL, ANY or NONE

true

enum (ANY, ALL, NONE)

com.harmonicinc.vos.app.atm.datatypes.PlaylistSelection

Name Description Required Schema Default

alternativeUrlPrefix

alternative egress url prefix

true

string

preferredHost

Preferred host should be provided

true

enum (local, alternative)

segmentNumThreshold

Threshold to consider two manifests have different DVR lengths. default/min: 1

true

integer (int32)

staleManifestSegNumThreshold

Threshold to consider the manifest is stale. default: 2, min: 1

true

integer (int32)

com.harmonicinc.vos.app.atm.datatypes.Profile

Name Description Required Schema Default

audioStreamSelections

Audio Stream Selections

false

com.harmonicinc.vos.app.atm.datatypes.AudioStreamSelection array

dvrFilterByScte35

filter manifest DVR by scte35 signal. The resulting manifest is always bounded by dvrWindowSize if defined.

false

com.harmonicinc.vos.app.atm.datatypes.DvrFilterByScte35

dvrWindowSize

filter manifest by DVR window size (in seconds).

false

integer (int32)

enableAudioFilteringForPretranscodedContent

enable to allow audio codec and bitrate filtering with pre-transcode contents. default: false or null

false

boolean

enableDeltaUpdate

Enable delta update of manipulated manifests (support HLS only). Disabled by default.

false

boolean

id

id of the manifest filtering profile

true

string

minDvrInSecond

The minimum dvr window size manifest should contain (in second)

false

integer (int32)

name

name of the manifest filtering profile

true

string

playlistSelection

compare local and alternative manifest and return the better one

false

com.harmonicinc.vos.app.atm.datatypes.PlaylistSelection

preferredLanguage

Define the preferred language in three-letter language code

false

string

preferredVideoStreamIndex

Select video stream as default video, range from one to the length of video streams in original playlist

false

integer (int32)

removeScte35Signals

Remove SCTE35 messages in output (support HLS only). Keep SCTE35 messages by default.

false

boolean

subtitleStreamSelections

Subtitle Stream Selections

false

com.harmonicinc.vos.app.atm.datatypes.SubtitleStreamSelection array

videoStreamSelections

Video Stream Selections

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection array

com.harmonicinc.vos.app.atm.datatypes.Profiles

Name Description Required Schema Default

profiles

Manifest Filtering Profiles

true

com.harmonicinc.vos.app.atm.datatypes.Profile array

com.harmonicinc.vos.app.atm.datatypes.SubtitleStreamSelection

Name Description Required Schema Default

languageCodes

Filtering subtitle with language codes, case intensive, match by same character number

false

string array

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection

Name Description Required Schema Default

bitrateRange

Filtering bitrate - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$BitrateRange

frameRateRange

Filtering frame rate - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$FrameRateRange

horizontalResolutionRange

Filtering horizontal resolution - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$HorizontalResolutionRange

indexRanges

Filtering index - min and max

false

com.harmonicinc.vos.app.atm.datatypes.IndexRange array

verticalResolutionRange

Filtering vertical resolution - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$VerticalResolutionRange

videoCodecSelection

Settings of video codec selection

true

enum (H_265, H_264, ALL)

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$BitrateRange

Name Description Required Schema Default

esBitrateRange

Filtering DASH/SS bitrate - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$BitrateRange$StreamBitrateRange

exclude

false

boolean

maxBitrateInbps

(Deprecrated) Settings of max bitrate in bps

false

integer (int64)

minBitrateInbps

(Deprecrated) Settings of min bitrate in bps

false

integer (int64)

tsBitrateRange

Filtering HLS bitrate - min and max

false

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$BitrateRange$StreamBitrateRange

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$BitrateRange$StreamBitrateRange

Name Description Required Schema Default

maxBitrateInbps

Settings of max bitrate in bps

false

integer (int64)

minBitrateInbps

Settings of min bitrate in bps

false

integer (int64)

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$FrameRateRange

Name Description Required Schema Default

maxFrameRate

Settings of max frame rate

false

number (float)

minFrameRate

Settings of min frame rate

false

number (float)

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$HorizontalResolutionRange

Name Description Required Schema Default

maxHorizaontalResolution

Max horizontal resolution

false

integer (int32)

minHorizaontalResolution

Min horizontal resolution

false

integer (int32)

com.harmonicinc.vos.app.atm.datatypes.VideoStreamSelection$VerticalResolutionRange

Name Description Required Schema Default

maxVerticalResolution

Max vertical resolution

false

integer (int32)

minVerticalResolution

Min vertical resolution

false

integer (int32)

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig

Name Description Required Schema Default

cronTriggers

Cron Triggers (KEDA Mode Only)

false

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig$CronTrigger array

enabled

Whether auto-scaling is enabled

false

boolean

maxNumInstances

Maximum number of instances to launch, unset numOfInstances field before using

false

integer (int32)

minNumInstances

Minimum number of instances to launch, unset numOfInstances field before using

false

integer (int32)

mode

Use KEDA for autoscaling

false

enum (KEDA)

responseTimeThresholdForFullScaleUp

Target response time for scaling to max number of instances when exceeded

false

number (double)

scaleDownPolicy

The policy to control the speed of scaling down.

false

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig$ScaleDownPolicy

scaleDownStabilizationWindowSeconds

Duration of the time window that the autoscaler uses to calculate the high-water-mark of replicas, such that it never scales below the marking

false

integer (int32)

scaleUpOnly

Whether or not auto-scaling is limited to scale-up only

false

boolean

targetCpuPercent

Target CPU utilization percentage for calculating desired number of instances

false

integer (int32)

targetRequestRate

Target request rate for scaling the number of instances linearly

false

integer (int32)

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig$CronTrigger

Name Description Required Schema Default

desiredReplicas

Number of replicas to which the resource has to be scaled between the start and end of the cron schedule.

false

integer (int32)

end

Cron expression indicating the end of the cron schedule.

false

string

start

Cron expression indicating the start of the cron schedule.

false

string

timezone

The acceptable values would be a value from the IANA Time Zone Database.

false

string

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig$ScaleDownPolicy

Name Description Required Schema Default

periodSeconds

The time in seconds for which the policy should hold true.

true

integer (int32)

type

Allowed change in either number of pods or percentage of current replicas.

false

enum (Pods, Percent)

value

The value for the policy.

true

integer (int32)

com.harmonicinc.vos.app.atm.rest.model.AtmContainerResourceConfig

Name Description Required Schema Default

atmRequestUOEBlockingReloadTimeoutInMs

false

integer (int32)

atmRequestUOELiveTimeoutInMs

false

integer (int32)

atmRequestUOETimeshiftTimeoutInMs

false

integer (int32)

cpu

Number of CPU cores or units of virtual CPU

false

number (double)

memInMB

Memory in MiB

false

number (double)

com.harmonicinc.vos.app.atm.rest.model.AtmScalingConfig

Name Description Required Schema Default

atmAutoScalingConfig

The KEDA auto scaling setting of ATM pod

false

com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig

replicas

Number of ATM pod replicas

false

integer (int32)

com.harmonicinc.vos.app.atm.rest.model.AtmSettingConfig

Name Description Required Schema Default

atmContainerResourceConfig

The resource setting of ATM container

true

com.harmonicinc.vos.app.atm.rest.model.AtmContainerResourceConfig

atmScalingConfig

The scaling setting of ATM pod

true

com.harmonicinc.vos.app.atm.rest.model.AtmScalingConfig

enableGzip

Boolean to determine if enable gzip response or not

false

boolean

com.harmonicinc.vos.app.atm.rest.model.ContentGenerationChannel

Name Description Required Schema Default

channelName

The channel name of the variant channel. Must be unique.

false

string

contentSegmentDeliveryPrefix

Delivery prefixes for origin contents

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

defaultBlackoutManifests

The manifest URL of default blackout for different packaging type

false

object

deliveryMode

Delivery mode. If the value is null or DEFAULT, RELATIVE for VCM and RELATIVE_MASTER for PMM. Options: DEFAULT, RELATIVE_MASTER, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE

false

enum (DEFAULT, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE, RELATIVE_MASTER)

dvrWindowSize

DVR Window Size in Seconds.

false

integer (int32)

enableDeltaUpdate

Enable delta update of manipulated manifests.

false

boolean

enableIFrame

True when enable IFrame stream in the resulting manifests. Supported for HLS only.

false

boolean

enableImageStream

True when enable image stream in the resulting manifests. Supported for HLS only.

false

boolean

enableSCTE35Signal

True when including SCTE35 signals in the resulting manifests.

false

boolean

enableSubtitle

True when stitching the subtitle into the resulting manifests. Supported for HLS only.

false

boolean

manifestVariantDeliveryPrefix

Delivery prefixes for HLS master variant URL

false

string

mediaID

The SCTE224 Media ID

false

string

segmentDeliveryPrefix

Delivery prefixes for origin contents

false

object

com.harmonicinc.vos.app.atm.rest.model.ContentReplacementChannel

Name Description Required Schema Default

channelName

The channel name of the variant channel. Must be unique.

false

string

contentSegmentDeliveryPrefix

Delivery prefixes for origin contents

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

deliveryMode

Delivery mode. If the value is null or DEFAULT, RELATIVE for VCM and RELATIVE_MASTER for PMM. Options: DEFAULT, RELATIVE_MASTER, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE

false

enum (DEFAULT, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE, RELATIVE_MASTER)

dvrWindowSize

DVR Window Size in Seconds.

false

integer (int32)

enableDeltaUpdate

Enable delta update of manipulated manifests.

false

boolean

enableIFrame

True when enable IFrame stream in the resulting manifests. Supported for HLS only.

false

boolean

enableImageStream

True when enable image stream in the resulting manifests. Supported for HLS only.

false

boolean

enableSCTE35Signal

True when including SCTE35 signals in the resulting manifests.

false

boolean

enableSubtitle

True when stitching the subtitle into the resulting manifests. Supported for HLS only.

false

boolean

manifestVariantDeliveryPrefix

Delivery prefixes for HLS master variant URL

false

string

mediaID

The SCTE224 Media ID

false

string

segmentDeliveryPrefix

Delivery prefixes for origin content

false

object

upstreamURL

The Content Source URL. (Only the manifest path, with manifest filename. Should end with '/')

true

string

com.harmonicinc.vos.app.atm.rest.model.LiveEventClippingChannel

Name Description Required Schema Default

channelName

The channel name of the variant channel. Must be unique.

false

string

contentSegmentDeliveryPrefix

Delivery prefixes for origin contents

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

deliveryMode

Delivery mode. If the value is null or DEFAULT, RELATIVE for VCM and RELATIVE_MASTER for PMM. Options: DEFAULT, RELATIVE_MASTER, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE

false

enum (DEFAULT, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE, RELATIVE_MASTER)

dvrWindowSize

DVR Window Size in Seconds.

false

integer (int32)

enableDeltaUpdate

Enable delta update of manipulated manifests.

false

boolean

enableIFrame

True when enable IFrame stream in the resulting manifests. Supported for HLS only.

false

boolean

enableImageStream

True when enable image stream in the resulting manifests. Supported for HLS only.

false

boolean

enableSCTE35Signal

True when including SCTE35 signals in the resulting manifests.

false

boolean

enableSubtitle

True when stitching the subtitle into the resulting manifests. Supported for HLS only.

false

boolean

manifestVariantDeliveryPrefix

Delivery prefixes for HLS master variant URL

false

string

segmentDeliveryPrefix

Delivery prefixes for origin content

false

object

upstreamURL

The Content Source URL. (Only the manifest path, with manifest filename. Should end with '/')

true

string

com.harmonicinc.vos.app.atm.rest.model.RegionalAdsChannel

Name Description Required Schema Default

channelName

The channel name of the variant channel. Must be unique.

false

string

contentSegmentDeliveryPrefix

Delivery prefixes for origin contents

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

deliveryMode

Delivery mode. If the value is null or DEFAULT, RELATIVE for VCM and RELATIVE_MASTER for PMM. Options: DEFAULT, RELATIVE_MASTER, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE

false

enum (DEFAULT, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE, RELATIVE_MASTER)

dvrWindowSize

DVR Window Size in Seconds.

false

integer (int32)

enableDeltaUpdate

Enable delta update of manipulated manifests.

false

boolean

enableIFrame

True when enable IFrame stream in the resulting manifests. Supported for HLS only.

false

boolean

enableImageStream

True when enable image stream in the resulting manifests. Supported for HLS only.

false

boolean

enableSCTE35Signal

True when including SCTE35 signals in the resulting manifests.

false

boolean

enableSubtitle

True when stitching the subtitle into the resulting manifests. Supported for HLS only.

false

boolean

geoSyncEnable

Enable redundancy mode for VCM channel

false

boolean

manifestVariantDeliveryPrefix

Delivery prefixes for HLS master variant URL

false

string

mediaID

The SCTE224 Media ID

false

string

regionalAdTxProfile

The ID of transcoding profile of regional ads.

false

string

segmentDeliveryPrefix

Delivery prefixes for origin content

false

object

upstreamURL

The Content Source URL. (Only the manifest path, with manifest filename. Should end with '/')

true

string

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

Name Description Required Schema Default

DASH

Delivery prefix for DASH package type

false

string

HLS

Delivery prefix for HLS package type

false

string

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$SegmentDeliveryPrefix

Name Description Required Schema Default

adSegmentDeliveryPrefix

Delivery prefixes for ads

true

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

contentSegmentDeliveryPrefix

Delivery prefixes for origin contents

true

com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$DeliveryPrefix

com.harmonicinc.vos.app.atm.rest.model.VariantChannelSourceIDMapping

Name Description Required Schema Default

contents

Contents that map to the ID

true

object

sourceID

The ID that maps to a set of source contents. Must be unique.

true

string

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter

Name Description Required Schema Default

name

The name of the variant channel filter. Must be unique. The number of filters is limited to 20000. Error code 500 will be returned if you try to add more.

true

string

trimAfterSCTE35Signal

Enable trimming segments AFTER a matching SCTE35 Signal.

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter$SCTE35SignalMatchingConfig

trimAfterTime

Trimming segments AFTER this time. (in RFC3339 time format)

false

string

trimBeforeSCTE35Signal

Enable trimming segments BEFORE a matching SCTE35 Signal.

false

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter$SCTE35SignalMatchingConfig

trimBeforeTime

Trimming segments BEFORE this time. (in RFC3339 time format)

false

string

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilter$SCTE35SignalMatchingConfig

Name Description Required Schema Default

asserts

Asserts should be valid xpaths

true

string array

effective

Effective should be valid RFC3339 time

false

string

expires

Expires should be valid RFC3339 time

false

string

matchType

MatchType should be provided

true

enum (ANY, ALL)

com.harmonicinc.vos.app.atm.rest.model.VariantChannelsFilterStatus

Name Description Required Schema Default

existingFilterCount

Existing number of variant channels filters in the database.

false

integer (int32)

maxFilterCount

Maximum number of variant channels filters allowed in the database.

false

integer (int32)

com.harmonicinc.vos.app.configure.image.sync.ImageFileSyncConfig

Name Description Required Schema Default

delay

Delay between sync iterations in minutes

true

integer (int64)

com.harmonicinc.vos.app.configure.model.AzureSpeechServiceSetting

Name Description Required Schema Default

key

Subscription key of Azure speech service

false

string

com.harmonicinc.vos.app.configure.model.DescramblingKeyPair

Name Description Required Schema Default

entitlementKeyId

16 hexadecimal characters long representation of the EntitlementKeyId. The EntitlementKeyId is generated from the public key as described in the EBU Tech 3292s1 document. It is used to identify the key in the entitlement system.

false

string

id

Unique identifier of the key pair

false

string

mode

Identifies how is generated the key pair. The possible values are: INJECTED_KEY (injected by user) or BURIED_KEY (buried at factory).

false

enum (INJECTED_KEY, BURIED_KEY)

com.harmonicinc.vos.app.configure.model.DescramblingKeys

Name Description Required Schema Default

id

Id

false

string

injectedId

Injected Id. Used to decrypt the SW when mode is BISS2 mode E. 32 hexadecimal characters long. If null, the global injected Id is used. On PUT, special value "" means the value is not modified. GET will return this same special value.

false

string

mode

Descrambling mode

true

enum (BISS2_MODE_1, BISS2_MODE_E)

swEven

Session word used to descramble TS packets with transport_scrambling_control set to 10. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "" means the value is not modified. GET will return this same special value.

false

string

swOdd

Session word used to descramble TS packets with transport_scrambling_control set to 11. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "" means the value is not modified. GET will return this same special value.

false

string

com.harmonicinc.vos.app.configure.model.GeneralSettings

Name Description Required Schema Default

allLanguages

false

string array

allRegions

false

com.harmonicinc.vos.app.configure.model.GeneralSettings$Region array

cloudlinkTransportProtocol

false

enum (ZIXI, SRT)

distributorId

false

string

region

false

com.harmonicinc.vos.app.configure.model.GeneralSettings$Region

serviceTypes

false

com.harmonicinc.vos.app.configure.model.GeneralSettings$ServiceType array

sourceTypes

false

com.harmonicinc.vos.app.configure.model.GeneralSettings$SourceType array

com.harmonicinc.vos.app.configure.model.GeneralSettings$Region

Name Description Required Schema Default

languages

false

string array

name

false

string

com.harmonicinc.vos.app.configure.model.GeneralSettings$ServiceType

Name Description Required Schema Default

enabled

false

boolean

icon

false

string

name

false

string

com.harmonicinc.vos.app.configure.model.GeneralSettings$SourceType

Name Description Required Schema Default

enabled

false

boolean

name

false

string

com.harmonicinc.vos.app.configure.model.GlobalAudioSetting

Name Description Required Schema Default

copyRight

Specifies copyRight properties of audio

true

enum (COPYRIGHTED_ORIGINAL, COPYRIGHTED_COPY, UNCOPYRIGHTED_ORIGINAL, UNCOPYRIGHTED_COPY)

com.harmonicinc.vos.app.configure.model.GlobalCloudDestinationSettings

Name Description Required Schema Default

dejitterDelayMsec

Buffer in milliseconds used to accumulate data before streaming.

false

integer (int32)

downloadRetryPeriodSec

Downloadable time period for data. If the data has not been downloaded during this period, it is discarded.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.GlobalDailySyncTime

Name Description Required Schema Default

dailySyncTime

Daily sync time (UTC) for the timecode synchronization. Applicable mainly for 29.97/59.94 fps. Range 0..23, default is 0

false

integer (int32)

com.harmonicinc.vos.app.configure.model.GlobalDescramblingSetting

Name Description Required Schema Default

biss2ModeEInjectedId

Global injected Id for BISS2 mode E descrambling. 32 hexadecimal characters long. On PUT, special value "" means the value is not modified. GET will return this same special value.

false

string

com.harmonicinc.vos.app.configure.model.GlobalEsamSetting

Name Description Required Schema Default

defaultFallbackTimeout

Default timeout value (seconds) for ESAM source redundancy safety fallback mechanism, a mechanism to fallback to primary source from secondary source if there is no message from POIS, range from 10 to 300, default value is equal to 120

false

integer (int32)

defaultPoisEndpoint

Default POIS endpoint URL. Can be overridden in per-service ESAM configuration.

false

string

enableOobEsam

Enable out-of-band esam server

false

boolean

oobEsamProtocol

(Deprecated) HTTP Protocol of out-of-band esam server

false

enum (HTTP, HTTPS)

oobMessagePreroll

Pre-roll time for OOB ESAM messages in seconds ranges from 4 to 60, defaults to 4, overrides splice repetition to false if larger than 4

false

integer (int32)

scte35PassthruUponEsamUnreachable

Global option to allow in-band SCTE-35 to passthrough to output if the ESAM POIS is unreachable

false

boolean

com.harmonicinc.vos.app.configure.model.GlobalGeoSyncSetting

Name Description Required Schema Default

disableAutoRestart

Whether GeoSync service should restart automatically during desynchronization, can be changed at runtime

false

boolean

mode

Specifies the mode of GeoSync, cannot be changed unless all services are offline

false

enum (DEFAULT, NTP)

com.harmonicinc.vos.app.configure.model.GlobalLiveIngestSetting

Name Description Required Schema Default

liveIngestStoragePerService

Support at K8S env only. Live data output will be stored at per service storage with in sspe pod.

false

boolean

minPvcProvisionedIOPS

Support at K8S env only. Minimum provisioned IOPS for PVC.

false

integer (int32)

minPvcProvisionedThroughput

Support at K8S env only. Minimum provisioned throughput in MB/second for PVC.

false

integer (int32)

minRequiredMemoryInMB

Support at K8S env only. The minimum required memory in MB for LIO processes within sspe pod.

false

integer (int32)

useDiskAsStorage

Support at K8S env only. Live data output will be stored to Azure Disk instead of RAM.

false

boolean

com.harmonicinc.vos.app.configure.model.GlobalMuxSetting

Name Description Required Schema Default

divitrackSrtLatency

Internal divitrack SRT latency (ms)

false

integer (int32)

muxStatsReportingSetting

mux stats reporting setting

false

com.harmonicinc.vos.app.configure.model.MuxStatsReportingSetting

com.harmonicinc.vos.app.configure.model.GlobalNielsenSetting

Name Description Required Schema Default

encoderTimezone

Obsoleted

false

string

hostname

IP address or hostname of the Nielsen log publishing server

true

string

password

Password of the Nielsen log publishing server (masked)

true

string

path

Path on the Nielsen log publishing server to store the output files

true

string

port

TCP port of the Nielsen log publishing server to connect to

true

integer (int32)

username

Username of the Nielsen log publishing server

true

string

com.harmonicinc.vos.app.configure.model.GlobalPackagingSetting

Name Description Required Schema Default

emptyDataUnitHoldBackInMs

Determines how far away from latest PCR will packager generate internal empty data units up to, 0 for automatic.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.GlobalScte35Setting

Name Description Required Schema Default

enableScte104Server

Set to true/false to enable/disable the use of SCTE-104 server

false

boolean

enableScte35AdaptationFieldStuffing

Set to true/false to enable/disable the use of adaptation field stuffing in SCTE35 output

false

boolean

scte104ServerSetting

Settings for SCTE-104 server

false

com.harmonicinc.vos.app.configure.model.Scte104ServerSetting

com.harmonicinc.vos.app.configure.model.GlobalServiceSetting

Name Description Required Schema Default

dataGrooming

Default Data Grooming setting of source

true

com.harmonicinc.vos.app.configure.model.source.DataGrooming

enableAutoUnencrypted

Indicate if auto_unencrypted is enabled

false

boolean

enablePersistPlaylist

Indicate if persist playlist is enabled for LIVE_EVENT services

false

boolean

globalAudioSetting

Global setting of audio

true

com.harmonicinc.vos.app.configure.model.GlobalAudioSetting

globalCloudDestinationSettings

Cloud destination settings for XOS services

false

com.harmonicinc.vos.app.configure.model.GlobalCloudDestinationSettings

globalDailySyncTime

Global Daily sync time (UTC) for the timecode synchronization

false

com.harmonicinc.vos.app.configure.model.GlobalDailySyncTime

globalDescramblingSetting

Global descrambling setting

false

com.harmonicinc.vos.app.configure.model.GlobalDescramblingSetting

globalEsamSetting

Global ESAM setting of services

false

com.harmonicinc.vos.app.configure.model.GlobalEsamSetting

globalGeoSyncSetting

Global GeoSync setting

false

com.harmonicinc.vos.app.configure.model.GlobalGeoSyncSetting

globalLiveIngestSetting

Global Live Ingest setting of services

false

com.harmonicinc.vos.app.configure.model.GlobalLiveIngestSetting

globalMuxSetting

mux settings

false

com.harmonicinc.vos.app.configure.model.GlobalMuxSetting

globalNielsenSetting

Global Nielsen setting of services

false

com.harmonicinc.vos.app.configure.model.GlobalNielsenSetting

globalPackagingSetting

Global packaging setting

false

com.harmonicinc.vos.app.configure.model.GlobalPackagingSetting

globalScte35Setting

Global Scte35 setting of services

false

com.harmonicinc.vos.app.configure.model.GlobalScte35Setting

globalSourceSetting

Global setting of source

true

com.harmonicinc.vos.app.configure.model.GlobalSourceSetting

globalSpeechEngineSetting

Global speech service setting

false

com.harmonicinc.vos.app.configure.model.GlobalSpeechServiceSetting

globalSynamediaWatermarkSetting

Global Synamedia setting of services

false

com.harmonicinc.vos.app.configure.model.GlobalSynamediaWatermarkSetting

globalVideoSetting

Global setting of video

true

com.harmonicinc.vos.app.configure.model.GlobalVideoSetting

gpsUtcOffset

GPS UTC offset in seconds

false

integer (int32)

scheduler360Setting

Scheduler 360 setting

false

com.harmonicinc.vos.app.configure.model.Scheduler360Setting

sdiLatencyOffset

SDI latency offset in seconds, range -100..100ms, step 1ms, default is 0

false

integer (int32)

serviceLimit

The limitation of number of service

false

com.harmonicinc.vos.app.configure.model.ServiceLimit

com.harmonicinc.vos.app.configure.model.GlobalSourceSetting

Name Description Required Schema Default

autoSlateDisableConditions

Specify the auto slate disable conditions

false

enum (e_SCRAMBLED_PID) array

playoutLiveSourceProtocol

Specify live source protocol for playout

false

enum (SRT, IP)

sourceCloudlinkDefaultProtocol

false

enum (ZIXI, HSP)

sourceDefaultVideoBitrateSizeInMB

Specify the Size for video bitrate for pass through profile case if the source is not groomed, default value is 20MB

false

integer (int32)

sourceFailoverConditions

Specify the source failover conditions, source data loss will be applied by default

false

com.harmonicinc.vos.app.configure.model.SourceFailoverCondition array

sourceHspIngestPointSizeInMB

Specify the Size for HSP ingest point, default value is 1200MB

false

integer (int32)

useFragmentingDownloadForHsp

Specify whether to use fragmenting download for HSP input

false

boolean

visualArtifactWatchdog

Specify enable or disable watchdog for source visual artifact

false

boolean

com.harmonicinc.vos.app.configure.model.GlobalSpeechServiceSetting

Name Description Required Schema Default

azureSpeechServiceSetting

Azure speech service setting

false

com.harmonicinc.vos.app.configure.model.AzureSpeechServiceSetting

nciCaptioning

NCI captioning service setting

false

com.harmonicinc.vos.app.configure.model.NciCaptioning

com.harmonicinc.vos.app.configure.model.GlobalSynamediaWatermarkSetting

Name Description Required Schema Default

isEnable

false

boolean

oauthClientId

Specify Oauth Client ID.

false

string

oauthClientSecret

Specify Oauth Client Secret.

false

string

oauthServerEndpoint

Specify Oauth Server Endpoint. The value should contain https at the beginning

false

string

seiUuid

Retrieve SEI UUID.

false

string

sourceId

Specify Synamedia source ID

false

string

watermarkManagerEndpoint

Specify Synamedia Endpoint. The value should contain https at the beginning

false

string

com.harmonicinc.vos.app.configure.model.GlobalVideoSetting

Name Description Required Schema Default

copyRight

Specifies copyRight properties of video

true

enum (COPYRIGHTED_ORIGINAL, COPYRIGHTED_COPY, UNCOPYRIGHTED_ORIGINAL, UNCOPYRIGHTED_COPY)

enableTimecodeNormalization

Indicate if input timecode to UTC timecode normalization is enabled.

false

boolean

stressBias

Specifies stress bias option applied on video

true

enum (SOFT_CLEANER, BALANCED, SHARPER_BLOCKIER)

syncMode

Specifies sync mode properties of video

false

enum (SYNC_TO_SOURCE, SYNC_TO_INTERNAL)

videoStandard

Specifies video standard of the output

true

enum (VS_25_50Hz, VS_30_60Hz)

com.harmonicinc.vos.app.configure.model.Image

Name Description Required Schema Default

id

Unique identifier of an image file

false

string

labels

Labels are used to specify identifying metadata

false

string array

lastModified

Date of image last modification on remote server

false

integer (int64)

password

Password to use with the file server

false

string

url

URL to download the image

true

string

username

Username to use with the file server

false

string

com.harmonicinc.vos.app.configure.model.IrdetoLicense

Name Description Required Schema Default

id

Unique identifier of an image file

false

string

labels

Labels are used to specify identifying metadata

false

string array

lastModified

Date of image last modification on remote server

false

integer (int64)

operatorId

Operator ID provided by Irdeto (must match the one specified in the license file)

true

integer (int32)

password

Password to use with the file server

false

string

url

URL to download the image

true

string

username

Username to use with the file server

false

string

com.harmonicinc.vos.app.configure.model.KantarSnapWatermarkLicenseFile

Name Description Required Schema Default

data

Base-64 content of license file

false

string

id

Unique ID for the license to be used in the service add-on (set to null to auto-generate one)

false

string

name

License name for the UI - must be unique

false

string

type

License type (LIC or AUD)

false

enum (LIC, AUD)

com.harmonicinc.vos.app.configure.model.MuxStatsReportingSetting

Name Description Required Schema Default

inputPidStatsInterval

input pid reporting frequency in seconds [1-600]

false

integer (int32)

inputProgramStatsInterval

input program reporting frequency in seconds [1-600]

false

integer (int32)

inputTsStatsInterval

input ts reporting frequency in seconds [1-600]

false

integer (int32)

outputPidStatsInterval

output pid reporting frequency in seconds [1-600]

false

integer (int32)

outputProgramStatsInterval

output program reporting frequency in seconds [1-59]

false

integer (int32)

outputTsStatsInterval

output ts reporting frequency in seconds [1-600]

false

integer (int32)

com.harmonicinc.vos.app.configure.model.NciCaptioning

Name Description Required Schema Default

enabled

Enable NCI captioning

false

boolean

com.harmonicinc.vos.app.configure.model.ResourceRequirements

Name Description Required Schema Default

cpu

Number of CPU cores or units of virtual CPU

false

number (double)

memory

Memory in MiB

false

number (double)

com.harmonicinc.vos.app.configure.model.Scheduler360Setting

Name Description Required Schema Default

authServer

OAuth Server for Scheduler 360

true

string

clientID

ClientID for Scheduler 360 OAuth authentication

true

string

clientSecret

ClientSecret for Scheduler 360 OAuth authentication

true

string

endpoint

Endpoint of the Scheduler 360

true

string

com.harmonicinc.vos.app.configure.model.Scte104ServerSetting

Name Description Required Schema Default

validateDpiPidIndex

Return error code 126 to alive/inject messages if DPI PID index is not used by any running service. Default is false (return 100).

false

boolean

com.harmonicinc.vos.app.configure.model.ServiceLimit

Name Description Required Schema Default

onlineServiceLimit

The maximum limit of total online service

false

integer (int32)

totalServiceLimit

The maximum limit of total service

false

integer (int32)

com.harmonicinc.vos.app.configure.model.SourceFailoverCondition

Name Description Required Schema Default

type

Specify type of SourceFailoverCondition required to support. Note: PID_MISSING may be set to detect a video missing PID or a video decoding issue

false

enum (PID_MISSING, PCR_MISSING, CC_ERROR, SCRAMBLED_PID, AUDIO_PID_MISSING)

com.harmonicinc.vos.app.configure.model.SrtCloudInputSettings

Name Description Required Schema Default

connectionMode

Srt connection mode

false

enum (LISTENER, CALLER)

encryptionParam

Encryption param

false

com.harmonicinc.vos.app.configure.model.SrtEncryptionParams

latency

Latency

false

integer (int32)

srtConnectionInfo

Information about connection to cloud endpoint

false

com.harmonicinc.vos.app.configure.model.SrtConnectionInfo

srtConnectionSettingsList

Srt connection settings list

false

com.harmonicinc.vos.app.configure.model.SrtConnectionSettings array

com.harmonicinc.vos.app.configure.model.SrtCloudOutputSettings

Name Description Required Schema Default

bandwidthOverhead

Bandwidth overhead

false

integer (int32)

blockingMode

Blocking mode

false

boolean

encryptionParam

Encryption param

false

com.harmonicinc.vos.app.configure.model.SrtEncryptionParams

latency

Latency

false

integer (int32)

srtConnectionSettingsList

Srt connection settings list

false

com.harmonicinc.vos.app.configure.model.SrtConnectionSettings array

timeout

Timeout

false

integer (int32)

com.harmonicinc.vos.app.configure.model.SrtConnectionInfo

Name Description Required Schema Default

lowerLatencyLimit

Lower latency limit (based on recommended latency)

false

integer (int32)

rtt

Round-trip time

false

integer (int32)

upperLatencyLimit

Upper latency limit

false

integer (int32)

com.harmonicinc.vos.app.configure.model.SrtConnectionSettings

Name Description Required Schema Default

ipAddress

Ip address

false

string

ipNetworkAddress

Interface

false

string

latency

Latency, specified for Srt

false

integer (int32)

port

Port

false

integer (int32)

srtEncryptionParams

Srt encryption params

false

com.harmonicinc.vos.app.configure.model.SrtEncryptionParams

streamId

Stream id

false

string

streamIndex

Stream Index

false

integer (int32)

com.harmonicinc.vos.app.configure.model.SrtEncryptionParams

Name Description Required Schema Default

encryptionKey

Srt encryption key

false

string

encryptionType

Srt encryption type

false

enum (AES_128, AES_192, AES_256, NO_ENCRYPTION)

com.harmonicinc.vos.app.configure.model.destination.AsiOutput

Name Description Required Schema Default

card

ASI card for the output

false

enum (CARD_1, CARD_2, CARD_3)

muteAtStartup

false

boolean

port

ASI port for the output

true

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.AuthorizationSettings

Name Description Required Schema Default

accessKey

Access key for S3 bucket authorization

true

string

secretKey

Secret key for S3 bucket authorization

true

string

com.harmonicinc.vos.app.configure.model.destination.BackupSettings

Name Description Required Schema Default

enable

Enable backup publishing endpoint

false

boolean

hostname

IP address or hostname of backup origin server

false

string

networkIpAddress

Network Ip Address

false

string

password

Password of backup origin server

false

string

path

Path on the backup origin server to store the output files

false

string

port

TCP port of backup origin server to connect to

false

integer (int32)

username

Username of backup origin server

false

string

com.harmonicinc.vos.app.configure.model.destination.CloudOutputSettings

Name Description Required Schema Default

channelId

Cloud channel id

false

string

channelName

Cloud channel name

false

string

pipeId

Pipe id

false

string

pipeState

LrsPipe state

false

enum (OFFLINE, RUNNING, UNKNOWN)

protocol

Protocol

false

string

region

Region

false

string

regionDisplayName

Region display name

false

string

srtCloudOutputSettings

Cloud srt connection settings

false

com.harmonicinc.vos.app.configure.model.SrtCloudOutputSettings

streamCount

StreamCount

false

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.CloudPublishSettings

Name Description Required Schema Default

s3PublishSettings

Amazon S3 publishing settings

true

com.harmonicinc.vos.app.configure.model.destination.S3PublishSettings

com.harmonicinc.vos.app.configure.model.destination.CloudSourceOutputSettings

Name Description Required Schema Default

pipeId

Lrs pipeId

false

string

protocol

Protocol

false

string

region

Region

false

string

regionDisplayName

Region display name

false

string

com.harmonicinc.vos.app.configure.model.destination.Destination

Name Description Required Schema Default

destinationProfileId

Unique identifier of destination profile associated to this destination. It is required in multiscreen output

false

string

id

Unique identifier of a destination in UUID format

false

string

inUse

Every destination has a flag inUse when destination is used in service

false

boolean

labels

Labels attached to destination for identification

false

string array

modifiableByAffiliate

Flag to indicate whether affiliate can modify this destination. Applicable for XOS IRD

false

boolean

name

Display name of a destination

false

string

outputs

An output is a singular network location for the content processed and output by a service

false

com.harmonicinc.vos.app.configure.model.destination.Output array

type

Destination type

false

enum (IP, MULTISCREEN_IP, ORIGIN, ATS, SMPTE_2022_6, SMPTE_2110, MPTS, OTT_PLAYOUT, SDI)

com.harmonicinc.vos.app.configure.model.destination.DrmSettings

Name Description Required Schema Default

enable

Enable DRM on the publishing endpoint

false

boolean

requestorId

Requestor ID

false

string

resourceId

Resource ID

false

string

url

The URL to the DRM server

false

string

com.harmonicinc.vos.app.configure.model.destination.DualServiceOutputIpSettings

Name Description Required Schema Default

ipAddress

IP address to send the output

false

string

ipNetworkAddress

IP Network address

false

string

ipPort

IP port to send the output

false

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.ExternalKeyPublishingSettings

Name Description Required Schema Default

enable

Enable publishing decryption key to external server

true

boolean

hostname

External server hostname

true

string

keyUriPath

Key Retrieval URI Path if useSpecifiedKeyUriPath is set to true

false

string

password

Password for connecting to external server using basic authentication

false

string

path

Publishing path

true

string

port

External server hostname

true

integer (int32)

protocol

Protocol for publishing decryption key

true

enum (HTTP, HTTPS, RTMP, RTMPS)

username

Username for connecting to external server using basic authentication

false

string

com.harmonicinc.vos.app.configure.model.destination.GpioOutput

Name Description Required Schema Default

enable

Enable the GPIO output feature: on SCTE-104 splice_insert with out_of_network_indicator=1 on SDI 1 (resp. SDI 2), a ~500ms contact closure between pins 1 & 11 (resp. 2 and 12) of the DB15HD connector will start at splice-point. Available only for ports 1 & 2 of SDI card 1.

false

boolean

preroll

Preroll in ms: allows to start the contact closure before or after the splice-point.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.HSP_Output

Name Description Required Schema Default

hspEndpoint

Internal Live ingest endpoint of the destination

true

string

hspEndpointId

Live ingest endpoint Id of the destination

false

string

publicHspEndpoint

Public Live ingest endpoint of the destination

false

string

variantPlaylistFileName

Playlist File Name of the destination

true

string

com.harmonicinc.vos.app.configure.model.destination.IP_Output

Name Description Required Schema Default

cloudOutputSettings

Cloud output settings

false

com.harmonicinc.vos.app.configure.model.destination.CloudOutputSettings

cloudSourceOutputSettings

Cloud Source output settings

false

com.harmonicinc.vos.app.configure.model.destination.CloudSourceOutputSettings

cloudlinkGroupId

Cloudlink Group Id

false

string

cloudlinkId

Cloudlink Id

false

string

ipAddress

IP address to send the output

false

string

ipNetworkAddress

IP Network address

false

string

ipPort

IP port to send the output

false

integer (int32)

labels

Labels attached to IP output for identification

false

string array

muteAtStartup

Disable the output (dedicated to the IP output of a mux)

false

boolean

poolBinding

Associated divitrack pool

false

com.harmonicinc.vos.app.configure.model.destination.PoolBinding

srtOutputSettings

Srt output settings

false

com.harmonicinc.vos.app.configure.model.destination.SrtOutputSettings

zixiOutputSettings

Zixi output settings

false

com.harmonicinc.vos.app.configure.model.destination.ZixiOutputSettings

com.harmonicinc.vos.app.configure.model.destination.ManipulationProfile

Name Description Required Schema Default

mpdFileName

Filtered DASH mpd file name

false

string

profileId

Manipulation profile id in UUID format

true

string

variantPlaylistFileName

Filtered HLS variant playlist file name

false

string

com.harmonicinc.vos.app.configure.model.destination.OriginOutput

Name Description Required Schema Default

ipNetworkAddress

IP Network address

false

string

originOutputEndPoints

List of end point mapped to packaging profile type

false

com.harmonicinc.vos.app.configure.model.destination.OriginOutputEndPoint array

com.harmonicinc.vos.app.configure.model.destination.OriginOutputEndPoint

Name Description Required Schema Default

absoluteBaseURL

Absolute base URL in master playlist to reference stream playlist

false

string

alternativeAbsoluteBaseURL

Alternative cluster absolute base url in master playlist

false

string

alternativePathwayName

alternative pathway name for content steering

false

string

backup

Backup settings of the publishing point

false

com.harmonicinc.vos.app.configure.model.destination.BackupSettings

compatibilityMode

Compatibility mode. Default to 'STANDARD' if not specified

false

enum (STANDARD, AKAMAI, HUAWEI, SIMPLE_HTTP, S3, MEDIASTORE)

contentSteeringServerURL

Content steering server url in master playlist

false

string

drm

Drm settings of the publishing point

false

com.harmonicinc.vos.app.configure.model.destination.DrmSettings

enableAbsoluteURL

Enable absolute URL in master playlist to reference stream playlist

false

boolean

enableContentSteeringPlaylist

Enable absolute URL in master playlist to reference stream playlist

false

boolean

fromliveAbsoluteBaseURL

Fromlive absolute base URL in master playlist to reference stream playlist

false

string

hostname

IP address or hostname of origin server

false

string

id

Unique identifier of an origin output end point in UUID format

true

string

insertPlaylistCustomTag

Enable custom tag in master playlist

false

boolean

labels

Labels identifier of an output

false

string array

localPathwayName

local pathway name for content steering

false

string

originOutputProtocol

Specify the protocol used for origin output

true

enum (HTTP, HTTPS, RTMP, RTMPS)

outputMode

Output mode for internal output in Origin destionation

false

enum (LIVE_AND_TIMESHIFT, LIVE_ONLY, TIMESHIFT_ONLY)

packagingProfileType

Type of packaging profile defined at lab wizard profile

true

string

password

Password of origin server

false

string

path

Path on the origin server to store the output files

false

string

playlistCustomTag

Custom tag to add in master playlist

false

string

port

TCP port of origin server to connect to

false

integer (int32)

profileName

Name of packaging profile defined at lab wizard profile. Used to support multiple packaging with same package type.

false

string

publishName

Publish name for use in internal origin egress URL

false

string

redundancyMode

Redundancy mode of the publishing point

false

enum (NONE, ACTIVE_ACTIVE, ACTIVE_STANDBY)

streamsPerTcpConnection

Specify streams per TCP connection

false

enum (ONE_STREAM, ALL_STREAMS)

username

Username of origin server

false

string

variantPlaylistFileName

Variant Playlist Filename (override Variant Playlist Filename set in LabWizard HLS destination profile)

false

string

com.harmonicinc.vos.app.configure.model.destination.Output

Name Description Required Schema Default

asiSettings

Settings of an ASI output

false

com.harmonicinc.vos.app.configure.model.destination.AsiOutput

hspSettings

Settings of an HSP output

false

com.harmonicinc.vos.app.configure.model.destination.HSP_Output

id

Unique identifier of an output in UUID format

true

string

ipSettings

Settings of an IP output

false

com.harmonicinc.vos.app.configure.model.destination.IP_Output

originSettings

Settings of an origin output

false

com.harmonicinc.vos.app.configure.model.destination.OriginOutput

outputType

Type of the output

true

enum (IP, ORIGIN, HARMONIC_CLOUDLINK, ZIXI, HSP, OTT_PLAYOUT, SRT, CLOUD, ASI, SDI)

psiSiTableSpoolingConfig

Settings of PSI/SI table Spooling

false

com.harmonicinc.vos.app.configure.model.destination.PsiSiTableSpoolingConfig array

rank

Priority of output to be used

true

integer (int32)

redundancyMode

The output Redundancy mode

true

enum (MANDATORY, STANDBY, DISABLED)

sdiSettings

Settings of an SDI output

false

com.harmonicinc.vos.app.configure.model.destination.SDI_Output

com.harmonicinc.vos.app.configure.model.destination.PoolBinding

Name Description Required Schema Default

complexityIp

IP address for the divitrack complexity message

false

string

complexityPort

Port for the divitrack complexity message

false

integer (int32)

divitrackCircuitId

Divitrack circuit Id

false

integer (int32)

divitrackMaxBitrate

Maximum bitrate for the VBR output in bps

false

integer (int32)

divitrackMinBitrate

Minimum bitrate for the VBR output in bps

false

integer (int32)

divitrackNominalBitrate

Nominal bitrate for the VBR output in bps

false

integer (int32)

divitrackPriority

Divitrack priority

false

enum (VERY_HIGH, HIGH, MEDIUM, LOW, VERY_LOW)

divitrackStillImageBitrate

StillImage bitrate for the VBR output in bps

false

integer (int32)

noDivitrack

Flag to indicate it is a special statmux destination type that does not run DiviTrack protocol (e.g. Used by DTA service)

false

boolean

operationMode

Divitrack operation mode

false

enum (STATMUX_VBR, STATMUX_CBR)

poolId

Id of the pool associated with this destination

false

string

stillImageDetectionMode

Divitrack still image detection mode

false

enum (DETECTION_OFF, DETECTION_ON)

com.harmonicinc.vos.app.configure.model.destination.PsiSiTableConfig

Name Description Required Schema Default

bitrate

bitrate

false

integer (int32)

pid

Pid

false

integer (int32)

psiSiContent

Base64 encoded PSI content

false

string

psiSiType

PSI/SI Type

false

enum (PAT, PMT, SDT, NIT, EIT, TDT)

com.harmonicinc.vos.app.configure.model.destination.PsiSiTableSpoolingConfig

Name Description Required Schema Default

psiSiTables

Table of PSI/SI Configuration

false

com.harmonicinc.vos.app.configure.model.destination.PsiSiTableConfig array

com.harmonicinc.vos.app.configure.model.destination.S3PublishSettings

Name Description Required Schema Default

authorizationSettings

Authorization credentials to S3 bucket

true

com.harmonicinc.vos.app.configure.model.destination.AuthorizationSettings

awsRegion

AWS region

true

string

bucketName

Amazon S3 bucket name

true

string

regionSeparator

Separator for aws region

true

string

relativePath

Path for defining unique channel

true

string

com.harmonicinc.vos.app.configure.model.destination.SDI_Output

Name Description Required Schema Default

card

card index, specify which SDI card will be used to output the stream

false

integer (int32)

gpio

manage the GPIO output feature

false

com.harmonicinc.vos.app.configure.model.destination.GpioOutput

muteOutputOnSignalLoss

mute the SDI output when the input is lost

false

boolean

port

port index, specify which physical port present on the SDI card will be used to output the stream.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.SrtOutputSettings

Name Description Required Schema Default

bandwidthOverhead

Srt bandwidth overhead

false

integer (int32)

blockingMode

Srt blocking mode

false

boolean

channelId

Srt channel id

false

string

channelName

Srt channel name

false

string

connectionMode

SRT connetion establishing mode

false

enum (LISTENER, CALLER)

encryptionParam

Srt encryption params

false

com.harmonicinc.vos.app.configure.model.SrtEncryptionParams

endpointSettings

Endpoints used for transmitting SRT stream.

false

com.harmonicinc.vos.app.configure.model.source.ZixiEndPointSetting array

latency

Srt latency

false

integer (int32)

streamId

false

string

timeout

Srt timeout

false

integer (int32)

com.harmonicinc.vos.app.configure.model.destination.ZixiEncryptionParams

Name Description Required Schema Default

encryptionKey

Zixi encryption key

false

string

encryptionType

Zixi encryption type

false

enum (ZIXI_AES_128, ZIXI_AES_192, ZIXI_AES_256, ZIXI_NO_ENCRYPTION)

com.harmonicinc.vos.app.configure.model.destination.ZixiOutputSettings

Name Description Required Schema Default

channelId

Zixi channel id

false

string

channelName

Zixi channel name

false

string

encryptionParam

Zixi encryption params

false

com.harmonicinc.vos.app.configure.model.destination.ZixiEncryptionParams

fecBlockMs

Zixi FEC block ms

false

integer (int32)

fecOverhead

Zixi FEC overhead

false

integer (int32)

latencyMode

Zixi latency mode

false

enum (ZIXI_LATENCY_STATIC, ZIXI_LATENCY_INCREASING, ZIXI_LATENCY_DYNAMIC)

maxLatency

Zixi max latency

false

integer (int32)

password

Zixi password

false

string

timeout

Zixi timeout

false

integer (int32)

user

Zixi user

false

string

com.harmonicinc.vos.app.configure.model.fullService.FullService

Name Description Required Schema Default

destinations

false

com.harmonicinc.vos.app.configure.model.destination.Destination array

service

false

com.harmonicinc.vos.app.configure.model.service.Service

sources

false

com.harmonicinc.vos.app.configure.model.source.Source array

com.harmonicinc.vos.app.configure.model.fullService.FullServiceIds

Name Description Required Schema Default

destinationsIds

false

string array

serviceId

false

string

sourcesIds

false

string array

com.harmonicinc.vos.app.configure.model.lsm.LSM

Name Description Required Schema Default

id

Unique identifier of a LSM endpoint in UUID format

false

string

ipAddress

IP address of a LSM endpoint

false

string

ipNetworkAddress

Network interface IP network address for connecting to LSM

false

string

ipPort

IP port of a LSM endpoint

false

integer (int32)

name

Display name of a LSM endpoint

false

string

com.harmonicinc.vos.app.configure.model.pool.Pool

Name Description Required Schema Default

divitrackIP

IP address for the divitrack rate message

false

string

divitrackIpNetworkAddress

Interface address for sending and receiving divitrack messages

false

string

divitrackPoolBitrate

Bitrate for the divitrack pool in bps

false

integer (int32)

divitrackPoolId

Divitrack pool id

false

integer (int32)

divitrackPoolLatencyMode

Latency mode for a divitrack pool

false

enum (DEFAULT, REDUCED, EXTENDED)

divitrackPort

Port for the divitrack rate message

false

integer (int32)

downstreamComplexityIpDelay

Network delay for the downstream complexity message

false

integer (int32)

downstreamIpDelay

Downstream network delay

false

integer (int32)

id

Unique identifier of a pool. If specified, pool source will not be created automatically.

false

string

labels

Labels attached to a pool for identification

false

string array

maxSourcesDelay

Maximum sources delay

false

integer (int32)

muxAddress

IP addresses of the mux

false

string array

name

Display name of a pool

false

string

poolMode

Rate mode for the pool

false

enum (VBR, CBR)

stcIp

IP address for the divitrack STC message

false

string

stcPort

Port for the divitrack STC message

false

integer (int32)

upstreamIpDelay

Upstream network delay

false

integer (int32)

useNominalBitrate

Use the provisioned nominal bitrate by user in destination object. If this value is false or absent, nominal bitrate will be determined automatically. (For internal use)

false

boolean

com.harmonicinc.vos.app.configure.model.service.Addons

Name Description Required Schema Default

affiliateAddon

Affiliate add-on

false

com.harmonicinc.vos.app.configure.model.service.AffiliateAddon

broadcasterIdAddon

BroadcasterId add-on

false

com.harmonicinc.vos.app.configure.model.service.BroadcasterIdAddon

captionsAddon

Captions addon

false

com.harmonicinc.vos.app.configure.model.service.CaptionsAddon

casAddon

CAS add-on

false

com.harmonicinc.vos.app.configure.model.service.CasAddon

demuxAddon

Demux add-on

false

com.harmonicinc.vos.app.configure.model.service.DemuxAddon

drmAddon

DRM add-on

false

com.harmonicinc.vos.app.configure.model.service.DrmAddon

easPropertiesAddon

Emergency Alert System related properties

false

com.harmonicinc.vos.app.configure.model.service.EasPropertiesAddon

inputMonitoringAddon

Input Monitoring add-on

false

com.harmonicinc.vos.app.configure.model.service.InputMonitoringAddon

kantarSnapWatermarkAddon

KantarSnapWatermark add-on

false

com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkAddon

liveEventAddon

Live Event add-on

false

com.harmonicinc.vos.app.configure.model.service.LiveEventAddon

logoAddon

Logo insertion add-on

false

com.harmonicinc.vos.app.configure.model.service.LogoAddon

muxAddon

Mux add-on

false

com.harmonicinc.vos.app.configure.model.service.MuxAddon

nielsenWatermarkAddon

NielsenWatermark add-on

false

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkAddon

operatorActionAddon

Operation action add-on

false

com.harmonicinc.vos.app.configure.model.service.OperatorActionAddon

parentalControlAddon

Parental Control add-on

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon

playoutSettingsAddon

Playout settings addon

false

com.harmonicinc.vos.app.configure.model.service.PlayoutSettingsAddon

scheduler360Addon

Scheduler360 add-on

false

com.harmonicinc.vos.app.configure.model.service.Scheduler360Addon

scte35SlateAddon

Configurations for SCTE35-triggered slates. If this object and all its compulsory fields are present, then SCTE-35 slate will be enabled.

false

com.harmonicinc.vos.app.configure.model.service.Scte35SlateAddon

slateWatermarkAddon

Slate A/B Watermark add-on

false

com.harmonicinc.vos.app.configure.model.service.SlateWatermarkAddon

synamediaWatermarkAddon

SynamediaWatermark add-on

false

com.harmonicinc.vos.app.configure.model.service.SynamediaWatermarkAddon

thumbnailExporterAddon

Export output thumbnail add-on

false

com.harmonicinc.vos.app.configure.model.service.ThumbnailExporterAddon

timeAdjustment

Time Adjustment add-on

false

com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon

timeAdjustmentAddon

false

com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon

timedEventAddon

Timed Event add-on

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon

trafficAddon

Traffic add-on

false

com.harmonicinc.vos.app.configure.model.service.TrafficAddon

videoInsertionAddon

Video insertion add-on

false

com.harmonicinc.vos.app.configure.model.service.VideoInsertionAddon

com.harmonicinc.vos.app.configure.model.service.AffiliateAddon

Name Description Required Schema Default

affiliateId

Id of affiliate

false

string

com.harmonicinc.vos.app.configure.model.service.BroadcasterIdAddon

Name Description Required Schema Default

origin

Id of affiliate

false

enum (ATSC, USER_DEFINED)

com.harmonicinc.vos.app.configure.model.service.CamAddon

Name Description Required Schema Default

camParameters

false

com.harmonicinc.vos.app.configure.model.service.CamAddon$CamParameters array

com.harmonicinc.vos.app.configure.model.service.CamAddon$CamParameters

Name Description Required Schema Default

progNums

List containing the Program Numbers to descramble with this CAM

true

integer (int32) array

slotId

CAM physical slot Id in DVB-CI card (Value 0 for CAM 1, 1 for CAM 2)

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.CaptionsAddon

Name Description Required Schema Default

captionsInfo

List of caption info

false

com.harmonicinc.vos.app.configure.model.service.CaptionsAddon$CaptionsInfo array

com.harmonicinc.vos.app.configure.model.service.CaptionsAddon$CaptionsInfo

Name Description Required Schema Default

captionsProvider

Captions Provider

true

enum (e_NCI)

tcpPort

TCP port for incoming captions. Supported ports: 20600…​20663

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.CasAddon

Name Description Required Schema Default

casSystems

List of Conditional Access System

true

com.harmonicinc.vos.app.configure.model.service.CasAddon$CasSystem array

enable

Enable Conditional Access System

true

boolean

com.harmonicinc.vos.app.configure.model.service.CasAddon$CasSystem

Name Description Required Schema Default

accessCriteria

false

string

casId

false

string

ecmId

false

string

com.harmonicinc.vos.app.configure.model.service.DecoderSettings

Name Description Required Schema Default

latency

The SDI latency parameters

false

com.harmonicinc.vos.app.configure.model.service.Latency

com.harmonicinc.vos.app.configure.model.service.DemuxAddon

Name Description Required Schema Default

camAddon

CAM add-on

false

com.harmonicinc.vos.app.configure.model.service.CamAddon

demuxType

e_DVB: monitoring data will include service name, type and provider extracted from SDT. e_ATSC : monitoring data will include short name and major/minor channel number extracted from VCT.

false

enum (e_DVB, e_ATSC)

descramblingKeys

List of descrambling keys associated to a program

false

com.harmonicinc.vos.app.configure.model.service.DescramblingKey array

descramblingPrograms

List of programs to descramble with BISS-CA

false

com.harmonicinc.vos.app.configure.model.service.DescramblingProgram array

highJitter

Enable support of source with high jitter. As a side effect, it increases the demux latency to 1 second

false

boolean

com.harmonicinc.vos.app.configure.model.service.DescramblingKey

Name Description Required Schema Default

keyId

Descrambling key associated to a program

true

string

programNum

Program Number

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.DescramblingProgram

Name Description Required Schema Default

programNum

Program Number

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.DpiTierSetting

Name Description Required Schema Default

authorizedDpiTiers

List of authorized/allowed dpi tiers. Incoming SCTE35 section will not be discarded if it contains one of these tiers. Range: 0-4094

false

integer (int32) array

blockScte35InputMessages

if set to true, discard all SCTE35 messages, regardless of tier value, except 0xFFF (4095)

false

boolean

com.harmonicinc.vos.app.configure.model.service.DrmAddon

Name Description Required Schema Default

customKeyRotationTime

Custom key rotation start time in UTC, represented in format of yyyy-MM-ddThh:mm:ssZ (e.g. 2021-03-04T12:34:56Z)

true

string (date-time)

enable

Switch for turn on or off DRM

true

boolean

settings

List of DRM Settings

true

com.harmonicinc.vos.app.configure.model.service.DrmAddon$DrmSetting array

com.harmonicinc.vos.app.configure.model.service.DrmAddon$DrmSetting

Name Description Required Schema Default

drmSystemId

DRM System ID

true

string

originOutputEndPointId

Origin Output EndPoint ID

true

string

resourceId

Resource ID

true

string

useFixedResource

Use fixed DRM Resource or not

false

boolean

com.harmonicinc.vos.app.configure.model.service.ESAM_ServiceSetting

Name Description Required Schema Default

acquisitionPointId

Used to map Signal Aquisition System element to this video service

false

string

passthroughOnInBandDisabled

Enable pass-through of input SCTE35 when in-band ESAM is disabled

false

boolean

poisEndpoint

POIS endpoint URL. If not specified, the default POIS endpoint configured in global service settings will be used.

false

string

poisNotifyOnlyMode

Enable the use of ESAM POIS Notify Only mode

false

boolean

timecodeReference

Enable the use of timecode reference for the UTC date in ESAM in-band and OOB messages. The input stream shall contain an UTC-based timecode.

false

boolean

tlsKeyId

TLS Key ID to be used to communicate with ESAM POIS

false

string

utcTimeOffset

UTC Time Offset to be added to ESAM OOB messages

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.EasPropertiesAddon

Name Description Required Schema Default

enableEas

To start/stop EAS (Emergency Alert System) on this service

false

boolean

groupId

Testing Group ID for this service. EAS global activeGroupId test events will run for this if

false

integer (int32)

stationId

Station-Id for this service. EAS events are addressed to StationIds

false

string

com.harmonicinc.vos.app.configure.model.service.EsamSourceSwitchSetting

Name Description Required Schema Default

fallbackTimeout

The timeout value (seconds) for ESAM source redundancy safety fallback mechanism, a mechanism to fallback to primary source from secondary source if there is no message from POIS, range from 10 to 300, default value is equal to 120

false

integer (int32)

proprietaryScte104VitcMode

Enable using VITC in SCTE-104 for source switching

false

boolean

com.harmonicinc.vos.app.configure.model.service.GraphicsAddon

Name Description Required Schema Default

graphicsTemplateId

Id of a graphic template in the system

false

string

rssUrl

Template Parameter used in a graphics template

false

string

com.harmonicinc.vos.app.configure.model.service.HourlyLogoInsertionEvent

Name Description Required Schema Default

endMinute

false

integer (int32)

endSecond

false

integer (int32)

startMinute

false

integer (int32)

startSecond

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.InputMonitoringAddon

Name Description Required Schema Default

enable

Switch for enabling input monitoring through HSP

true

boolean

com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkAddon

Name Description Required Schema Default

audFileId

Aud license file id (license with audience name/ID labels)

false

string

channelConfigs

List of KantarSnapWatermarkChannelConfig for each Audio Profile

false

com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkChannelConfig array

licFileId

LIC license file id (license to unlock the product SDK)

false

string

com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkChannelConfig

Name Description Required Schema Default

channelName

Watermark label name to apply to the channel

false

string

languageIndex

Index in match-by-language mode (unused otherwise)

false

integer (int32)

sourceLabel

Source label in match-by-label mode (unused otherwise)

false

string

com.harmonicinc.vos.app.configure.model.service.Latency

Name Description Required Schema Default

e2eLatency

End-to-end latency, in micro-seconds. It should be a multiple of the frame duration (1001000/30)

true

integer (int32)

enableTcPtpLatency

Enables end-to-end deterministic latency based on input timecode, genlock and PTP synchronization. Applicable for 29.97 fps video

true

boolean

jamTime

Daily jam time, in UTC hours. It shall be the same as the upstream timecode inserter. Range 0..23.

true

integer (int32)

utcTaiOffset

Offset between TAI and UTC, in seconds. Default is 37 seconds.

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.LiveEventAddon

Name Description Required Schema Default

confidenceMonitoring

Indicate that LiveEvent confidential monitoring is used.
false by default

false

boolean

endTimeInUtc

Specify live event end time (in UTC). Support only when serviceType is LIVE_EVENT. Time is represented in format of yyyy-MM-ddThh:mm:ssZ

false

string

recording

Indicate that LiveEvent records is used.
false by default

false

boolean

startTimeInUtc

Specify live event start time (in UTC) to ensure manifest in package output does not contain content earlier than the start time. Support only when serviceType is LIVE_EVENT. Time is represented in format of yyyy-MM-ddThh:mm:ssZ

false

string

com.harmonicinc.vos.app.configure.model.service.LogoAddon

Name Description Required Schema Default

groupMode

Indicate the logo mode : groups, or single logo for all the profiles

false

boolean

horizontalOffset

Horizontal offset relative to placement in pixel

false

integer (int32)

hourlySchedule

The schedule to insert logo periodically for each hour

false

com.harmonicinc.vos.app.configure.model.service.HourlyLogoInsertionEvent array

imageId

Id of an image in the system

true

string

logosList

List of logos to be inserted

false

com.harmonicinc.vos.app.configure.model.service.LogoAddon$LogoForLogosList array

logosListForGroupMode

logo used for the mode group

false

com.harmonicinc.vos.app.configure.model.service.LogoAddon$LogoForGroupMode array

placement

Image placement

false

enum (BOTTOM_LEFT, BOTTOM_RIGHT, TOP_LEFT, TOP_RIGHT)

verticalOffset

Vertical offset relative to placement in pixel

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.LogoAddon$LogoForGroupMode

Name Description Required Schema Default

horizontalOffset

Horizontal offset relative to placement in pixel

false

integer (int32)

imageId

Id of an image in the system

true

string

logoSlateGroupLabel

label of the profile group to have logo inserted per profile

true

string

placement

Image placement

false

enum (BOTTOM_LEFT, BOTTOM_RIGHT, TOP_LEFT, TOP_RIGHT)

verticalOffset

Vertical offset relative to placement in pixel

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.LogoAddon$LogoForLogosList

Name Description Required Schema Default

horizontalOffset

Horizontal offset relative to placement in pixel

false

integer (int32)

imageId

Id of an image in the system

true

string

placement

Image placement

false

enum (BOTTOM_LEFT, BOTTOM_RIGHT, TOP_LEFT, TOP_RIGHT)

uuid

false

string

verticalOffset

Vertical offset relative to placement in pixel

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.MuxAddon

Name Description Required Schema Default

bandwidth

Bitrate of output stream in bps

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkAddon

Name Description Required Schema Default

nielsenWatermarkConfig

List of NielsenWatermarkConfig for each Audio Profile

false

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkConfig array

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkConfig

Name Description Required Schema Default

languageIndex

Audio index used to mapping the languages defined in Configure app’s setting, support up to 16 audio tracks, range 1~16

false

integer (int32)

nielsenWatermarkProperties

Nielsen Watermark Properties used to override the deprecated values found in the profile

false

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkProperties

sourceLabel

Label of the source stream to be processed

false

string

com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkProperties

Name Description Required Schema Default

cbetCheckDigits

CBET CheckDigits

false

string

cbetSid

CBET Sid

false

integer (int32)

checkDigits

Check Digits

false

string

sid

Sid

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.OperatorActionAddon

Name Description Required Schema Default

muteOperation

Enabled mute/unmute service output ability

false

boolean

com.harmonicinc.vos.app.configure.model.service.OrchestrationLabel

Name Description Required Schema Default

key

false

string

value

false

string

com.harmonicinc.vos.app.configure.model.service.OrchestrationNodeSelector

Name Description Required Schema Default

key

false

string

value

false

string

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon

Name Description Required Schema Default

callbackServer

The request settings used by callback server

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$CallbackServer

callbackUrl

The callback endpoint used to listen on the parental control insertion status

false

string

channelId

The ID is used by Parental Control API to identify the service

false

string

commandScheduler

The request settings used by command scheduler

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$CommandScheduler

hlsID3Pid

The HLS parental control ID3 PID

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$Authentication

Name Description Required Schema Default

enable

The boolean to determine if enable authentication or not

false

boolean

password

The password of authentication settings

false

string

username

The username of authentication settings

false

string

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$CallbackServer

Name Description Required Schema Default

authentication

The authentication settings of callback server

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$Authentication

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$CommandScheduler

Name Description Required Schema Default

authentication

The authentication settings of command scheduler

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$Authentication

endpoint

The endpoint of command scheduler

false

string

triggerRepublishOnEmptySchedule

The trigger republish on empty schedule settings of command scheduler

false

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$TriggerRepublishOnEmptySchedule

com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon$TriggerRepublishOnEmptySchedule

Name Description Required Schema Default

enable

The boolean to determine if enable trigger republish on empty schedule

false

boolean

intervalInMinutes

The interval in minutes to trigger republish on empty schedule

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.PlayoutLayer

Name Description Required Schema Default

layerId

Playout graphic layer ID, range: 1..8

true

integer (int32)

com.harmonicinc.vos.app.configure.model.service.PlayoutSettingsAddon

Name Description Required Schema Default

cleanLayers

List of clean layers (layers without graphic overlays)

false

com.harmonicinc.vos.app.configure.model.service.PlayoutLayer array

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters

Name Description Required Schema Default

audioProperties

Contains the override values for Audio properties that match on the profile for the given service.

false

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$AudioProperties array

dataProperties

Sets the data information for ProcessingParameters

false

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$DataProperties

decoderSettings

Sets the decoder settings for ProcessingParameters

false

com.harmonicinc.vos.app.configure.model.service.DecoderSettings

streamConditioning

The setting for stream conditioning mode

false

enum (AUTO, ESAM_CONDITIONING_INFO, NONE)

videoProperties

Contains override values for Video properties that match on the profile for the given service.

false

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$VideoProperties

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$AudioProperties

Name Description Required Schema Default

aacHeader

By default, aacHeader of the profile is used, or ADTS if aacHeader is not defined in the profile

false

enum (e_ADTS, e_LATM)

ac4IframeInterval

Range 12..1000 when video frame-rate is 25 or 50 fps, range=14..1000 when video frame-rate is 29.97 or 59.94 fps. By default, ac4IframeInterval of the profile is used

false

integer (int32)

bitrate

Audio bitrate in kbps. Valid values are dependent on the codec, number of channels and sample rate. By default, bitrate of the profile is used.

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

Valid values are Pass-through, Stereo (all codecs), Mono (all codecs except AAC-HEv2), 5.1 (AAC-LC, HE-AACv1, AC-3, EAC-3, AC-4), 5.1.4 (EAC-3, AC-4). By default, channels of the profile is used

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

gain

Static gain applied to the audio, in dB. Range -20..20. By default, gain of the profile is used.

false

integer (int32)

languageIndex

Applicable when profile is in match-by-language mode. This index will be used to match the language configured in the profile. The audioProperties will apply for the profile’s audio track for the matching language index.

false

integer (int32)

sampleRate

Audio sampling in kHz. Valid values are 16 (AAC-LC mono/stereo), 32 (AAC, MP1L2), 44 (AAC mono), 48 (all). By default, sampleRate of the profile is used.

false

enum (e_16, e_32, e_44, e_48)

sourceLabel

Applicable when the profile is in match-by-label mode. This label will be used to match the label configured in the profile. The audioProperties will apply for the profile’s audio track for the matching label.

false

string

targetlevel

Applicable when HALC is used (i.e. audioLevelAlgorithm is e_HALC in the profile), or when target level mode is used (i.e. audioLevelAlgorithm is e_StaticGain and targetLevel is not e_None in the profile). In dBFS when audioLevelAlgorithm is e_StaticGain or when alcMode is e_A_WEIGHTING, in LKFS when alcMode is e_ATSC_A85 or e_EBU_R128. e_None, e_m15, e_m16 are not valid values. By default, targetlevel of the profile is used.

false

enum (e_None, e_m15, e_m16, e_m17, e_m18, e_m19, e_m20, e_m21, e_m22, e_m23, e_m24, e_m25, e_m26, e_m27, e_m28, e_m29, e_m30, e_m31)

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$DataProperties

Name Description Required Schema Default

cc608To708Translation

e_NEVER : output CEA-708 is the input CEA-708, e_ALWAYS: the input CEA-708 is always ignored and output CEA-708 is generated from input CEA-608, and no input CEA-608 means no output CEA-708 and e_AUTOSENSE : strategy automatically defined. Default behavior depends on STBmode.

false

enum (e_AUTOSENSE, e_ALWAYS, e_NEVER)

generateTimecode

Enable Timecode Generation. When it is enabled, the generated timecode will replace the timecode in the source and override enableVitcOutput to true. The generated timecode does not works with geo-sync because of up to few hundred ms of inaccuracy. Default is 'e_DISABLED'

false

enum (e_DISABLED, e_UTC)

teletextOverSdiOutput

The setting for teletext output format. Default is 'e_OP_47'

false

enum (e_WST, e_OP_47, e_OP_42, e_SMPTE_2031)

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters$VideoProperties

Name Description Required Schema Default

aspectRatio

Applicable only for SD resolutions: 576i and 480i. By default the aspectRatio of the profile is used.

false

enum (e_16_9, e_4_3, e_PASSTHROUGH)

goplenM

Mini GOP Length M. By default the goplenM of the profile is used.

false

enum (e_AUTO, e_IP, e_IBP, e_IBBP, e_IBBBP, e_IBBBBBBBP)

goplenN

GOP Length. Range 1..96 inclusive. By default the goplenN of the profile is used.

false

integer (int32)

gopoption

By default the gopoption of the profile is used.

false

enum (e_OPEN_FIXED, e_OPEN_VARIABLE, e_OPEN_CAPPED, e_CLOSED_FIXED, e_CLOSED_VARIABLE, e_OPEN_FIXED_M, e_CLOSED_FIXED_M)

irisVQBoost

Improves VQ by adjusting the setting of each video filter based on input frames. By default the irisVQBoost of the profile is used.

false

enum (e_DISABLED, e_ENABLED)

latencyOption

Valid values are e_LOW, e_REDUCED, e_DEFAULT. By default the latencyOption of the profile is used.

false

enum (e_2_5, e_3_5, e_5_5, e_LOW, e_REDUCED, e_DEFAULT)

resolutionHV

Defines the horizontal resolution of video. It shall be consistent with the 'resolution' property of the profile. By default, the 'resolutionHV' of the profile is used.

false

enum (e_352x480I, e_480x480I, e_528x480I, e_544x480I, e_640x480I, e_704x480I, e_720x480I, e_352x576I, e_480x576I, e_528x576I, e_544x576I, e_640x576I, e_704x576I, e_720x576I, e_640x720P, e_960x720P, e_1280x720P, e_960x1080I, e_1280x1080I, e_1440x1080I, e_1920x1080I, e_960x1080P, e_1280x1080P, e_1440x1080P, e_1920x1080P, e_2560x1440P, e_3200x1800P, e_3840x2160P, e_960x540P, e_FOLLOW_INPUT)

stressBias

Controls the stress on the encoded content at various bitrates. By default the stressBias of the profile is used.

false

enum (e_CLEAN, e_BALANCED, e_SHARP)

com.harmonicinc.vos.app.configure.model.service.ResourceSettingsAddon

Name Description Required Schema Default

cpu

false

number (double)

cpuLimit

false

number (double)

gpu

false

number (double)

memory

false

number (double)

com.harmonicinc.vos.app.configure.model.service.Scheduler360Addon

Name Description Required Schema Default

channelId

This ID is used connect Scheduler 360

false

string

com.harmonicinc.vos.app.configure.model.service.Scte35SlateAddon

Name Description Required Schema Default

enableVideoSlate

Enable run-time update on video slate (graphicFilename). default = false

false

boolean

graphicFilename

Filename of a graphic in the Asset Acquisition App to be used as the slate video

false

string

imageId

Id of an image in the system to be used as the slate image

false

string

trigger

Trigger of scte35 slate insertion mode.

false

enum (e_AUTO, e_ESAM_ALTERNATE_CONTENT)

zoneIdentity

Zone identity of acquisition point.

false

string

com.harmonicinc.vos.app.configure.model.service.Service

Name Description Required Schema Default

addons

Add-ons to a service; e.g. Logo

false

com.harmonicinc.vos.app.configure.model.service.Addons

availabilityZone

Availability zone where the service shall run

false

string

controlState

Control state of a service

false

enum (ACTIVATED, TEST, OFF)

deploymentInformation

Additional deployment information

false

com.harmonicinc.vos.app.configure.model.service.deployment.DeploymentInformation

destinationId

Id of destination connected to a service

false

string

destinationsId

List of destination connected to a service

false

string array

dynamicProgramMode

Specify the dynamic program mode of a service

false

enum (ON, OFF)

extraVideoDelay

This overrides the same param in LabWizard profile

false

integer (int32)

geoRedundancyMode

Specify the geographic redundancy mode of a service

false

enum (ON, OFF, AUTO)

geoRedundancyTimeReference

Specify the geographic redundancy time reference of a service

false

enum (AUTO, VITC)

id

Unique identifier of a service in UUID format

false

string

labels

Labels attached to service for identification

false

string array

name

Display name of a service

false

string

orchestrationLabels

Labels for service orchestration

false

com.harmonicinc.vos.app.configure.model.service.OrchestrationLabel array

orchestrationNodeSelectors

Labels for service node selector

false

com.harmonicinc.vos.app.configure.model.service.OrchestrationNodeSelector array

pauseGeoRedundancy

Declare if Geo redundancy is paused.

false

boolean

priority

Priority of a service (low, normal, high)

false

enum (LOW, NORMAL, HIGH)

processingParameters

Processing parameters

false

com.harmonicinc.vos.app.configure.model.service.ProcessingParameters

profileId

Id of profile used by a service

true

string

programNum

Program number of a service

false

integer (int32)

redundancyMode

Specify the redundancy mode of a service; Service rank will take effect if it’s on

false

enum (ON, OFF)

sdiAudioFormats

list of output sdi audio format (maximum 8 audio formats)

false

enum (PCM_stereo, PCM_5_1, Passthrough) array

serviceSources

Sources connected to a service

false

com.harmonicinc.vos.app.configure.model.service.ServiceSource array

serviceTrackingMode

Specify the service tracking mode of a service

false

enum (ON, OFF)

serviceTrackingSetting

Specify the service tracking settings of a service

false

com.harmonicinc.vos.app.configure.model.service.ServiceTrackingSetting

serviceType

Type of service. Specifies if the SSPE POD should be kept alive after service become OFFLINE

false

enum (LIVE, LIVE_EVENT)

sourceFailoverConditions

Specify type of SourceFailoverCondition of a service

false

com.harmonicinc.vos.app.configure.model.SourceFailoverCondition array

sourceSwitchSetting

Source switch setting

false

com.harmonicinc.vos.app.configure.model.service.SourceSwitchSetting

subServices

Multi Encoding Profiles Sevice

false

com.harmonicinc.vos.app.configure.model.service.SubService array

com.harmonicinc.vos.app.configure.model.service.ServiceSource

Name Description Required Schema Default

rank

Priority of source to be used

false

integer (int32)

sourceId

Id of source connected to a service

false

string

sourceSwitchBufferSize

Specify the buffer size (in ms) of source introducing source delay for doing frame synchronized source switch, range from 0 - 20000

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.ServiceTrackingSetting

Name Description Required Schema Default

outputFollowInputPid

Default to false where the output PID will follow the PID in source configuration or the PID in the labwizard encoding profile if it is defined. When set to true, the output PID will follow the PID in the input stream (ignoring the PID specified in source configuration and labwizard encoding profile). This parameter is ignored (same as false) when serviceTrackingMode is OFF.

false

boolean

pidOffset

Default to 0 and ignored if outputFollowInputPid = false. pidOffset will be applied to the output PID so output PID = input PID + pidOffset when outputFollowInputPid = true. A modulo is applied if input PID + pidOffset is outside the range of 32 to 8175 so if input PID = 8174 and pidOffset = 2, the output PID will be 33.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.SlateWatermarkAddon

Name Description Required Schema Default

image_a_Id

Id of an image for generating output with watermark A

false

string

image_b_Id

Id of an image for generating output with watermark B

false

string

slateWatermarkType

Type of Slate Watermark

false

enum (e_SLATE_IMAGE, e_VIACCESS_ORCA)

com.harmonicinc.vos.app.configure.model.service.SourceSwitchSetting

Name Description Required Schema Default

esamSourceSwitchSetting

The setting for ESAM source switch trigger mode

false

com.harmonicinc.vos.app.configure.model.service.EsamSourceSwitchSetting

inactiveSourceHandling

Specify the mode to stop decoding the inactive source for source redundancy service. Default is 'e_AUTO' - Fully decode both sources

false

enum (e_AUTO, e_FULLY_DECODE, e_NO_RECEIVE)

primaryStableTime

Specify the time for primary source to be considered stable in seconds, range 60..86400, default 60s. Only applicable when sourceSwitchTrigger is e_PRIMARY_STABLE.

false

integer (int32)

sourceSwitchTrigger

Specify the source switch trigger mode of service. ([‘e_SOURCE_FAILURE’, ‘e_ESAM’, ‘e_MANUAL’, ‘e_PRIMARY_STABLE’], default is 'e_SOURCE_FAILURE')

false

enum (e_SOURCE_FAILURE, e_ESAM, e_MANUAL, e_PRIMARY_STABLE)

triggerSettings

CC error trigger settings

false

com.harmonicinc.vos.app.configure.model.service.TriggerSettings

com.harmonicinc.vos.app.configure.model.service.SubService

Name Description Required Schema Default

addons

Add-ons to a service; e.g. Logo

false

[com.harmonicinc.vos.app.configure.model.service.ProfileAddons]

destinationsId

List of destination connected to a service

false

string array

dynamicProgramMode

Specify the dynamic program mode of a service

false

enum (ON, OFF)

id

Unique identifier of a service in UUID format

false

string

labels

Labels attached to service for identification

false

string array

profileId

Id of profile used by a service

true

string

programNum

Program number of a service

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.SynamediaWatermarkAddon

Name Description Required Schema Default

channelId

Specify channel ID for a specific stream

false

string

watermarkType

Get watermark type for synamedia watermark

false

enum (e_WATERMARKING, e_SEI_INSERTION)

com.harmonicinc.vos.app.configure.model.service.ThumbnailExporterAddon

Name Description Required Schema Default

exportPath

The path to write the Thumbnails

false

string

generationInterval

Wanted generation interval for the thumbnails

true

integer (int32)

height

Vertical size of the thumbnails

false

integer (int32)

password

Credentials for FTP server

false

string

prefix

Prefix to name the generated thumbnails

false

string

suffix

The suffix mode for the thumbnail filenames

false

enum (e_TIMESTAMP, e_NONE)

userName

Credentials for FTP server

false

string

width

Horizontal size of the thumbnails

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon

Name Description Required Schema Default

timeAdjInMs

Time Adjustment in millisecond

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon

Name Description Required Schema Default

callbackServer

The request settings used by callback server

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$CallbackServer

callbackUrl

The callback endpoint used to listen on the parental control insertion status

false

string

channelId

The ID is used by Timed Event API to identify the service

false

string

commandScheduler

The request settings used by command scheduler

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$CommandScheduler

hlsParentalControlID3Pid

The HLS parental control ID3 PID

false

integer (int32)

hlsPeacockEventID3Pid

The HLS peacock timed event ID3 PID

false

integer (int32)

timedEventType

Timed Event type to identify the service

false

enum (e_PARENTAL_CONTROL, e_PEACOCK_EVENT, e_DATE_RANGE_EVENT)

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$Authentication

Name Description Required Schema Default

enable

The boolean to determine if enable authentication or not

false

boolean

password

The password of authentication settings

false

string

username

The username of authentication settings

false

string

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$CallbackServer

Name Description Required Schema Default

authentication

The authentication settings of callback server

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$Authentication

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$CommandScheduler

Name Description Required Schema Default

authentication

The authentication settings of command scheduler

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$Authentication

endpoint

The endpoint of command scheduler

false

string

triggerRepublishOnEmptySchedule

The trigger republish on empty schedule settings of command scheduler

false

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$TriggerRepublishOnEmptySchedule

com.harmonicinc.vos.app.configure.model.service.TimedEventAddon$TriggerRepublishOnEmptySchedule

Name Description Required Schema Default

enable

The boolean to determine if enable trigger republish on empty schedule

false

boolean

intervalInMinutes

The interval in minutes to trigger republish on empty schedule

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.TrafficAddon

Name Description Required Schema Default

trafficId

Id of traffic system

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.TriggerSettings

Name Description Required Schema Default

ccErrorsThreshold

CC error trigger threshold - range 1..10000, default 120 - Switch will occur as soon as we reach this number of CC errors during last CC error window

false

integer (int32)

ccErrorsWindow

CC error trigger window - range 10..3600 seconds, default 60, step 5 seconds

false

integer (int32)

com.harmonicinc.vos.app.configure.model.service.VideoInsertionAddon

Name Description Required Schema Default

dpiTierSetting

DPI tier setting, to configure allowing incoming SCTE35 messages only from the specified list of tier values

false

com.harmonicinc.vos.app.configure.model.service.DpiTierSetting

esamServiceSetting

ESAM service setting

false

com.harmonicinc.vos.app.configure.model.service.ESAM_ServiceSetting

com.harmonicinc.vos.app.configure.model.service.deployment.DeploymentInformation

Name Description Required Schema Default

accountPrefix

Account prefix

false

string

deploymentId

Instance deployment id

false

string

deploymentType

Instance deployment type

false

string

deviceName

Device name

false

string

platformRegionZone

Instance platform region zone

false

string

com.harmonicinc.vos.app.configure.model.source.AsiInput

Name Description Required Schema Default

asiCard

Specify which ASI card to receive the input (value 0 for card 1, and so on).

true

integer (int32)

asiPort

Specify which port of the ASI card to receive the input (value 0 for port 1, and so on).

true

integer (int32)

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

tsProgramNumber

Indicates the maximum number of programs that can be transcoded from this input.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.AtscTuner

Name Description Required Schema Default

channel

Channel. Integer range. Minimum : 2. Maximum : 51. Steps : 1.

true

integer (int32)

standard

Standard. Possible values : ATSC_1_0.

true

enum (ATSC_1_0)

com.harmonicinc.vos.app.configure.model.source.AudioGrooming

Name Description Required Schema Default

tracks

Essential metadata of audio tracks

false

com.harmonicinc.vos.app.configure.model.source.AudioTrack array

com.harmonicinc.vos.app.configure.model.source.AudioPreferredProperty

Name Description Required Schema Default

iso639AudioType

Preferred audio ISO639 type. Set to null to match any type

false

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE)

language

Preferred audio track language. Expects 3 letter abbreviation based on ISO639 (e.g. ENG, FRA) and set to null to match any language

false

string

com.harmonicinc.vos.app.configure.model.source.AudioTrack

Name Description Required Schema Default

audioPreferredProperties

Preferred audio properties of audio track for mapping

false

com.harmonicinc.vos.app.configure.model.source.AudioPreferredProperty array

audioStreamType

Input audio stream type

false

enum (MPEG, AAC, DOLBY_E, DOLBY_DIGITAL, DOLBY_DIGITAL_PLUS, DOLBY_AC4, AES3, PCM)

audioTrackIndex

Index of the audio track

false

integer (int32)

audioTrackStreamType

Type of the audio stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types

false

integer (int32)

backUpAudioTrackIndex

Index of the backup audio track

false

integer (int32)

countryCode

Optional Country Code to append to the Language Code

false

string

delayAdjustment

Specifies the audio delay in millisecond in order to synchronize the video stream, valid range from -500 to 500 ms

false

integer (int32)

dolbyEProgramNumber

Source DolbyE program number for the audio (range 1 to 8)

false

integer (int32)

forceAtmos

Force Dolby Atmos detection for E-AC-3

false

boolean

hasNielsenWatermark

Indicate this audio stream has Nielsen watermark

false

boolean

inputLevel

Audio input level

false

integer (int32)

insertNullPidOnSignalLoss

Indicate insertion of nulls when there is audio signal loss

false

boolean

isDefault

Indicate this audio is default

false

boolean

labels

Labels identifier of the audio track

false

string array

locator

Locator of the audio track

true

com.harmonicinc.vos.app.configure.model.source.AudioTrackLocator

silenceDetectionThreshold

Silence detection threshold (-65dB)

false

integer (int32)

skipProcessing

Indicate this audio stream will not be processed and will not be mux.

false

boolean

streamName

Custom stream name

false

string

useDiscovery

Indicate the usage of the discovery to know the audio input level

false

boolean

com.harmonicinc.vos.app.configure.model.source.AudioTrackLocator

Name Description Required Schema Default

channelId

Specify how to locate an audio track

false

string

channelList

For SMPTE302M Audio channel selection on audio stream and audio channels

false

com.harmonicinc.vos.app.configure.model.source.Smpte302mChannelList array

pid

Pid of the audio stream

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.CaptionServiceDescriptor

Name Description Required Schema Default

captionServiceDescriptorData

false

com.harmonicinc.vos.app.configure.model.source.CaptionServiceDescriptorData array

com.harmonicinc.vos.app.configure.model.source.CaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number of caption service in the range [1..63] if digital_cc == 1. It has no meaning if digital_cc == 0

true

integer (int32)

countryCode

Optional Country Code to append to the Language Code

false

string

defaultSubtitle

Whether or not the caption service stream is the stream for default subtitle

false

boolean

digitalCc

Digital CC of caption service: 0⇒608, 1⇒708

true

integer (int32)

easyReader

Easy reader of caption service. It has no meaning if digital_cc == 0

true

integer (int32)

language

ISO 639.2/B 3 character language code of caption service. It has no meaning if digital_cc == 0

true

string

line21Field

Line21 field if digital_cc == 0. It has no meaning if digital_cc == 1

true

integer (int32)

streamName

Custom stream name

false

string

wideAspectRatio

Wide aspect ratio of caption service: 0=4/3, 1=16/9. It has no meaning if digital_cc == 0

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.CloudInputSettings

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

backupPipeId

Identifier backup pipe the source originates from

false

string

cloudInputType

Cloud input type

false

enum (CLOUD_SOURCE, CLOUD_EDGE)

cloudResourceMode

Cloud resource mode, determines whether a single stream or multiple different streams are used

false

enum (SHARED, DEDICATED)

egressPointId

Identifier egressPoint the source originates from

false

string

egressPointObjectId

Identifier egressPoint object the source originates from

false

string

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

name

CloudSource name the source originates from

false

string

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

pipeId

Identifier pipe the source originates from

false

string

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

protocol

SRT protocol

false

string

region

Region

false

string

regionDisplayName

Region display name

false

string

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

srtCloudInputSettings

Cloud srt input settings

false

com.harmonicinc.vos.app.configure.model.SrtCloudInputSettings

userStreamId

Stream ID for cloud resource

false

string

com.harmonicinc.vos.app.configure.model.source.CloudSourceInput

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

backupPipeId

Identifier pipe the backup source

false

string

connectionMode

SRT connetion establishing mode

false

enum (LISTENER, CALLER)

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

name

CloudSource name the source originates from

false

string

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

pipeId

Identifier pipe the source originates from

false

string

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

protocol

SRT protocol

false

string

region

Region

false

string

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

srtCloudSourceSettings

Basic cloudSource settings. Used in CloudSource Input

false

com.harmonicinc.vos.app.configure.model.source.SrtCloudSourceSettings

com.harmonicinc.vos.app.configure.model.source.CroppingSettings

Name Description Required Schema Default

bottom

Number of pixels to crop at the bottom of the input video. Shall not be negative. Input height minus 'top' and 'bottom' shall be greater than 64.

false

integer (int32)

left

Number of pixels to crop at the left of the input video. Shall not be negative. Width minus 'left' and 'right' shall be greater than 64.

false

integer (int32)

right

Number of pixels to crop at the right of the input video. Shall not be negative. Width minus 'left' and 'right' shall be greater than 64.

false

integer (int32)

top

Number of pixels to crop at the top of the input video. Shall not be negative. Input height minus 'top' and 'bottom' shall be greater than 64.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.CspCoreProperties

Name Description Required Schema Default

insertionPeriodMs

insertion Period Ms

false

integer (int32)

segmentationEventId

segmentation Event Id String

false

integer (int64)

segmentationUpid

segmentation Upid

false

string

segmentationUpidType

segmentation Upid Type

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.CustomDescriptor

Name Description Required Schema Default

descriptorContent

Content of descriptor represented in HEX string

true

string

descriptorTag

Tag of descriptor

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.CustomSlateSettings

Name Description Required Schema Default

muteAudio

Specify the audio should be muted or not when slate is on

true

boolean

com.harmonicinc.vos.app.configure.model.source.DataGrooming

Name Description Required Schema Default

ccConversionMode

Prefered Closed Caption type

false

enum (AUTO, EIA608, CEA708)

st2038Tracks

ANC data tracks in ST-2038 PID

false

com.harmonicinc.vos.app.configure.model.source.St2038Track array

teletextSubtitleMode

Teletext subtitle parsing mode

false

enum (EBU_TELETEXT, CAVENA_P31)

tracks

Essential metadata of data tracks

false

com.harmonicinc.vos.app.configure.model.source.DataTrack array

com.harmonicinc.vos.app.configure.model.source.DataTrack

Name Description Required Schema Default

countryCode

Optional Country Code to append to the Language Code

false

string

dataTrackStreamType

Type of the data stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types

false

integer (int32)

dpiPidIndex

This parameter enables out-of-band SCTE-104, and provides the associated dpi_pid_index. When out-of-band SCTE-104 is enabled, in-band input SCTE-35 messages are discarded

false

integer (int32)

dtmfSettings

Optional DTMF settings

false

com.harmonicinc.vos.app.configure.model.source.DtmfSettings

labels

Labels identifier of the data stream

false

string array

ocrConversionBackgroundColor

Specifies DVB Subtitles background color for OCR conversion

false

string

pid

PID of the stream

false

integer (int32)

ptsSettings

Optional PTS restamping properties

false

com.harmonicinc.vos.app.configure.model.source.PtsSettings

skipProcessing

Indicate this data stream will not be processed and will not be mux.

false

boolean

streamName

Custom stream name

false

string

teletextToDvbSubsSetting

Obsolete

false

com.harmonicinc.vos.app.configure.model.source.TeletextToDvbSubsSetting

com.harmonicinc.vos.app.configure.model.source.DelayLine_Input

Name Description Required Schema Default

delay

Delay in milliseconds. Minimum value is 180000 (ie 3 minutes). It shall be lower than the recording buffer size of the corresponding Loop Record service.

true

integer (int64)

delayUpdate

Enables a scheduled update of the delay, for example for next daylight saving time transition. nextDelay and nextDelayActivationDate shall be configured.

false

boolean

nextDelay

Next delay value in milliseconds

false

integer (int64)

nextDelayActivationDate

UTC date when the next delay will be applied. It is expressed by a string with the following format "yyyy-mm-dd hh:mm:ss" ( ex: 2024-11-20 04:00:00 ).

false

string

recordId

Id of the Loop Record service that is recording the stream to play with a delay.

true

string

com.harmonicinc.vos.app.configure.model.source.DemuxInput

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

demuxServiceId

Indicates the uuid of the Demux service

true

string

disableAutoDelete

Disable the automatic deletion of the source when not used anymore after a mux update, False by default

false

boolean

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

com.harmonicinc.vos.app.configure.model.source.DtmfProfile

Name Description Required Schema Default

command

6-character command string built from the character set [0-9,*,#].

true

string

duration

For duration-based splice points, duration time in milliseconds.

true

integer (int32)

preRollTime

For normal splices points, pre-roll time in milliseconds, within range [4000, 25000], default: 4000.

true

integer (int32)

spliceMode

Splice mode: NO_DURATION, AUTO_RETURN, NO_AUTO_RETURN

true

enum (NO_DURATION, AUTO_RETURN, NO_AUTO_RETURN)

spliceType

Splice type: START_NORMAL, START_IMMEDIATE, END_NORMAL, END_IMMEDIATE

true

enum (START_NORMAL, START_IMMEDIATE, END_NORMAL, END_IMMEDIATE)

com.harmonicinc.vos.app.configure.model.source.DtmfSettings

Name Description Required Schema Default

audioSourceLabel

Label of audio track carrying the DTMF signal

true

string

profiles

List of DTMF profiles (min. 1, max. 6)

true

com.harmonicinc.vos.app.configure.model.source.DtmfProfile array

com.harmonicinc.vos.app.configure.model.source.DvbS2XPort

Name Description Required Schema Default

frequencySpectrum

22 kHz Tone. Applicable only when lnbType is UNIVERSAL or UNIVERSAL_WIDE.

false

enum (LOW_BAND, HIGH_BAND)

lnbType

LNB Type.

true

enum (C_BAND, KU_BAND, UNIVERSAL, UNIVERSAL_WIDE)

oscillatorFrequency

Local oscillator frequency in GHz. Decimal range depends on LNB Type. For C_BAND, range from 5Ghz to 6Ghz. For KU_BAND range from 8.5Ghz to 13Ghz. Not applicable for UNIVERSAL and UNIVERSAL_WIDE.

true

number (double)

com.harmonicinc.vos.app.configure.model.source.DvbS2XTuner

Name Description Required Schema Default

carrierFrequency

Carrier frequency. Decimal range. Minimum : 3. Maximum : 4.2. Steps : 0.000001.

true

number (double)

inversion

false

enum (AUTO, INVERTED, NORMAL)

modulationAndFec

false

enum (QPSK_1_2, QPSK_1_4, QPSK_1_3, QPSK_2_5, QPSK_3_5, QPSK_2_3, QPSK_3_4, QPSK_4_5, QPSK_5_6, QPSK_7_8, QPSK_8_9, QPSK_9_10, QPSK_13_45, QPSK_9_20, QPSK_11_20, QPSK_11_45, QPSK_4_15, QPSK_14_45, QPSK_7_15, QPSK_8_15, QPSK_32_45, _8PSK_3_5, _8PSK_2_3, _8PSK_3_4, _8PSK_5_6, _8PSK_8_9, _8PSK_9_10, _8PSK_23_36, _8PSK_25_36, _8PSK_13_18, _8PSKL_5_9, _8PSKL_26_45, _8PSK_7_15, _8PSK_8_15, _8PSK_26_45, _8PSK_32_45, _16APSK_2_3, _16APSK_3_4, _16APSK_4_5, _16APSK_5_6, _16APSK_8_9, _16APSK_9_10, _16APSK_26_45, _16APSK_3_5, _16APSK_28_45, _16APSK_23_36, _16APSK_25_36, _16APSK_13_18, _16APSK_7_9, _16APSK_77_90, _16APSKL_5_9, _16APSKL_8_15, _16APSKL_1_2, _16APSKL_3_5, _16APSKL_2_3, _16APSK_7_15, _16APSK_8_15, _16APSK_32_45, _32APSK_32_45, _32APSK_3_4, _32APSK_4_5, _32APSK_5_6, _32APSK_8_9, _32APSK_9_10, _32APSK_11_15, _32APSK_7_9, _32APSKL_2_3, _32APSK_2_3)

pilots

false

enum (AUTO, ON, OFF)

plsCode

Physical Layer Scrambling Seed. Integer range. Minimum : 0. Maximum : 262141. Steps : 1.

true

integer (int32)

polarization

Polarization. Possible values : VERTICAL (input #1) or HORIZONTAL (input #3).

true

enum (HORIZONTAL, VERTICAL)

rollOff

false

enum (AUTO, RO_0_05, RO_0_10, RO_0_15, RO_0_20, RO_0_25, RO_0_35)

symbolRate

Symbol rate. Decimal range. Minimum : 1. Maximum : 64. Steps : 0.000001.

true

number (double)

com.harmonicinc.vos.app.configure.model.source.DvbSubtitlingDescriptor

Name Description Required Schema Default

dvbSubtitlingDescriptorData

Data of DVB Subtitling Descriptor

true

com.harmonicinc.vos.app.configure.model.source.DvbSubtitlingDescriptorData array

com.harmonicinc.vos.app.configure.model.source.DvbSubtitlingDescriptorData

Name Description Required Schema Default

ancillaryPageId

Ancillary PageId of DVB data stream

true

integer (int32)

compositionPageId

Composition PageId of DVB data stream

true

integer (int32)

defaultSubtitle

Whether or not the DVB data stream is the stream for default subtitle

false

boolean

language

Language code of data stream

true

string

subtitlingType

Subtitling Type of DVB data stream

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.FrameRate

Name Description Required Schema Default

denominator

Denominator of framerate

true

integer (int32)

numerator

Numerator of framerate

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.G2OAuthConfig

Name Description Required Schema Default

enabled

false

boolean

g2oKey

false

string

g2oNonce

false

string

g2oVersion

false

string

com.harmonicinc.vos.app.configure.model.source.HSP_Input

Name Description Required Schema Default

authenticationHeader

Authentication header

false

com.harmonicinc.vos.app.configure.model.source.HspAuthenticationHeader

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

backupEndpointSettings

Backup Live ingest endpoint settings of the source for seamless input redundancy

false

com.harmonicinc.vos.app.configure.model.source.HspEndpointSettings

customHeaders

Custom headers

false

string array

g2oAuthConfig

G2O Authentication Configuration

false

com.harmonicinc.vos.app.configure.model.source.G2OAuthConfig

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

hspEndpoint

Internal Live ingest endpoint of the source

true

string

hspEndpointId

Live ingest endpoint Id of the source

true

string

inputBufferSettings

Input buffer settings

false

com.harmonicinc.vos.app.configure.model.source.HspInputBufferSettings

ipNetworkAddress

Network interface for downling the source. Applicable for XOS and VOS CNS only

false

string

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

publicHspEndpoint

Public Live ingest endpoint of the source

false

string

scte35Annotation

SCTE-35 annotation format

false

enum (NONE, BASE64_SCTE35_CUE)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

tsProgramNumber

Indicates the number of programs in the input TS

false

integer (int32)

variantPlaylistFileName

Playlist File Name of the source

true

string

com.harmonicinc.vos.app.configure.model.source.HarmonicCloudlinkSetting

Name Description Required Schema Default

ipAddress

IP address used to receive the input. IPv4 and IPv6 are supported

true

string

ipPort

UDP port used to receive the input

false

integer (int32)

ipPortRangeEnd

UDP port range end used to receive input

false

integer (int32)

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

type

false

enum (ZIXI, HSP)

uplinkGroupId

Unique identifier of the uplink Group

false

string

uplinkId

[Obsoleted]Unique identifier of the uplink

false

string

com.harmonicinc.vos.app.configure.model.source.HarmonicUplinkSetting

Name Description Required Schema Default

descramblingKey

CSA key to descramble input

false

string

descramblingRequired

Whether input requires descrambling

false

boolean

ipAddress

IP address used to receive the input. IPv4 and IPv6 are supported

true

string

ipPort

UDP port used to receive the input

false

integer (int32)

ipPortRangeEnd

UDP port range end used to receive input

false

integer (int32)

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

uplinkGroupId

Unique identifier of the uplink Group

false

string

uplinkId

[Obsoleted]Unique identifier of the uplink

false

string

com.harmonicinc.vos.app.configure.model.source.HspAuthenticationHeader

Name Description Required Schema Default

key

Key

true

string

value

Value

true

string

com.harmonicinc.vos.app.configure.model.source.HspEndpointSettings

Name Description Required Schema Default

authenticationHeader

Authentication header

false

com.harmonicinc.vos.app.configure.model.source.HspAuthenticationHeader

hspEndpoint

Internal Live ingest endpoint of the source

true

string

ipNetworkAddress

Network interface for downling the source. Applicable for XOS and VOS CNS only

false

string

publicHspEndpoint

Public Live ingest endpoint of the source

false

string

variantPlaylistFileName

Playlist File Name of the source

true

string

com.harmonicinc.vos.app.configure.model.source.HspInputBufferSettings

Name Description Required Schema Default

sizeSec

Target size of input buffer in seconds

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.IP_Input

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

descramblingKey

CSA key to descramble input

false

string

fecEnable

FEC 2022-1 1D colum and 2D column/line ingress recovery

false

boolean

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

ipAddress

IP address used to receive input. IPv4 and IPv6 are supported

true

string

ipNetworkAddress

IP network address

false

string

ipPort

UDP port used to receive input

true

integer (int32)

ipPortRangeEnd

UDP port range end used to receive input

false

integer (int32)

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

smpte20227TsInput

Settings of a seamless RTP 2022-7 TS input

false

com.harmonicinc.vos.app.configure.model.source.Smpte20227Ts_Input

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

tsProgramNumber

Indicates the number of programs in the input TS

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.ISO639Descriptor

Name Description Required Schema Default

iso639DescriptorData

Data of ISO639 Descriptor

true

com.harmonicinc.vos.app.configure.model.source.ISO639DescriptorData array

com.harmonicinc.vos.app.configure.model.source.ISO639DescriptorData

Name Description Required Schema Default

defaultSubtitle

Whether or not the ISO639 data stream is the stream for default subtitle

false

boolean

iso639AudioType

Audio Type of audio stream

true

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE)

language

Language code of stream

true

string

com.harmonicinc.vos.app.configure.model.source.Input

Name Description Required Schema Default

asiSettings

Settings of a ASI input

false

com.harmonicinc.vos.app.configure.model.source.AsiInput

cloudInputSettings

Settings of a Cloud input

false

com.harmonicinc.vos.app.configure.model.source.CloudInputSettings

cloudSourceSetting

Settings of a CloudSource input

false

com.harmonicinc.vos.app.configure.model.source.CloudSourceInput

cloudlinkSetting

false

com.harmonicinc.vos.app.configure.model.source.HarmonicCloudlinkSetting

delayLineSettings

Settings of a delay line input

false

com.harmonicinc.vos.app.configure.model.source.DelayLine_Input

demuxSettings

Settings of a demux input

false

com.harmonicinc.vos.app.configure.model.source.DemuxInput

id

Unique identifier of an input

false

string

ipSettings

Settings of an IP input

false

com.harmonicinc.vos.app.configure.model.source.IP_Input

ipSettingsList

Additional list of settings of IP input

false

com.harmonicinc.vos.app.configure.model.source.IP_Input array

labels

Labels identifier of an input

false

string array

ottPlayoutSettings

Settings of a OTT Playout input

false

com.harmonicinc.vos.app.configure.model.source.OttPlayoutInput

poolSettings

Settings of a POOL input

false

com.harmonicinc.vos.app.configure.model.source.PoolInput

rank

Priority of input to be used. When more than one input avaliable, the one with smaller number will be used as primary input

false

integer (int32)

rfSettingsV2

Settings of a RF input

false

com.harmonicinc.vos.app.configure.model.source.RfInputV2

slateSettings

Settings of a slate input

false

com.harmonicinc.vos.app.configure.model.source.SlateInput

srtSettings

Settings of an SRT input

false

com.harmonicinc.vos.app.configure.model.source.SrtInput

type

Source input type

false

enum (IP, SLATE, ZIXI, SRT, HSP, SDI, PLAYOUT, CLOUDLINK, RTMP, POOL, OTT_PLAYOUT, XOS, RF, WATERMARK, CLOUD, DEMUX, ASI, RIST, DELAYLINE)

zixiSettings

Settings of an Zixi input

false

com.harmonicinc.vos.app.configure.model.source.ZixiInput

com.harmonicinc.vos.app.configure.model.source.InputGrooming

Name Description Required Schema Default

bitrate

Bitrate of the input

false

integer (int32)

pcrCompliant

Not supported, for future use

false

boolean

pmtPid

PMT PID number of selected program

false

integer (int32)

programName

Program name of the input

false

string

com.harmonicinc.vos.app.configure.model.source.OttPlayoutInput

Name Description Required Schema Default

defaultAssetUrl

false

string

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

Name Description Required Schema Default

maxPcrInterval

Maximum PCR interval in milliseconds. Changing this value will trigger service restart and increase the end-to-end latency.

false

integer (int32)

maxPcrJitter

Maximum PCR jitter from real-time in milliseconds. Changing this value will trigger service restart and increase the end-to-end latency.

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.PlayoutAudioConfiguration

Name Description Required Schema Default

tracks

Essential metadata of audio tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutAudioTrack array

com.harmonicinc.vos.app.configure.model.source.PlayoutAudioTrack

Name Description Required Schema Default

labels

Labels of playout source

false

string array

language

3 letter langauge code similar to that of language descriptor

true

string

type

Audio codec of playout source

true

enum (MPEG, AAC, DOLBY_E, DOLBY_DIGITAL, DOLBY_DIGITAL_PLUS, DOLBY_AC4, AES3, PCM)

com.harmonicinc.vos.app.configure.model.source.PlayoutCaptionServiceDescriptor

Name Description Required Schema Default

captionServiceDescriptorData

false

com.harmonicinc.vos.app.configure.model.source.PlayoutCaptionServiceDescriptorData array

com.harmonicinc.vos.app.configure.model.source.PlayoutCaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number in the range [1..63]

true

integer (int32)

defaultSubtitle

Whether or not the caption service is the default subtitle

false

boolean

easyReader

Whether or not the caption service is of easy reader type

true

integer (int32)

language

ISO 639.2/B 3 character language code of the caption service

true

string

wideAspectRatio

Wide aspect ratio of the caption service: 0=4/3, 1=16/9

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.PlayoutDataConfiguration

Name Description Required Schema Default

tracks

Essential metadata of data tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutDataTrack array

com.harmonicinc.vos.app.configure.model.source.PlayoutDataTrack

Name Description Required Schema Default

dvbSubtitlingTracks

Essential metadata of DVB subtitling tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingConfiguration

labels

Labels of playout source

false

string array

teletextTracks

Essential metadata of teletext tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutTeletextConfiguration

type

Data stream type

true

enum (SCTE27, SCTE35, DVB_SUBTITLING, TELETEXT, ID3, ARIB37, UNKNOWN)

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingConfiguration

Name Description Required Schema Default

tracks

Essential metadata of DVB subtitling tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingTrack array

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingTrack

Name Description Required Schema Default

ancillaryPageID

Ancillary page ID of DVB subtitling track

true

integer (int32)

compositionPageID

Composition page ID of DVB subtitling track

true

integer (int32)

conversionParams

Conversion parameters

false

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingTrackConversionParams

enableConversion

Specifies if conversion parameters are enabled, default: false

false

boolean

language

Language code of DVB subtitling track

true

string

subtitlingType

Type of DVB subtitling track

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.PlayoutDvbSubtitlingTrackConversionParams

Name Description Required Schema Default

bkgTransparency

Background transparency, range: 0-100 (100 means no background).

true

integer (int32)

font

Font file name including dot-extension. Special case 'dejavu': stands for 'DejaVuSans.ttf'.

true

string

fontDensity

Horizontal font density, range: 0.5-2.5. A value of 1.0 equals 1em of the font. 2.0 will map 2em into the one cell.
For fixed sized fonts a value of 1 is recommended, but for true type a value of 1.7 looks much better.

true

number (double)

frameSize

Dvb subtitle frame size.

true

enum (e_1920x1080, e_1280x720, e_720x576, e_720x480)

minBitrate

Minimum bitrate in kbps.
A DVB subtitle keep-alive packet is a minimal PES packet made of 3 bytes:
0x20: data_identifier for DVB subtitles
0x00: subtitle_stream_id
0xFF: end_of_PES_data_field_marker

true

enum (e_3_00, e_1_50, e_0_75, e_0_50, e_0_38, e_0_30, e_0_25, e_0_21, e_0_19, e_0_17, e_0_15)

textColor

Text color in RRGGBB format (hexadecimal).

true

string

textOutlineWidth

Outline width in pixel, range: 0.0-10.0.

true

number (double)

com.harmonicinc.vos.app.configure.model.source.PlayoutInput

Name Description Required Schema Default

dailySyncTime

Daily sync time

false

integer (int32)

defaultAssetGrooming

default asset grooming

false

enum (NO_DEFAULT_GROOMING_PROFILE, USE_ASSET_GROOMING_PROFILE)

defaultLiveInputName

default live input name

false

string

duckLevel

duck level

false

integer (int32)

enableGap

Specifies if gaps in playlist are enabled

false

boolean

gfxAssetDir

graphics assets dir

false

string

localTimeZone

Local time zone

false

string

maxAssetBitrate

maximum asset bitrate

false

enum (e_100MBPS, e_250MBPS, e_600MBPS)

maxNumberAlternateSequencePreloaded

Max number of sequence to prepare

false

integer (int32)

monitorLiveSourceWithWebRtc

Specifies if live source monitoring with WEBRTC is activated

false

enum (e_FORCE_MONITOR_LIVE_SOURCE_WITH_WEB_RTC, e_DO_NOT_MONITOR_LIVE_SOURCE_WITH_WEB_RTC, e_MONITOR_LIVE_SOURCE_WITH_WEB_RTC)

playAssetDir

assets dir

false

string

playNAudioChannels

number of audio channels

false

integer (int32)

playlistOffset

Playlist offset

false

integer (int32)

playoutControl

false

enum (INTERNAL_PLAYOUT_CONTROL, THIRD_PARTY_AUTOMATION)

secondaryDefaultLiveInputName

secondary default live input name

false

string

sourceStreams

Playout source stream settings

true

[com.harmonicinc.vos.app.configure.model.source.PlayoutSourceStreams]

voiceOverLevel

voice-over level

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.PlayoutTeletextConfiguration

Name Description Required Schema Default

tracks

Essential metadata of teletext tracks

false

com.harmonicinc.vos.app.configure.model.source.PlayoutTeletextTrack array

com.harmonicinc.vos.app.configure.model.source.PlayoutTeletextTrack

Name Description Required Schema Default

language

Language code of the teletext page.

true

string

teletextHexPageNum

Decimal page number as string, range: 00-99. Note that hexadecimal page numbers are not supported for playout, Teletext user pages are only allowing decimal values (0..9 for each digit).

true

string

teletextMagazineNumber

Magazine number of the teletext page, range: 1-8.

true

integer (int32)

teletextType

Type of teletext page: 2 (subtitle) or 5 (subtitle for hearing impaired people).

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.PlayoutVideoConfiguration

Name Description Required Schema Default

captionServiceDescriptor

Caption Service Descriptor

false

com.harmonicinc.vos.app.configure.model.source.PlayoutCaptionServiceDescriptor

frameRate

FrameRate of generated video

true

com.harmonicinc.vos.app.configure.model.source.FrameRate

resolution

Resolution of generated video

true

com.harmonicinc.vos.app.configure.model.source.Resolution

com.harmonicinc.vos.app.configure.model.source.PoolInput

Name Description Required Schema Default

poolId

Pool ID of pool object; one pool per source

true

string

com.harmonicinc.vos.app.configure.model.source.PtsSettings

Name Description Required Schema Default

delayAdjustment

Specifies the data delay in millisecond in order to synchronize with the video stream, range -1250ms to 15000ms, default 0. Applicable to each mode.

false

integer (int32)

mode

e_PASSTHROUGH (default) or e_GENERATE. When e_GENERATE is selected, the input PTS is discarded, and the output PTS is automatically generated.

true

enum (e_PASSTHROUGH, e_GENERATE)

com.harmonicinc.vos.app.configure.model.source.RTMP_Input

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

hspEndpoint

(Deprecated)Internal Live ingest endpoint of the source

false

string

hspEndpointId

(Deprecated)Live ingest endpoint Id of the source

false

string

ipNetworkAddress

Network interface for RTMP input

false

string

ipPort

TCP port to receive RTMP input (range:20300-20399)

false

integer (int32)

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

publicRtmpEndpoint

(Deprecated)Public Live ingest endpoint of the source

false

string

rtmpMode

"IP" mode for XOS RTMP input transcoding

false

enum (IP, HSP)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

variantPlaylistFileName

(Deprecated)Playlist File Name of the source

false

string

com.harmonicinc.vos.app.configure.model.source.Resolution

Name Description Required Schema Default

height

Height of resolution

true

integer (int32)

width

Width of resolution

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.RfInputV2

Name Description Required Schema Default

atscTuner

ATSC tuner configuration.

false

com.harmonicinc.vos.app.configure.model.source.AtscTuner

card

Card number from 0 to 2(DVB-S2X) or 0 (ATSC)

false

integer (int32)

dvbS2XPort

DVB-S2X port configuration.

false

com.harmonicinc.vos.app.configure.model.source.DvbS2XPort

dvbS2XTuner

DVB-S2X tuner configuration.

false

com.harmonicinc.vos.app.configure.model.source.DvbS2XTuner

tsProgramNumber

Indicates the number of programs in the input TS

false

integer (int32)

tuner

Tuner number from 1 to 4(DVB-S2X) or 1 to 12(ATSC)

true

integer (int32)

type

RF card type.

true

enum (DVB_S2X, ATSC)

com.harmonicinc.vos.app.configure.model.source.SDI_Input

Name Description Required Schema Default

sdiCard

Specify which SDI card to receive the input

false

integer (int32)

sdiLinkMapping

Specify the SDI link standard

false

enum (e_SingleLink, e_DualLink, e_QuadLink)

sdiOverIpInput

Settings of a SDI over IP input

false

com.harmonicinc.vos.app.configure.model.source.SdiOverIpInput

sdiPort

Specify which port of the SDI card to receive the input

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.SdiAudioChannelPosition

Name Description Required Schema Default

audioChannel

Audio channel type

true

enum (Mono_Left, Mono_Right, Left_Right, Right_Left, Center_LowFrequency, LowFrequency_Center, LeftSurround_RightSurround, RightSurround_LeftSurround, LeftRearSurround_RightRearSurround, RightRearSurround_LeftRearSurround, LeftTopFront_RightTopFront, RightTopFront_LeftTopFront, LeftTopRear_RightTopRear, RightTopRear_LeftTopRear, Opaque_First, Opaque_Second, Opaque_Pair)

embChannelGroup

Embedded channel group type

true

enum (Group1, Group2, Group3, Group4)

embChannelPair

Embedded channel pair type

true

enum (Pair1, Pair2)

com.harmonicinc.vos.app.configure.model.source.SdiAudioGrooming

Name Description Required Schema Default

tracks

Essential metadata of audio tracks

false

com.harmonicinc.vos.app.configure.model.source.SdiAudioTrack array

com.harmonicinc.vos.app.configure.model.source.SdiAudioTrack

Name Description Required Schema Default

audioChannelPosition

Audio channel positions

false

com.harmonicinc.vos.app.configure.model.source.SdiAudioChannelPosition array

audioTrackIndex

Index of the audio track, starting from 1

true

integer (int32)

audioTrackType

Audio track type

true

enum (PCM, AC3, EAC3, DolbyE, AC4)

backUpAudioTrackIndex

Index of the backup audio track, starting from 1. Value 0 means no backup audio track.

false

integer (int32)

backupTriggerTypes

List of Backup Options for Audio Track, null/empty/missing indicates e_Audio_Signal_Loss

false

enum (e_Audio_Signal_Loss, e_Audio_MD_Missing) array

delayAdjustment

Specifies the audio delay in millisecond in order to synchronize the video stream, valid range from -500 to 500 ms

false

integer (int32)

dolbyEProgramNumber

Source DolbyE program number for the audio (range 1 to 8)

false

integer (int32)

hasNielsenWatermark

Indicate this audio stream has Nielsen watermark

false

boolean

inputLevel

Audio input level

false

integer (int32)

isDefault

Indicate this audio is default

false

boolean

iso639AudioType

Audio Type of audio stream

false

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE)

labels

Labels identifier of the audio track

false

string array

language

Specifies the language of audio in source

false

string

metadataProgramNumber

The program number of the VANC metadata to be used

false

integer (int32)

s2020MetadataSourceLabel

Label of sdi data track that carries corresponding SMPTE-2020 audio metadata

false

string

sdid

The SDID of the VANC metadata

false

enum (e_Single_Audio_Program, e_Group_1_Pair_1_2, e_Group_1_Pair_3_4, e_Group_2_Pair_1_2, e_Group_2_Pair_3_4, e_Group_3_Pair_1_2, e_Group_3_Pair_3_4, e_Group_4_Pair_1_2, e_Group_4_Pair_3_4)

silenceDetectionThreshold

Duration for silence detection in ms. If audio level remains under -65dB for the duration, a notification is raised. If empty, no silence detection will be applied for the audio track. Range [500, 60000]

false

integer (int32)

smpte2110AudioStreamProperties

Describe 2110 audio stream specific properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110AudioStreamProperties

useDiscovery

Indicate the usage of the discovery to know the audio input level

false

boolean

com.harmonicinc.vos.app.configure.model.source.SdiCaptionServiceDescriptor

Name Description Required Schema Default

sdiCaptionServiceDescriptorData

false

com.harmonicinc.vos.app.configure.model.source.SdiCaptionServiceDescriptorData array

com.harmonicinc.vos.app.configure.model.source.SdiCaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number of caption service in the range [1..63] if digital_cc == 1. It has no meaning if digital_cc == 0

true

integer (int32)

defaultSubtitle

Whether or not the caption service stream is the stream for default subtitle

false

boolean

easyReader

Easy reader of caption service. It has no meaning if digital_cc == 0

true

integer (int32)

language

ISO 639.2/B 3 character language code of caption service. It has no meaning if digital_cc == 0

true

string

wideAspectRatio

Wide aspect ratio of caption service: 0=4/3, 1=16/9. It has no meaning if digital_cc == 0

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.SdiDataGrooming

Name Description Required Schema Default

ccConversionMode

Preferred Closed Caption type

false

enum (AUTO, EIA608, CEA708)

sdiDataTracks

Essential metadata of sdi data tracks

false

com.harmonicinc.vos.app.configure.model.source.SdiDataTrack array

com.harmonicinc.vos.app.configure.model.source.SdiDataTrack

Name Description Required Schema Default

dpiPidIndex

This parameter enables out-of-band SCTE-104, and provides the associated dpi_pid_index. When out-of-band SCTE-104 is enabled, in-band input VANC-104 messages are discarded

false

integer (int32)

dtmfSettings

DTMF settings for conversion to SCTE-35

false

com.harmonicinc.vos.app.configure.model.source.DtmfSettings

inputLineSetting

Input line settings for the SDI data

false

com.harmonicinc.vos.app.configure.model.source.SdiDataTrack$InputLineSetting array

labels

Labels identifier of the data stream

false

string array

lossDetectionThreshold

Data loss detection threshold in source (only OP-47 and SMPTE_2031)

false

integer (int32)

scte104OverrideDidSdid

When STBmode == STBP_MBR_DPI_PROPRIETARY, VANC SCTE-104 will be decoded from VANC packets with DID == 0x45 and SDID 0x01, INSTEAD of the SCTE-104 standard DID == 0x41 and SDID 0x07

false

enum (e_41_07, e_45_01)

smpte2110DataStreamProperties

Describe 2110 data stream specific properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110DataStreamProperties

teletextDescriptions

Descriptions of teletext components in source

false

com.harmonicinc.vos.app.configure.model.source.TeletextDescription array

teletextMode

Specifies which teletext mode is used

false

enum (NORMAL, LOW_DELAY)

teletextToDvbSubsSetting

Obsolete

false

com.harmonicinc.vos.app.configure.model.source.TeletextToDvbSubsSetting

com.harmonicinc.vos.app.configure.model.source.SdiDataTrack$InputLineSetting

Name Description Required Schema Default

lineNumber

Specifies the line(s) which the SDI data is embedded

false

integer (int32) array

sourceFormat

Format of the SDI data

false

enum (SCTE_104, OP_42, OP_47, SMPTE_2031, WST, WSS, AFD, AFD_AND_TELETEXT, AFD_BAR_SMPTE_2016, VPS, ARIB_STD37, VITC, GENERIC_DATA, SMPTE_2020)

com.harmonicinc.vos.app.configure.model.source.SdiInputGrooming

Name Description Required Schema Default

audioGrooming

Essential metadata of audio

false

com.harmonicinc.vos.app.configure.model.source.SdiAudioGrooming

dataGrooming

Essential metadata of data services

false

com.harmonicinc.vos.app.configure.model.source.SdiDataGrooming

videoGrooming

Essential metadata of video

false

com.harmonicinc.vos.app.configure.model.source.SdiVideoGrooming

com.harmonicinc.vos.app.configure.model.source.SdiOverIpInput

Name Description Required Schema Default

lsmIds

List of LSM id that is controlling SONY_NMI input source

false

string array

maxSupportedDelay

Maximum supported delay between 2110 stream

false

integer (int32)

mode

SDI over IP mode

false

enum (SMPTE_2022_6, SMPTE_2110, SONY_NMI)

nmiIndex

NMI index associated with this input source

false

integer (int32)

nmosEnabled

Enable input configuration by NMOS

false

boolean

sources

Sources of the SDI over IP input

false

com.harmonicinc.vos.app.configure.model.source.SdiOverIpSource array

com.harmonicinc.vos.app.configure.model.source.SdiOverIpInputParam

Name Description Required Schema Default

disableFec

Disable input FEC

false

boolean

ipAddress

IP address used to receive input. IPv4 and IPv6 are supported

true

string

ipNetworkAddress

IP network address

false

string

ipPort

UDP port used to receive input

true

integer (int32)

smpte2110TransportProperties

SMPTE2110 related transport level properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110TransportProperties

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

com.harmonicinc.vos.app.configure.model.source.SdiOverIpSource

Name Description Required Schema Default

disableFec

Disable input FEC

false

boolean

ipAddress

IP address used to receive input. IPv4 and IPv6 are supported

true

string

ipNetworkAddress

IP network address

false

string

ipPort

UDP port used to receive input

true

integer (int32)

smpte20227Input

Input parameters for 20227 input redundancy

false

com.harmonicinc.vos.app.configure.model.source.SdiOverIpInputParam

smpte2110TransportProperties

SMPTE2110 related transport level properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110TransportProperties

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

com.harmonicinc.vos.app.configure.model.source.SdiVideoGrooming

Name Description Required Schema Default

afdFallback

AFD Fallback

false

enum (e_AFD_LAST_VALID_AFD, e_AFD_16x9_FULL_FRAME_1000, e_AFD_4x3_PILLARBOX_1001, e_AFD_16x9_FULL_FRAME_PROTECTED_1010, e_AFD_14x9_PILLARBOX_1011, e_AFD_4x3_PILLARBOX_ALT_14x9_CENTER_1101, e_AFD_16x9_FULL_FRAME_ALT_14x9_CENTER_1110, e_AFD_16x9_FULL_FRAME_ALT_4x3_CENTER_1111)

croppingSettings

Specifies the region of the video to crop

false

com.harmonicinc.vos.app.configure.model.source.CroppingSettings

enableRfd

Enable/disable RFD - Repeat Field Detection

false

boolean

frameMode

Specify the frame mode of input video

false

enum (PROGRESSIVE, INTERLACED)

frameRate

Discovered frameRate of video

false

com.harmonicinc.vos.app.configure.model.source.FrameRate

hasAmolLine

Specifies the removal of AMOL or WSS line from the source video

false

boolean

imageCompression

Image Compression format for input video

false

enum (LLVC, NONE, TICO, JPEGXS)

initialLastValidDisplayRangeAspectRatio

The value that the datapath initializes fallback property Last Valid Display Range Aspect Ratio with

false

enum (AR_4x3, AR_16x9)

initialLastValidVideoAspectRatio

The value that the datapath initializes fallback property Last Valid Video Aspect Ratio with

false

enum (AR_4x3, AR_16x9)

inputAspectRatio

InputAspectRatio of video

false

enum (e_AUTO, e_AR_AUTO_FALLBACK_4_3, e_AR_AUTO_FALLBACK_16_9, e_AR_4_3, e_AR_16_9)

inputColour

SDI input colour space signaling if null then auto-detect

false

enum (e_AUTO_DETECT, e_BT601_SDR, e_BT_709_SDR, e_BT_709_HLG, e_BT_2020_SDR, e_BT_2020_HLG, e_BT_2020_HDR10)

labels

Labels identifier of video

false

string array

resolution

Discovered resolution of video

false

com.harmonicinc.vos.app.configure.model.source.Resolution

sdiCaptionServiceDescriptor

Caption Service Descriptor

false

com.harmonicinc.vos.app.configure.model.source.SdiCaptionServiceDescriptor

smpte2110VideoStreamProperties

Describe 2110 video stream specific properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110VideoStreamProperties

videoActiveRegionSignaling

Specifies the source video active region signaling scheme.

false

enum (NONE, FULL_VI_AFD, WSS, AFD_IN_WSS, AFD_BAR_SMPTE_2016)

videoNoiseReduction

Specifies noise reduction

false

enum (DISABLED, AUTO_DETECT, MODERATE, STRONG)

com.harmonicinc.vos.app.configure.model.source.SignalLossSlateSettings

Name Description Required Schema Default

insertionSettings

Enable customized insertion settings for slate and set the sampling windows to 5-second for slate insertion.

false

boolean

insertionThreshold

A counter counts the number of 5-second windows with input errors (signal loss, video missing, scrambled PID). When this counter reaches insertionThreshold, the slate is inserted. Range [1,12]

false

integer (int32)

resetThreshold

When the number of consecutive 5-second windows without error reaches resetThreshold, the counter of erroneous windows is reset. Range [1,12]

false

integer (int32)

revertThreshold

A slate is removed when the number of consecutive 5-second windows without error reaches revertThreshold. Range [1,12]

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.SlateInput

Name Description Required Schema Default

enableVideoSlate

Enable run-time update on video slate (graphicFilename). default = false

false

boolean

graphicFilename

Title of a graphic in the Asset Acquisition App to be used as the slate video

false

string

imageId

Unique identifier of image used for the slate

false

string

signalLossSlateSettings

Additional settings on signal loss slate

false

com.harmonicinc.vos.app.configure.model.source.SignalLossSlateSettings

type

Slate type

true

enum (SIGNAL_LOSS, CUSTOM)

com.harmonicinc.vos.app.configure.model.source.Smpte20227Ts_Input

Name Description Required Schema Default

ipAddress

IP address used to receive input. IPv4 and IPv6 are supported

true

string

ipNetworkAddress

IP network address

false

string

ipPort

UDP port used to receive input

true

integer (int32)

pathDifferentialDelayMs

Seamless 2022-7 Path Differential Delay in ms in the range (50ms, 450ms)

true

integer (int32)

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

com.harmonicinc.vos.app.configure.model.source.Smpte2110AudioStreamProperties

Name Description Required Schema Default

inputAudioChannelNumList

List of audio channel number composing the 2110 audio stream

true

integer (int32) array

sdiSampleRate

SDI sample rate

true

enum (e_44100_HZ, e_48000_HZ, e_96000_HZ)

sdiSampleSize

SDI sample size

true

enum (e_16_BIT, e_20_BIT, e_24_BIT)

transportId

For mapping the 2110 stream to the 2110 transport

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.Smpte2110AudioTransportProperties

Name Description Required Schema Default

isSmpte211031Payload

Whether payload within audio transport is ST-2110-31 or not

true

boolean

numAudioChannel

Number of audio channels in the transport

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.Smpte2110DataStreamProperties

Name Description Required Schema Default

transportId

For mapping the 2110 stream to the 2110 transport

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.Smpte2110DataTransportProperties

Name Description Required Schema Default

extractAFD

Whether extract AFD from current 2110 data stream

true

boolean

extractClosedCaption

Whether extract closed caption from current 2110 data stream

true

boolean

com.harmonicinc.vos.app.configure.model.source.Smpte2110TransportProperties

Name Description Required Schema Default

audioTransportProperties

2110 audio transport specific properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110AudioTransportProperties

dataTransportProperties

2110 data transport specific properties

false

com.harmonicinc.vos.app.configure.model.source.Smpte2110DataTransportProperties

generateVitcFromRtpTimestamp

VITC generation from RTP timestamps. Applicable to video stream only

false

boolean

rtpPayloadType

Dynamic payload type of the RTP streams

true

integer (int32)

transportId

For mapping the 2110 stream to the 2110 transport

true

integer (int32)

transportType

Specify the 2110 transport type

true

enum (SMPTE_2110_VIDEO, SMPTE_2110_AUDIO, SMPTE_2110_DATA)

com.harmonicinc.vos.app.configure.model.source.Smpte2110VideoStreamProperties

Name Description Required Schema Default

transportId

For mapping the 2110 stream to the 2110 transport

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.Smpte302mChannelList

Name Description Required Schema Default

indices

Specify how to locate all audio tracks of the audio pid. The index order matters for mapping the channel position

false

integer (int32) array

pid

Pid of the audio stream that is used for selection

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.Source

Name Description Required Schema Default

cspCoreProperties

Cross Stream Prevention (CSP) properties

false

com.harmonicinc.vos.app.configure.model.source.CspCoreProperties

id

Unique identifier of a source in UUID format

false

string

inputRedundancyMode

false

enum (PRIMARY_ONLY, MANUAL_SWITCH, AUTO_SWITCH, AUTO_SWITCH_MANUAL_REVERT, AUTO_SWITCH_AUTO_REVERT)

inputs

An input is a singular network location from which to receive content

false

com.harmonicinc.vos.app.configure.model.source.Input array

labels

Labels attached to source for identification

false

string array

name

Display name of a source

false

string

pmtPid

(Deprecated) PMT PID number of selected program

false

string

com.harmonicinc.vos.app.configure.model.source.SrtCloudSourceSettings

Name Description Required Schema Default

latency

Latency

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.SrtInput

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

cloudlinkGroupId

Identifier of Cloudlink group the source originates from.

false

string

connectionMode

SRT connetion establishing mode

false

enum (LISTENER, CALLER)

descramblingKey

CSA key to descramble input

false

string

descramblingRequired

Whether input requires descrambling

false

boolean

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

ipNetworkAddress

Local interface for outgoing connections

false

string

latency

Latency, specified for Srt

false

integer (int32)

pathRedundancyMode

Path redundancy mode

false

enum (SRT_SOCKET_GROUP, ST_2022_7)

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

seamlessInputSwitching

Enable seamless input switching for input redundancy. Default: false

false

boolean

sourceAddr

UDP address used to fetch input on Cloudlink RT

false

string

sourcePort

UDP port used to fetch input on Cloudlink RT

false

integer (int32)

sourcePortRangeEnd

UDP port range end used to fetch mbts input

false

integer (int32)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

srtConnectionSettings

SRT connection setting list

false

com.harmonicinc.vos.app.configure.model.SrtConnectionSettings array

ssmIpAddrs

Source-specific multicast IP addresses

false

string array

st20227DelayBufferInMs

Buffer delay for reordering RTP packet

false

integer (int32)

tsProgramNumber

Indicates the number of programs in the input TS

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.St2038Track

Name Description Required Schema Default

labels

Labels identifier of the data stream

false

string array

lineNumber

Specifies the line(s) where the data is embedded

false

integer (int32) array

scte104OverrideDidSdid

When STBmode == STBP_MBR_DPI_PROPRIETARY, SCTE-104 will be decoded from VANC packets with DID == 0x45 and SDID 0x01, INSTEAD of the SCTE-104 standard DID == 0x41 and SDID 0x07

false

enum (e_41_07, e_45_01)

sourceFormat

Format of the ANC data

false

enum (SCTE_104, OP_47, SMPTE_2031, AFD, VITC, CLOSED_CAPTION)

teletextDescriptions

Descriptions of teletext components in source

false

com.harmonicinc.vos.app.configure.model.source.TeletextDescription array

teletextMode

Specifies which teletext mode is used

false

enum (NORMAL, LOW_DELAY)

com.harmonicinc.vos.app.configure.model.source.StreamDescriptor

Name Description Required Schema Default

captionServiceDescriptor

Caption Service Descriptor

true

com.harmonicinc.vos.app.configure.model.source.CaptionServiceDescriptor

customDescriptor

Custom descriptor

true

com.harmonicinc.vos.app.configure.model.source.CustomDescriptor

descriptorType

Type of descriptor

true

enum (ISO639, DVB_SUBTITLING, CAPTION_SERVICE, TELETEXT, TTML, CUSTOM)

dvbSubtitlingDescriptor

Dvb descriptor

true

com.harmonicinc.vos.app.configure.model.source.DvbSubtitlingDescriptor

iso639Descriptor

ISO639 descriptor

true

com.harmonicinc.vos.app.configure.model.source.ISO639Descriptor

teletextDescriptor

Teletext descriptor

true

com.harmonicinc.vos.app.configure.model.source.TeletextDescriptor

ttmlDescriptor

Ttml descriptor

false

com.harmonicinc.vos.app.configure.model.source.TtmlDescriptor

com.harmonicinc.vos.app.configure.model.source.TeletextDescription

Name Description Required Schema Default

language

Teletext language. default:English

false

enum (ENG, DEU, SWE, FIN, HUN, ITA, FRA, POR, SPA, CES, SLK, POL, TUR, SRP, HRV, SLV, RON, EST, LAV, LIT, RUS, BUL, UKR, ELL, ARA, HEB)

teletextHexPageNum

Teletext page number in hexadecimal format. Range: Hex 0x100 - 0x8FF

true

string

teletextType

Teletext type. Initial Teletext page, Teletext Subtitle Page, Additional Information Page, Hearing Impaired, Program Schdule Page

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.TeletextDescriptor

Name Description Required Schema Default

teletextDescriptorData

Data of Teletext Descriptor

true

com.harmonicinc.vos.app.configure.model.source.TeletextDescriptorData array

com.harmonicinc.vos.app.configure.model.source.TeletextDescriptorData

Name Description Required Schema Default

countryCode

Optional Country Code to append to the Language Code

false

string

defaultSubtitle

Whether or not the teletext stream is the stream for default subtitle

false

boolean

language

Language code of data stream

true

string

skipProcessing

Indicate this teletext stream will not be processed and will not be mux.

false

boolean

streamName

Custom stream name for Teletext

false

string

teletextHexPageNum

Verbatim hexadecimal page number of teletext stream - should be used if not null

false

string

teletextMagazineNumber

Magazine number of teletext stream in the range 1..8

true

integer (int32)

teletextPageNumber

Obsolete decimal page number of teletext stream - does not support pages in the range [A-F]

true

integer (int32)

teletextType

Type of teletext

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.TeletextToDvbSubsSetting

Name Description Required Schema Default

ancillaryPageId

Ancillary Page Id, default: 0, range: 0-255

true

integer (int32)

font

Font name, default: DejaVuSans.ttf. Value is the file name including dot-extension. Special case 'dejavu' mapped to 'DejaVuSans.ttf' internally.

true

string

forceDDS

Force DDS, default: false

true

boolean

language

Language, default:English

true

string

latency

Latency in ms, default: 500, range: 40-1000 ms

true

integer (int32)

pageId

Page Id, default: 0, range: 0-255

true

integer (int32)

pageNumber

Page Number, default: 256, range: 256 - 2201, For reference in Hex 0x100 - 0x899

true

integer (int32)

teletextTimeout

Teletext Timeout in ms, default: 10, range: 0-9999 ms

true

integer (int32)

transparencyLevel

Transparency Level, default: 0, range: 0-100

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.TtmlDescriptor

Name Description Required Schema Default

defaultSubtitle

Whether or not the Ttml stream is the stream for default subtitle

false

boolean

ttmlExtPayload

Remaining descriptor payload in hex array format, the minimum extPayload should be '010000' with all required flags set to 0

true

string

ttmlLanguage

TTML Language Code (ISO 639-2/B or ISO 639-2/T)

true

string

ttmlSubtitlePurpose

TTML subtitle purpose, range 0-63. 0=same-lang-dialogue, 1=other-lang-dialogue, 2=all-dialogue, 16=hard-of-hearing, 17=other-lang-dialogue-with-hard-of-hearing, 18=all-dialogue-with-hard-of-hearing, 48=audio-description, 49=content-related-commentary

true

integer (int32)

ttmlTtsSuitability

TTML text-to-speech suitability, range 0..3. 0=unknown suitability, 1=suitable, 2=not suitable

true

integer (int32)

com.harmonicinc.vos.app.configure.model.source.VideoGrooming

Name Description Required Schema Default

afdFallback

AFD Fallback

false

enum (e_AFD_LAST_VALID_AFD, e_AFD_16x9_FULL_FRAME_1000, e_AFD_4x3_PILLARBOX_1001, e_AFD_16x9_FULL_FRAME_PROTECTED_1010, e_AFD_14x9_PILLARBOX_1011, e_AFD_4x3_PILLARBOX_ALT_14x9_CENTER_1101, e_AFD_16x9_FULL_FRAME_ALT_14x9_CENTER_1110, e_AFD_16x9_FULL_FRAME_ALT_4x3_CENTER_1111)

croppingSettings

Specifies the region of the video to crop

false

com.harmonicinc.vos.app.configure.model.source.CroppingSettings

enableRfd

Enable/disable RFD - Repeat Field Detection

false

boolean

frameRate

Discovered frameRate of video

false

com.harmonicinc.vos.app.configure.model.source.FrameRate

hasAmolLine

Specifies the removal of AMOL or WSS line from the source video

false

boolean

inputAspectRatio

InputAspectRatio of video

false

enum (e_AUTO, e_AR_AUTO_FALLBACK_4_3, e_AR_AUTO_FALLBACK_16_9, e_AR_4_3, e_AR_16_9)

insertNullPidOnSignalLoss

Indicate insertion of nulls when there is video signal loss

false

boolean

labels

Labels identifier of the video stream

false

string array

pid

Pid of the video stream

false

integer (int32)

resolution

Discovered resolution of video

false

com.harmonicinc.vos.app.configure.model.source.Resolution

tracks

Additonal list of essential metadata of video

false

com.harmonicinc.vos.app.configure.model.source.VideoTrack array

videoNoiseReduction

Specifies noise reduction and artifact repair option reqiured

false

enum (DISABLED, AUTO_DETECT, MODERATE, STRONG)

videoStreamType

Type of the video stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.VideoTrack

Name Description Required Schema Default

afdFallback

AFD Fallback

false

enum (e_AFD_LAST_VALID_AFD, e_AFD_16x9_FULL_FRAME_1000, e_AFD_4x3_PILLARBOX_1001, e_AFD_16x9_FULL_FRAME_PROTECTED_1010, e_AFD_14x9_PILLARBOX_1011, e_AFD_4x3_PILLARBOX_ALT_14x9_CENTER_1101, e_AFD_16x9_FULL_FRAME_ALT_14x9_CENTER_1110, e_AFD_16x9_FULL_FRAME_ALT_4x3_CENTER_1111)

croppingSettings

Specifies the region of the video to crop

false

com.harmonicinc.vos.app.configure.model.source.CroppingSettings

enableRfd

Enable/disable RFD - Repeat Field Detection

false

boolean

frameRate

Discovered frameRate of video

false

com.harmonicinc.vos.app.configure.model.source.FrameRate

hasAmolLine

Specifies the removal of AMOL or WSS line from the source video

false

boolean

inputAspectRatio

InputAspectRatio of video

false

enum (e_AUTO, e_AR_AUTO_FALLBACK_4_3, e_AR_AUTO_FALLBACK_16_9, e_AR_4_3, e_AR_16_9)

insertNullPidOnSignalLoss

Indicate insertion of nulls when there is video signal loss

false

boolean

labels

Labels identifier of the video stream

false

string array

pid

Pid of the video stream

false

integer (int32)

resolution

Discovered resolution of video

false

com.harmonicinc.vos.app.configure.model.source.Resolution

videoNoiseReduction

Specifies noise reduction and artifact repair option reqiured

false

enum (DISABLED, AUTO_DETECT, MODERATE, STRONG)

videoStreamType

Type of the video stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types

false

integer (int32)

com.harmonicinc.vos.app.configure.model.source.ZixiEncoderSetting

Name Description Required Schema Default

decryptionKey

Zixi decryption key

false

string

decryptionType

Zixi decryption type

false

enum (NONE, ZIXI_AES_128, ZIXI_AES_192, ZIXI_AES_256)

zixiEndPointSetting

Zixi endpoint setting.

false

com.harmonicinc.vos.app.configure.model.source.ZixiEndPointSetting

com.harmonicinc.vos.app.configure.model.source.ZixiEndPointSetting

Name Description Required Schema Default

zixiEndpointId

Unique identifier of the zixi endpoint

true

string

com.harmonicinc.vos.app.configure.model.source.ZixiInput

Name Description Required Schema Default

automaticGrooming

Enable automatic grooming. Might not be supported by all input types.

false

boolean

encoderSetting

(OBSOLETE) Basic setting of encoder with Zixi. Used in Zixi Input

false

com.harmonicinc.vos.app.configure.model.source.ZixiEncoderSetting

grooming

Essential metadata for the system to intelligently route the input

false

com.harmonicinc.vos.app.configure.model.source.InputGrooming

harmonicUplinkSetting

Basic setting of harmonic uplink. Used in Harmonic Uplink Input

false

com.harmonicinc.vos.app.configure.model.source.HarmonicUplinkSetting

harmonicUplinkSettingList

Basic list of harmonic uplink settings. Used in Harmonic Uplink Input

false

com.harmonicinc.vos.app.configure.model.source.HarmonicUplinkSetting array

pcrConstraints

Customize the PCR constraints for TS inputs (like IP/SRT/CLOUD). Once set, the system will use customized constraints to check the PCR values and end-to-end latency could be increased.

false

com.harmonicinc.vos.app.configure.model.source.PcrConstraints

programNum

Program number of the input stream. Only required in MPTS input.

false

integer (int32)

sporadicVideoFrames

Specify that sporadic video frames input. Video frames can come in bursts or at random intervals. Typical use case is music streams with still video content.

false

boolean

zixiBroadcasterSetting

Zixi broadcaster setting. It is used in Zixi pull mode

false

[com.harmonicinc.vos.app.configure.model.source.ZixiBroadcasterSetting]

zixiInputType

Zixi input type

false

enum (HARMONIC_UPLINK, ENCODER, BROADCASTER)

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata

Name Description Required Schema Default

adBreaks

false

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata$AdBreak array

durationInSeconds

false

number (double)

previewUrl

false

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata$UrlSet

startTime

false

string (date-time)

url

false

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata$UrlSet

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata$AdBreak

Name Description Required Schema Default

durationInSeconds

false

number (double)

startTime

false

string (date-time)

vodStartTimeInSeconds

false

number (double)

com.harmonicinc.vos.app.liveextraction.LiveExtractionMetadata$UrlSet

Name Description Required Schema Default

dash

false

string

hls

false

string

com.harmonicinc.vos.app.liveextraction.LiveExtractionParam

Name Description Required Schema Default

endTime

false

string (date-time)

id

false

string

packageName

false

string

previewOnly

false

boolean

removeAdBreaks

false

boolean

serviceId

false

string

snapToProgramStartEnd

false

boolean

startTime

false

string (date-time)

storageUrl

false

string

thumbnailTileDimension

false

string

com.harmonicinc.vos.app.liveextraction.job.LiveExtractionJob

Name Description Required Schema Default

dashExtractionBySegmentNumber

false

boolean

endTime

false

string (date-time)

id

false

string

jobCreated

false

string (date-time)

jobEnded

false

string (date-time)

metadataAvailable

false

boolean

packageName

false

string

previewOnly

false

boolean

removeAdBreaks

false

boolean

serviceId

false

string

snapToProgramStartEnd

false

boolean

startTime

false

string (date-time)

state

false

enum (PENDING, RUNNING, COMPLETED, FAILED)

storageUrl

false

string

thumbnailTileDimension

false

string

com.harmonicinc.vos.app.liveextraction.rest.LiveExtractionAppStatus

Name Description Required Schema Default

numJobsCompleted

false

integer (int64)

numJobsFailed

false

integer (int64)

numJobsPending

false

integer (int64)

numJobsRunning

false

integer (int64)

tokenAcquisition

false

string (date-time)

tokenExpiration

false

string (date-time)

com.harmonicinc.vos.app.liveextraction.settings.LiveExtractionSettings

Name Description Required Schema Default

acquireAwsTokenFromHub

false

boolean

jobCpuRequest

false

number (double)

jobMemRequest

false

number (double)

jobNumWorkers

false

integer (int32)

jobRetentionPeriodInMinutes

false

integer (int32)

minResidueTokenDurationInMinutes

false

integer (int32)

previewSegmentBaseUrl

false

string

runnableNodeTypes

false

string array

s3AccessKeyId

false

string

s3Region

false

string

s3RoleArn

false

string

s3RoleSessionName

false

string

s3RoleTokenDurationInMinutes

false

integer (int32)

s3SecretAccessKey

false

string

s3SessionToken

false

string

com.harmonicinc.vos.app.liveextraction.util.ProbeRequest

Name Description Required Schema Default

packageName

false

string

serviceId

false

string

com.harmonicinc.vos.app.liveextraction.util.ProbeResult

Name Description Required Schema Default

earliestProgramDateTime

false

string (date-time)

firstSegmentNumDASH

false

integer (int64)

latestProgramDateTime

false

string (date-time)

sequenceNumHLS

false

integer (int64)

com.harmonicinc.vos.app.liveingestorigin.settings.LiveIngestOriginSetting

Name Description Required Schema Default

enableDeprecatedTlsProtocols

Enable deprecated TLS protocol(s) for backward compatibility

false

boolean

fileServerConfig

Nginx server or golang server

false

enum (NGINX, GOLANG)

ingestLogRetentionPeriodInDays

The number of days of ingest logs to keep

false

integer (int32)

ingestLogSizeInMB

The maximum size of ingest logs to keep

false

integer (int32)

internetProtocol

Internet Protocol for ingest

false

enum (HTTP, HTTPS)

lioGoChunkEncoding

LIO-go chunk encoding

false

boolean

lioGoDebugPort

LIO-go debug port , -1 means disabling debug port

false

string

lioGoDisplayHlsPlaylistIfSegmentNotFound

LIO-go will display HLS playlist if segment not found if this flag is true

false

boolean

lioGoEnableDash412ErrorCode

LIO-go return 412 when requesting segments which segment availability start time after current time

false

boolean

lioGoForceNonChunkedMss

LIO-go will disable chunked transfer for MSS files even if lioGoChunkEncoding is true

false

boolean

lowLatencyMediaPlaylistMaxAgeInSec

The max-age value for media playlist in second, when low-latency is enabled

false

integer (int32)

maxIngestPointsPerOrigin

The maximum number of ingest points that each origin server can serve

false

integer (int32)

maxIngestThroughputPerNodeInMbps

The ingest throughput in megabit-per-second

false

number (double)

mediaExpireTimeRelativeToLastModifiedTime

Calculates max-age of media files based on the time elapsed since last-modified time

false

boolean

mediaPlaylistMaxAgeInSec

The max-age value for media playlist in second

false

integer (int32)

mediaSegmentMaxAgeInSec

The max-age value for media segment in second

false

integer (int32)

memReqInMB

The requirement memory in MB

false

integer (int32)

minOriginTasks

The minimum number of origin tasks (or groups of redundant LIO tasks) to keep even when there is no ingest point registration

false

integer (int32)

nodeRoleConstraint

Limit ingest origin tasks to launch on nodes that has one of the specified roles (comma-seperated-list or * for any role)

false

string

numCpuCore

The required number of CPU core

false

number (float)

numEndpointsPerIngestPoint

The number of redundant URL endpoints for an ingest point

false

integer (int32)

partSegmentMaxAgeInSec

The max-age value for media part segment in second for low-latency feature

false

integer (int32)

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventData

Name Description Required Schema Default

confidenceMonitoring

Live Event confidence monitoring status (enable/disable)

false

boolean

endTimeInUtc

Live Event end time in UTC

false

string

esamPoisOobPosted

Live Event esam pois oob message posted status (true/false)

false

boolean

prerollDuration

Live Event preroll duration in seconds

false

integer (int64)

prerollSlate

Live Event preroll slate image ID

false

string

recording

Live Event recording

false

boolean

startTimeInUtc

Live Event start time in UTC

false

string

state

Live Event state

false

enum (OFFLINE, ALLOCATING, PREPARING, PREVIEW, LIVE_PREROLL, LIVE, STOPPING, FINISHED)

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventResponse

Name Description Required Schema Default

endTime

Live Event end time in UTC

false

string

esamPoisOobPosted

Live Event esam pois oob message posted status (true/false)

false

boolean

prerollDuration

Live Event preroll duration in seconds

false

integer (int64)

prerollSlate

Live Event preroll slate image ID

false

string

startTime

Live Event start time in UTC

false

string

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventUpdateRequest

Name Description Required Schema Default

endTime

Live Event end time in UTC

false

string

prerollDuration

Live Event preroll duration in seconds

false

integer (int64)

prerollSlate

Live Event preroll slate image ID

false

string

startTime

Live Event start time in UTC

false

string

com.harmonicinc.vos.app.monitor.model.AudioProfileStatus

Name Description Required Schema Default

outputAudioProfiles

List of output audio profile information

true

com.harmonicinc.vos.app.monitor.model.OutputAudioProfile array

srcCodec

Input audio codec

true

string

com.harmonicinc.vos.app.monitor.model.CcErrorStatistic

Name Description Required Schema Default

ccErrorStatisticEntryList

CC Error Statistic List

true

com.harmonicinc.vos.app.monitor.model.CcErrorStatisticEntry array

resetInMs

Statistic reset time

true

integer (int32)

time

Statistic start time

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.CcErrorStatisticEntry

Name Description Required Schema Default

ccErrCount

The cc error count

true

integer (int32)

hasPCR

The program clock counter

true

string

packetCount

The packet count

true

integer (int32)

pid

The pid

true

string

pidType

The Pid type

true

enum (VIDEO, AUDIO, SUBTITLE, SCTE35, PSI, PAT, PMT)

time

The time information for statistic

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.DataProfileStatus

Name Description Required Schema Default

bitrate

Output data bitrate

true

integer (int32)

ccToDvbSubtitleConversion

Output data with cc to dvb subtitle conversion enabled

true

boolean

teletextToDvbSubtitleConversion

Output data with teletext to dvb subtitle conversion enabled

true

boolean

com.harmonicinc.vos.app.monitor.model.DestinationStatistics

Name Description Required Schema Default

outputStatIn12h

Statistic in 12 hours

true

com.harmonicinc.vos.app.monitor.model.OutputStatsEntry

outputStatIn1h

Statistic in 1 hour

true

com.harmonicinc.vos.app.monitor.model.OutputStatsEntry

outputStatIn24h

Statistic in 24 hours

true

com.harmonicinc.vos.app.monitor.model.OutputStatsEntry

com.harmonicinc.vos.app.monitor.model.DestinationStatus

Name Description Required Schema Default

destinationStatistics

The statistics of a destination

true

com.harmonicinc.vos.app.monitor.model.DestinationStatistics

id

Unique identifier of a destination in UUID format

true

string

name

Display name of a destination

true

string

outputStatus

The status of the output

true

com.harmonicinc.vos.app.monitor.model.OutputStatus array

com.harmonicinc.vos.app.monitor.model.DownlinkOutputStatistic

Name Description Required Schema Default

addressAndPort

Output IP address and port.

false

string

outputId

Output ID

true

string

outputStatistic

Output bitrate statistic

true

com.harmonicinc.vos.app.monitor.model.OutputStatisticEntry array

com.harmonicinc.vos.app.monitor.model.DownlinkOutputStatus

Name Description Required Schema Default

downlinkOutputStatistic

Downlink output bitrate statistics

true

com.harmonicinc.vos.app.monitor.model.DownlinkOutputStatistic array

com.harmonicinc.vos.app.monitor.model.GraphicsRequestConfig

Name Description Required Schema Default

graphicsState

Graphics Status

true

enum (ON, OFF)

com.harmonicinc.vos.app.monitor.model.GraphicsState

Name Description Required Schema Default

on

false

boolean

com.harmonicinc.vos.app.monitor.model.InputDeliveryStatus

Name Description Required Schema Default

inputAddressPort

The input address and port

true

string

inputIndex

The input index

true

integer (int32)

inputStatistic

The input statistic

true

com.harmonicinc.vos.app.monitor.model.InputStatisticEntry array

com.harmonicinc.vos.app.monitor.model.InputPid

Name Description Required Schema Default

inputPidConfigured

Input PID configured at service creation

true

integer (int32)

inputPidUsed

Input PID currently in use

true

integer (int32)

com.harmonicinc.vos.app.monitor.model.InputStatisticEntry

Name Description Required Schema Default

ccErrorCount

Number of CC Errors

false

integer (int64)

inputBitrate

The ingest bitrate (bps) of input

true

integer (int32)

pathIndex

Path index (primary:0, secundary:1), useful in SMPTE 2022-7

false

integer (int32)

receivedPacketCount

number of UDP/RTP packet received (SMPTE 2022-1 FEC or Seamless SMPTE 2022-7, a packet received on both inputs is counted only once), null if not used

false

integer (int64)

recoveredPacketCount

The number of recovered packets (Zixi, SRT or SMPTE 2022-1 FEC), 0 if not used

true

integer (int32)

rtpInputStatistics

RTP input statistics - optional (null if not using RTP input)

false

com.harmonicinc.vos.app.monitor.model.RtpInputStatisticsEntry

smpte2022_1Fec

SMPTE 2022-1 FEC parameters - optional (null if SMPTE 2022-1 FEC is not enabled)

false

com.harmonicinc.vos.app.monitor.model.Smpte2022_1FecEntry

smpte2022_7TsInput

Seamless SMPTE 2022-7: number of lost RTP packets on the input

false

com.harmonicinc.vos.app.monitor.model.Smpte2022_7TsEntry

srtInputStatistics

SRT input statistics - optional (null if not using SRT input)

false

com.harmonicinc.vos.app.monitor.model.SrtInputStatisticsEntry

time

The time information for statistic

true

string (date-time)

unrecoveredPacketCount

The number of unrecovered packets (Zixi, SRT, SMPTE 2022-1 FEC or Seamless SMPTE 2022-7), 0 if not used

true

integer (int32)

usageCategory

The usage category

true

enum (IP, ZIXI_PULL, ZIXI_PUSH, SRT, ST_2022_7)

com.harmonicinc.vos.app.monitor.model.InputStatus

Name Description Required Schema Default

defaultInput

Default Input Identification

false

boolean

id

Unique identifier of a input in UUID format

true

string

inputDeliveryStatus

List of delivery status at input

true

com.harmonicinc.vos.app.monitor.model.InputDeliveryStatus array

inputStatistic

The input statistic

true

com.harmonicinc.vos.app.monitor.model.InputStatisticEntry array

resetDateStatistic

last reset date of the counters (SMPTE 2022-1 FEC or SRT), null if not used

false

string (date-time)

status

The status of the input of the source

true

enum (ACTIVE, STANDBY, ERROR)

com.harmonicinc.vos.app.monitor.model.LogoGroupState

Name Description Required Schema Default

logoSlateGroupLabel

label of the profile group to have logo inserted per profile

true

string

logoState

Logo status of the group logoSlateGroup

true

enum (ON, OFF)

com.harmonicinc.vos.app.monitor.model.LogoRequestConfig

Name Description Required Schema Default

logoGroupStates

List of LogoGroupState for each logo/slate group

false

com.harmonicinc.vos.app.monitor.model.LogoGroupState array

logoState

Global service logo status, if logoState = OFF, all logos will be disabled, if logoState = ON the logo will be enable according to the logoGroupStates

false

enum (ON, OFF)

logosListStates

List of LogosListState for each logo

false

com.harmonicinc.vos.app.monitor.model.LogosListState array

com.harmonicinc.vos.app.monitor.model.LogoState

Name Description Required Schema Default

logoGroupStates

false

com.harmonicinc.vos.app.monitor.model.LogoGroupState array

logosListStates

false

com.harmonicinc.vos.app.monitor.model.LogosListState array

on

false

boolean

com.harmonicinc.vos.app.monitor.model.LogosListState

Name Description Required Schema Default

logoState

Logo status of the logo with corresponding uuid

true

enum (ON, OFF)

uuid

uuid of the logo to be inserted

true

string

com.harmonicinc.vos.app.monitor.model.MuteOperationData

Name Description Required Schema Default

enabled

is mute operation enabled

false

boolean

endTime

Mute operation end time in UTC

false

string

startTime

Mute operation start time in UTC

false

string

com.harmonicinc.vos.app.monitor.model.OriginStatistic

Name Description Required Schema Default

originStatisticEntryList

The origin statistic

true

com.harmonicinc.vos.app.monitor.model.OriginStatisticEntry array

packagingFormat

Packaging format of the origin request

true

string

com.harmonicinc.vos.app.monitor.model.OriginStatisticEntry

Name Description Required Schema Default

pullBitrate

The pull bitrate (bps) of origin engine

true

integer (int32)

time

The time information for statistic

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.OriginStatus

Name Description Required Schema Default

originStatistic

The origin statistic

true

com.harmonicinc.vos.app.monitor.model.OriginStatistic array

com.harmonicinc.vos.app.monitor.model.OutputAudioProfile

Name Description Required Schema Default

bitrate

Output audio bitrate

true

integer (int32)

codec

Output audio codec

true

string

halcenable

Output audio with Harmonic ALC enabled

true

boolean

kantarSnapWatermarkInsertionEnable

Output audio with Kantar Snap Watermark enabled

true

boolean

nielsenWatermarkInsertionEnable

Output audio with Nielsen Watermark enabled

true

boolean

passthru

Output audio passthrough mode

true

boolean

com.harmonicinc.vos.app.monitor.model.OutputDeliveryStatus

Name Description Required Schema Default

deliveryType

IP output (e.g e_IP) or type of packaging profile defined at lab wizard profile (e.g. e_HLS)

true

string

outputDeliveryIndex

The index of the output delivery

true

integer (int32)

outputStatistic

The output statistic

true

com.harmonicinc.vos.app.monitor.model.OutputStatisticEntry array

status

The status of the output of the service

true

enum (ACTIVE, STANDBY, DISABLED, ERROR)

com.harmonicinc.vos.app.monitor.model.OutputPid

Name Description Required Schema Default

inputPids

List of input PIDs used to generate the output PID

true

com.harmonicinc.vos.app.monitor.model.InputPid array

outputPid

Output PID

true

integer (int32)

com.harmonicinc.vos.app.monitor.model.OutputStatisticEntry

Name Description Required Schema Default

outputBitrate

The package bitrate (bps) of output

true

integer (int32)

recoveredPacketCount

The number of recovered packets

true

integer (int32)

sdiStatistic

SDI statistic

false

com.harmonicinc.vos.app.monitor.model.SdiStatisticEntry

time

The time information for statistic

true

string (date-time)

unrecoveredPacketCount

The number of unrecovered packets

true

integer (int32)

usageCategory

The usage category

true

enum (IP, ZIXI_PUSH, CLOUD, SDI)

com.harmonicinc.vos.app.monitor.model.OutputStatsEntry

Name Description Required Schema Default

packetsCount

The packet count

true

integer (int64)

recoveredPacketCount

The recovered packet count

true

integer (int32)

time

The time information for statistic

true

string (date-time)

unrecoveredPacketCount

The unrecovered packet count

true

integer (int32)

com.harmonicinc.vos.app.monitor.model.OutputStatus

Name Description Required Schema Default

id

Unique identifier of a output in UUID format

true

string

outputDeliveryStatus

List of delivery status at output

true

com.harmonicinc.vos.app.monitor.model.OutputDeliveryStatus array

com.harmonicinc.vos.app.monitor.model.OutputTsStatus

Name Description Required Schema Default

outputPids

List of output PIDs

true

com.harmonicinc.vos.app.monitor.model.OutputPid array

com.harmonicinc.vos.app.monitor.model.ProcessingStatisticEntry

Name Description Required Schema Default

processingBitrate

The processing bitrate (bps) of processing engine

true

integer (int32)

time

The time information for statistic

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.ProcessingStatus

Name Description Required Schema Default

enableScte104Oob

Enable SCTE-104 OOB or not

true

boolean

outputAudioProfileStatus

Audio Profiles information used by each subservice

true

object

outputDataProfileStatus

Data Profiles information used by each subservice

true

object

outputVideoCodec

Output video codec, e.g. Multiscreen HEVC, IPTV AVC

true

enum (MULTISCREEN_HEVC, MULTISCREEN_AVC, IPTV_HEVC, IPTV_AVC)

processingAudioLanguages

Audio languages that are being processed. The audio language is in ISO639 format, e.g. eng, spa

true

string array

processingStatistic

The processing statistic

true

com.harmonicinc.vos.app.monitor.model.ProcessingStatisticEntry array

speechToTextStatus

Speech to text information

false

com.harmonicinc.vos.app.monitor.model.SpeechToTextStatus

com.harmonicinc.vos.app.monitor.model.RedundancyGroupState

Name Description Required Schema Default

join

false

boolean

com.harmonicinc.vos.app.monitor.model.RedundanyGroupRequestConfig

Name Description Required Schema Default

instanceId

Instance ID

true

string

redunState

Redundany Group Status

true

enum (JOIN, QUIT)

com.harmonicinc.vos.app.monitor.model.RemoveRetainedProgramChapterStartState

Name Description Required Schema Default

timeToProcessChangeInUtc

Time (in UTC) to remove retained program/chapter start, represented in format of yyyy-MM-ddThh:mm:ssZ (e.g. 2021-03-04T12:34:56z)

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.RtpInputStatisticsEntry

Name Description Required Schema Default

lostPackets

Number of lost RTP packets (based on RTP sequence number)

true

integer (int64)

orderErrors

Number or order errors

true

integer (int64)

com.harmonicinc.vos.app.monitor.model.Scte104ConnectionStatus

Name Description Required Schema Default

connections

List of SCTE-104 client connections (peer IP address and port)

true

string array

com.harmonicinc.vos.app.monitor.model.SdiStatisticEntry

Name Description Required Schema Default

phaseOffset

SDI phase offset in milliseconds, applicable when deterministic latency feature is enabled. Range -17..17. Should be in range -2..2 under normal conditions.

true

integer (int64)

com.harmonicinc.vos.app.monitor.model.Service

Name Description Required Schema Default

activeInstanceId

The active instance ID of service

true

string

destinationStatus

The status of destination

true

com.harmonicinc.vos.app.monitor.model.DestinationStatus

downlinkOutputStatus

The status of downlink output

true

com.harmonicinc.vos.app.monitor.model.DownlinkOutputStatus

id

Unique identifier of a service in UUID format

true

string

muteOperationData

The mute operation data in operator action addon

true

com.harmonicinc.vos.app.monitor.model.MuteOperationData

name

Display name of a service

true

string

originStatus

The status of origin

true

com.harmonicinc.vos.app.monitor.model.OriginStatus

outputTsStatus

Display output PIDs and related input PIDs

true

com.harmonicinc.vos.app.monitor.model.OutputTsStatus array

outputVideoPorfileStatus

The processing profile

true

com.harmonicinc.vos.app.monitor.model.VideoProfileStatus array

processingDockerImage

Custom processing docker image using by the service.

true

string

processingEngine

App key of the processing engine used by the service.

true

string

processingStatus

The status of processing

true

com.harmonicinc.vos.app.monitor.model.ProcessingStatus

sourceStatus

The status of source

true

com.harmonicinc.vos.app.monitor.model.SourceStatus array

com.harmonicinc.vos.app.monitor.model.ServiceRole

Name Description Required Schema Default

role

false

enum (None, Master, Slave)

com.harmonicinc.vos.app.monitor.model.ServiceStatus

Name Description Required Schema Default

audioOnlyService

Indication of an audio-only service

true

boolean

cloudlinkGroupIds

List of CloudlinkGroups used in service.

true

string array

configureServiceType

The type of the service from service configure

true

enum (LIVE, LIVE_EVENT)

controlState

The service’s control state

true

enum (ACTIVATED, TEST, OFF)

id

Unique identifier of a service in UUID format

true

string

labels

List of labels.

true

string array

liveEventStatus

false

com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventData

muteOperationData

false

com.harmonicinc.vos.app.monitor.model.MuteOperationData

name

Display name of a service

true

string

operationalState

The state of operation

false

enum (OFFLINE, INITIALIZING, RUNNING)

priority

The service’s priority

true

enum (LOW, NORMAL, HIGH)

serviceStartTime

The last start/restart time of the RmpWorker datapath. Null when the service is stopped.

false

string (date-time)

serviceType

Display type of the service

true

enum (OTT, IPTV, OTT_PLAYOUT, MPTS)

com.harmonicinc.vos.app.monitor.model.SlateRequestConfig

Name Description Required Schema Default

slateState

Slate Status

true

enum (ON, OFF)

time

Slate request time in UTC (Format: 2011-12-03T10:15:30Z), must be no later than 1 minute from current time

false

string

com.harmonicinc.vos.app.monitor.model.SlateStatus

Name Description Required Schema Default

errorMsg

Error Message

true

string

recommendation

Recommendation

true

string

serviceId

Service Id

true

string

slateState

Slate Status

true

enum (ON, OFF, ERROR)

com.harmonicinc.vos.app.monitor.model.Smpte2022_1FecEntry

Name Description Required Schema Default

columnsL

SMPTE 2022-1 number of RTP/FEC columns = L, 0 if no FEC is detected

true

integer (int32)

rowsD

SMPTE 2022-1 number of RTP/FEC rows= D, 0 if no FEC is detected

true

integer (int32)

com.harmonicinc.vos.app.monitor.model.Smpte2022_7TsEntry

Name Description Required Schema Default

lostRtpPrimary

Seamless SMPTE 2022-7: number of lost RTP packets on the primary input

true

integer (int32)

lostRtpSecondary

Seamless SMPTE 2022-7: number of lost RTP packets on the secondary input

true

integer (int32)

com.harmonicinc.vos.app.monitor.model.SourceStatus

Name Description Required Schema Default

ccErrorStatistic

The cc error statistic

true

com.harmonicinc.vos.app.monitor.model.CcErrorStatistic array

id

Unique identifier of a source in UUID format

true

string

inputStatus

The status of the input

true

com.harmonicinc.vos.app.monitor.model.InputStatus array

name

Display name of a source

true

string

sourceHeight

The video source height

true

integer (int32)

sourceVideoCodec

Source video codec, e.g. AVC, HEVC, JPEGXS

true

enum (MP2, AVC, HEVC, JPEGXS, AVS, AVS2, NOTSET)

sourceWidth

The video source width

true

integer (int32)

status

The status of the source

true

enum (ACTIVE, STANDBY, ERROR)

com.harmonicinc.vos.app.monitor.model.SpeechToTextStatus

Name Description Required Schema Default

audioCount

Number of audios with speech to text enabled

false

integer (int32)

com.harmonicinc.vos.app.monitor.model.SrtInputStatisticsEntry

Name Description Required Schema Default

ackPacketCount

Number of sent ACK packets, cumulated since last statistics reset

true

integer (int64)

bandwidth

Estimated bandwidth, in Mb/s

true

number (double)

belatedPacketCount

Number of received and ignored packets due to having come too late, cumulated since last statistics reset

true

integer (int64)

connectionAge

Time since the SRT connection is started, in milliseconds, reinitialized at each reconnection, frozen if connection is lost

true

integer (int64)

nackPacketCount

Number of sent NACK packets, cumulated since last statistics reset

true

integer (int64)

negociatedLatency

Negociated latency in ms

true

integer (int32)

receivedPacketTotal

Number of received packets, cumulated since last statistics reset

true

integer (int64)

recoveredPacketTotal

Number of recovered packets, cumulated since last statistics reset

true

integer (int64)

retransPacketCount

Number of retransmitted packets received, cumulated since last statistics reset

true

integer (int64)

rtt

Round trip time in ms

true

number (double)

srtReconnectionCount

Number of SRT reconnections, cumulated since last statistics reset

true

integer (int32)

unrecoveredPacketTotal

Number of unrecovered packets, cumulated since last statistics reset

true

integer (int64)

com.harmonicinc.vos.app.monitor.model.ToggleDrmState

Name Description Required Schema Default

drmControlState

Control state of DRM. DEFAULT means to follow existing DRM configuration. FORCE_UNENCRYPTED means to disable DRM for packaging (only support for CMAF packaging profile)

true

enum (DEFAULT, FORCE_UNENCRYPTED)

timeToProcessChangeInUtc

Time (in UTC) to enable/disable DRM, represented in format of yyyy-MM-ddThh:mm:ssZ (e.g. 2021-03-04T12:34:56z)

true

string (date-time)

com.harmonicinc.vos.app.monitor.model.VideoProfileStatus

Name Description Required Schema Default

framerateDenominator

The denominator of framerate

true

integer (int32)

framerateNumerator

The numerator of framerate

true

integer (int32)

interlaced

The interlace mode, true: interlaced, false: progressive

true

boolean

resolutionHeight

The height of video frame

true

integer (int32)

resolutionWidth

The width of video frame

true

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.ChannelGetProperties

Name Description Required Schema Default

channelOverride

Enable channel override on playout channel

false

enum (NOTAVAILABLE, OFF, ON)

defaultLiveSource

false

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.DefaultLiveSourceSettings

enableGap

Enable gap on the playout channel

false

boolean

enableLiveSourceMonitoring

Enable live source monitoring on the playout channel

false

boolean

liveSourceLockoutTime

Live input lockout time, in secondes, used by the automation controls to determine live source monitoring priority

false

integer (int32)

localTimeZone

Time zone configured for the playout channel

false

string

playlistOffset

Offset applied to the playlist to have a short latency

false

integer (int32)

scheduleReplacementLockoutTime

Lockout time applied to replace a schedule

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.ChannelSetProperties

Name Description Required Schema Default

channelOverride

Allow to enable the channel override feature

false

enum (OFF, ON)

liveSourceLockoutTime

Live input lockout time, in seconds [1..30 mn] default 300 seconds, Used by the automation to lock monitoring of live source used by the playlist

false

integer (int32)

scheduleReplacementLockoutTime

Lockout time applied to replace a schedule

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.DefaultLiveSourceSettings

Name Description Required Schema Default

active

PRIMARY when using the default live source, SECONDARY when using the secondary default live source.

true

enum (PRIMARY, SECONDARY)

primary

default live input name defined in playout input of the source of the service.

true

string

secondary

secondaryDefaultLiveInputName defined in playout input of the source of the service (absent if not defined).

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.checker.MissingAssetInfo

Name Description Required Schema Default

assetId

false

string

assetType

false

enum (PRIMARY, SECONDARY)

firstScheduleTimeTc

false

string

numTimesInSchedule

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.checker.MissingAssetList

Name Description Required Schema Default

channelId

false

string

creationTime

false

string

missingAssets

false

com.harmonicinc.vos.app.playoutcontrolbackend.checker.MissingAssetInfo array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.DefaultLiveSource

Name Description Required Schema Default

target

The target default live source

true

enum (PRIMARY, SECONDARY)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertPrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

endMode

Specifies how the event will end (Duration or Manual)

false

enum (DURATION, MANUAL)

eventType

Event type, File (including recorded file) or Live

false

enum (FILE, LIVE, COMMENT)

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

previousId

false

string

scte35WindowEnd

End time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. This event and following events in the same ad pod (material type is COMMERCIAL or AVAIL, and start mode is FOLLOW) are skipped if we don’t receive SCTE-35 trigger with splice-time before this time, or if we don’t receive SCTE-35 trigger x seconds before this time (x is 2 seconds if the event after the ad-pod is a prepared live source, otherwise it can be up to 32 seconds). Used only when the startMode is EXTERNAL

false

string

scte35WindowStart

Start time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. Any SCTE-35 trigger with a splice-time before this time is ignored. Used only when the startMode is EXTERNAL

false

string

sequenceId

Sequence id (UUID)

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startMode

Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger)

false

enum (FIXED, FOLLOW, MANUAL, EXTERNAL)

startTime

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode

false

string

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcErrorDuration

Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcScte35WindowEnd

Equivalent to scte35WindowEnd, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcScte35WindowStart

Equivalent to scte35WindowStart, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcStartTime

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

Name Description Required Schema Default

assetId

File name for the graphic to be played, the filename extension is optional

false

string

assetTitle

Text or additional information about the graphic, usually the material title

false

string

audioProfileName

Name of the grooming profile to be used, allows the audio tracks of a .wav file to be selected. Grooming profiles are defined in the Asset Acquisition application

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss), only used when the end mode is Duration

false

string

endMode

Determines how the end timing for the secondary event will be calculated. DURATION secondary event will end at the secondary start time + duration, OFFSETFROMEND secondary will end at an offset from the end time of the primary event, NOEND secondary will be terminated by a future secondary event on the same layer

false

enum (OFFSETFROMEND, DURATION, NOEND)

endOffset

End offset, ([+-]hh:mm:ss.sss), only used when the end mode is OffsetFromEnd. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

layer

Layer used for the logo/graphics, 1 to 8. If missing, the value 1 is used. When graphics overlap, the graphic on the higher layer has priority

false

integer (int32)

startMode

Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event

false

enum (OFFSETFROMSTART, OFFSETFROMEND)

startOffset

Start offset ([+-]hh:mm:ss.sss), only used when the start mode is OffsetFromStart. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

stopAnimationLeadTime

Duration of the graphic’s outro sequence (hh:mm:ss.sss), applies to 3-point animation graphics. The outro will be started this time before the secondary event ends

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcEndOffset

Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStartOffset

Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStopAnimationLeadTime

Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff)

false

string

templateFields

Additional information that can be passed to HTML graphic templates

false

com.harmonicinc.vos.playout.zookeeper.event.TemplateField array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.PlayoutService

Name Description Required Schema Default

channelId

false

string

channelName

false

string

channelType

false

enum (UNKNOWN, PLAYOUT, BLACKOUT_SCHEDULING, OTT_PLAYOUT)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.ToggleSourceInput

Name Description Required Schema Default

inputRankIndex

Input rank to switch to. Value 1 or 2.

true

integer (int32)

serviceId

Id of the service this command applies to.

true

string

sourceId

Id of the source this command applies to. This source shall contain 2 inputs.

true

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.UpdatePrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

endMode

Specifies how the event will end (Duration or Manual)

false

enum (DURATION, MANUAL)

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

scte35WindowEnd

End time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. This event and following events in the same ad pod (material type is COMMERCIAL or AVAIL, and start mode is FOLLOW) are skipped if we don’t receive SCTE-35 trigger with splice-time before this time, or if we don’t receive SCTE-35 trigger x seconds before this time (x is 2 seconds if the event after the ad-pod is a prepared live source, otherwise it can be up to 32 seconds). Used only when the startMode is EXTERNAL

false

string

scte35WindowStart

Start time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. Any SCTE-35 trigger with a splice-time before this time is ignored. Used only when the startMode is EXTERNAL

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startMode

Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger)

false

enum (FIXED, FOLLOW, MANUAL, EXTERNAL)

startTime

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode

false

string

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcErrorDuration

Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcScte35WindowEnd

Equivalent to scte35WindowEnd, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcScte35WindowStart

Equivalent to scte35WindowStart, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcStartTime

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.graphic.StartGraphicProperties

Name Description Required Schema Default

name

false

string

templateFields

false

com.harmonicinc.vos.playout.zookeeper.event.TemplateField array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.graphic.UpdateGraphicProperties

Name Description Required Schema Default

templateFields

false

com.harmonicinc.vos.playout.zookeeper.event.TemplateField array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.InputStatus

Name Description Required Schema Default

rankIndex

Indicate the current active input for this source in this service, values: 1 or 2.

false

integer (int32)

syncloss

Tell if input is connected (false) or connection is lost (true)

false

boolean

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.LiveSourceMonitoringProperties

Name Description Required Schema Default

sources

List of monitoring sources

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.LiveSourceMonitoringStatus array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.LiveSourceMonitoringStatus

Name Description Required Schema Default

automationStatus

ONAIR when the player is on-air, LOCKED when the player will be on-air within Live Source Lockout Time, DEFINED when the player will be on-air later, otherwise UNDEFINED. When ONAIR or LOCKED, the user cannot assign another source to this player.

false

enum (UNDEFINED, ONAIR, LOCKED, DEFINED)

defaultLiveSource

PRIMARY if it is the default live source, SECONDARY if it is the secondary default live source (absent if it is none of the default live sources).

false

enum (PRIMARY, SECONDARY)

id

Source id associated to the player

false

string

name

Source name associated to the player

false

string

player

Player number, values: 1 or 2.

false

integer (int32)

serviceStatus

List all service status associated to this channel

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.ServiceStatus array

userStatus

DEFINED when the operator has assigned this source to this player. Note: the player may be preempted by the automation if another source will be on-air within Live Source Lockout Time.

false

enum (UNDEFINED, DEFINED)

webrtcid

id to use in webrtc calls

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.ServiceStatus

Name Description Required Schema Default

activeInputRankIndex

Indicate the current active input index for this source (possible input redundancy), values: 1 or 2.

false

integer (int32)

inputStatus

Input status list associated to this service

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.InputStatus array

serviceId

Service Id

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.livesourcemonitoring.StartLiveSourceMonitoringProperties

Name Description Required Schema Default

id

Source id to associate to the player

false

string

name

Source name to associate to the player

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PlaylistEventList

Name Description Required Schema Default

firstEventRank

The position of the first returned event in the playlist. The current on-air event has firstEventRank = 1

false

integer (int32)

primaries

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryElement array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryElement

Name Description Required Schema Default

primaryData

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties

secondaries

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryElement array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.PrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetStatus

Indicates that the asset or live source is ready to play, or if there is a problem

false

enum (UNKNOWN, AVAILABLE, MISSING, MISSINGGROOMINGPROFILE, NOTVALID, NOTCOMPATIBLE, RECORDSTARTTIMEERROR)

assetStatusReason

Description of why the asset is not valid or not compatible

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

durationError

True if the play offset (when relative or absolute SOM is used) + duration is greater than the asset duration, not included if false

false

boolean

endMode

Specifies how the event will end (Duration or Manual)

false

enum (DURATION, MANUAL)

errorDuration

Indicates the duration of the gap or overlap error (hh:mm:ss.sss). Only present if an overlap or gap error is detected

false

string

eventTooShort

True if the event duration is less than the minimum allowed (1 sec)

false

boolean

eventType

Event type, File (including recorded file) or Live

false

enum (FILE, LIVE, COMMENT)

firstTimecodeInAsset

First timecode value for the asset, if available (hh:mm:ss[:;]ff). Only present when using absolute (timecode) SOM and somError = true

false

string

formatDescription

Describes the framerate and resolution of the live source used in the event, only present when invalidFormat = true

false

string

gapError

True if there is a time gap between this event and the preceding event

false

boolean

groupId

Group id (UUID), identifies the group of events that make up a looping schedule. All events of the looping schedule have the same group id

false

string

id

Event id (UUID)

false

string

invalidFormat

True if the framerate or resolution of the live source referenced by the event isn’t compatible with the channel’s framerate or resolution

false

boolean

lastTimecodeInAsset

Last timecode value for the asset + 1 (hh:mm:ss[:;]ff). Only present when using absolute (timecode) SOM, if the first timecode is available and somError = true

false

string

loopNumber

Loop number, starting at 1, if the event belongs to a looping schedule

false

integer (int32)

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

missingAssetDuration

Indicates missing duration for the asset to fit the configured SOM and duration (hh:mm:ss.sss). Only present if a duration error is detected

false

string

origin

Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system

false

enum (UNKNOWN, TRAFFIC, OPERATOR)

overlapError

True if start time of this event is before the end time of the preceding event

false

boolean

scte35WindowEnd

End time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. This event and following events in the same ad pod (material type is COMMERCIAL or AVAIL, and start mode is FOLLOW) are skipped if we don’t receive SCTE-35 trigger with splice-time before this time, or if we don’t receive SCTE-35 trigger x seconds before this time (x is 2 seconds if the event after the ad-pod is a prepared live source, otherwise it can be up to 32 seconds). Used only when the startMode is EXTERNAL

false

string

scte35WindowStart

Start time of the SCTE-35 validity window (YYYY-MM-DDThh:mm:ss.sssZ), in UTC. Any SCTE-35 trigger with a splice-time before this time is ignored. Used only when the startMode is EXTERNAL

false

string

sequenceId

Sequence id (UUID)

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somError

True to indicate the event’s SOM Type (ABSOLUTE or RELATIVE) and SOM value specify a starting position that is past the end of the asset

false

boolean

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startMode

Specifies how the event will start (Fixed Time, Follow, Manual Take, or External SCTE-35 trigger)

false

enum (FIXED, FOLLOW, MANUAL, EXTERNAL)

startTime

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode

false

string

startTrigger

Start trigger name

false

string

state

Event execution state. IDLE for future events, ONAIR, or DONE for past events

false

enum (UNKNOWN, IDLE, ONAIR, DONE)

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcErrorDuration

Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcScte35WindowEnd

Equivalent to scte35WindowEnd, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcScte35WindowStart

Equivalent to scte35WindowStart, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcStartTime

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

waitingForPlayEvent

True if the event requires a Play Next command (MANUAL start mode) or SCTE-35 trigger (EXTERNAL start mode) to start

false

boolean

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryElement

Name Description Required Schema Default

secondaryData

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.playlist.SecondaryProperties

Name Description Required Schema Default

assetId

File name for the graphic to be played, the filename extension is optional

false

string

assetStatus

Indicates that the graphic is ready to play, or if there is a problem

false

enum (UNKNOWN, AVAILABLE, MISSING, MISSINGGROOMINGPROFILE)

assetTitle

Text or additional information about the graphic, usually the material title

false

string

audioProfileName

Name of the grooming profile to be used, allows the audio tracks of a .wav file to be selected. Grooming profiles are defined in the Asset Acquisition application

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss), only used when the end mode is Duration

false

string

endMode

Determines how the end timing for the secondary event will be calculated. DURATION secondary event will end at the secondary start time + duration, OFFSETFROMEND secondary will end at an offset from the end time of the primary event, NOEND secondary will be terminated by a future secondary event on the same layer

false

enum (OFFSETFROMEND, DURATION, NOEND)

endOffset

End offset, ([+-]hh:mm:ss.sss), only used when the end mode is OffsetFromEnd. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

id

Event id (UUID)

false

string

layer

Layer used for the logo/graphics, 1 to 8. If missing, the value 1 is used. When graphics overlap, the graphic on the higher layer has priority

false

integer (int32)

origin

Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system

false

enum (UNKNOWN, TRAFFIC, OPERATOR)

overlapError

Indicates there is an overlap between 2 or more events on the same layer. The error is flagged on all of the overlapping events

false

boolean

startMode

Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event

false

enum (OFFSETFROMSTART, OFFSETFROMEND)

startOffset

Start offset ([+-]hh:mm:ss.sss), only used when the start mode is OffsetFromStart. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

startTime

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sss). This value is calculated and cannot be edited

false

string

state

Event execution state. IDLE for future events, ONAIR, or DONE for past events

false

enum (UNKNOWN, IDLE, ONAIR, DONE)

stopAnimationLeadTime

Duration of the graphic’s outro sequence (hh:mm:ss.sss), applies to 3-point animation graphics. The outro will be started this time before the secondary event ends

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcEndOffset

Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStartOffset

Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStartTime

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

tcStopAnimationLeadTime

Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff)

false

string

templateFields

Additional information that can be passed to HTML graphic templates

false

com.harmonicinc.vos.playout.zookeeper.event.TemplateField array

timingError

Indicates that a timing error has been detected, e.g. the secondary event’s end time is before its start time

false

boolean

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.scte35.SendScte35MessageProperties

Name Description Required Schema Default

hexMessage

SCTE-35 message in hexadecimal format

true

string

scte35Labels

List of SCTE-35 label(s) configured in playout source

true

string array

spliceTimecode

Splice time in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

true

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.CreateSequenceProperties

Name Description Required Schema Default

enabled

True if the sequence is enabled. A sequence enabled means that it can be inserted in the playlist manually or by a trigger

false

boolean

id

Id of the sequence

false

string

name

Name of the sequence

false

string

primaries

List of sequence primary events

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryElement array

startTrigger

Name of the trigger that can be used to insert the sequence into the playlist

false

string

stopTrigger

Name of the trigger that can be used to stop a sequence

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryElement

Name Description Required Schema Default

primaryData

primary event properties

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryProperties

secondaries

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSecondaryElement array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

eventType

Event type, File (including recorded file) or Live

false

enum (FILE, LIVE, COMMENT)

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSecondaryElement

Name Description Required Schema Default

secondaryData

secondary event properties

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.InsertSecondaryProperties

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequenceSinglePrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

eventType

Event type, File (including recorded file) or Live

false

enum (FILE, LIVE, COMMENT)

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

previousId

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceElement

Name Description Required Schema Default

primaries

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryElement array

sequenceData

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceProperties

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryElement

Name Description Required Schema Default

primaryData

sequence primary event properties

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryProperties

secondaries

list of sequence secondary events

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryElement array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequencePrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetStatus

Indicates that the asset or live source is ready to play, or if there is a problem

false

enum (UNKNOWN, AVAILABLE, MISSING, MISSINGGROOMINGPROFILE, NOTVALID, NOTCOMPATIBLE, RECORDSTARTTIMEERROR)

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

durationError

True if the play offset (when relative or absolute SOM is used) + duration is greater than the asset duration, not included if false

false

boolean

errorDuration

Indicates the duration of the gap or overlap error (hh:mm:ss.sss). Only present if an overlap or gap error is detected

false

string

eventTooShort

True if the event duration is less than the minimum allowed (1 sec)

false

boolean

eventType

Event type, File (including recorded file) or Live

false

enum (FILE, LIVE, COMMENT)

id

Event id (UUID)

false

string

invalidFormat

True if the framerate or resolution of the live source referenced by the event isn’t compatible with the channel’s framerate or resolution

false

boolean

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

missingAssetDuration

Indicates missing duration for the asset to fit the configured SOM and duration (hh:mm:ss.sss). Only present if a duration error is detected

false

string

origin

Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system

false

enum (UNKNOWN, TRAFFIC, OPERATOR)

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somError

True to indicate the event’s SOM Type (ABSOLUTE or RELATIVE) and SOM value specify a starting position that is past the end of the asset

false

boolean

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startTime

Event start date/time in UTC (YYYY-MM-DDThh:mm:ss.sssZ). The start time will be automatically calculated for all events except those with Fixed start mode

false

string

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcErrorDuration

Equivalent to errorDuration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcStartTime

Equivalent to startTime, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceProperties

Name Description Required Schema Default

duration

Total duration of primary events in the sequence

false

string

enabled

True if the sequence is enabled. A sequence enabled means that it can be inserted in the playlist manually or by a trigger

false

boolean

id

Id of the sequence

false

string

name

Name of the sequence

false

string

scheduleRef

Start time of the schedule if the sequence has been created from an opc schedule

false

string

startTrigger

Name of the trigger that can be used to insert the sequence into the playlist

false

string

stopTrigger

Name of the trigger that can be used to stop a sequence

false

string

tcDuration

Same to duration, but in timecode format (YYYY-MM-DD hh:mm:ss[:;]ff)

false

string

type

Type of the sequence: INLINE or OUTLINE

false

enum (INLINE, OUTLINE)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryElement

Name Description Required Schema Default

secondaryData

sequence secondary event properties

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryProperties

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.SequenceSecondaryProperties

Name Description Required Schema Default

assetId

File name for the graphic to be played, the filename extension is optional

false

string

assetStatus

Indicates that the graphic is ready to play, or if there is a problem

false

enum (UNKNOWN, AVAILABLE, MISSING, MISSINGGROOMINGPROFILE)

assetTitle

Text or additional information about the graphic, usually the material title

false

string

audioProfileName

Name of the grooming profile to be used, allows the audio tracks of a .wav file to be selected. Grooming profiles are defined in the Asset Acquisition application

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss), only used when the end mode is Duration

false

string

endMode

Determines how the end timing for the secondary event will be calculated. DURATION secondary event will end at the secondary start time + duration, OFFSETFROMEND secondary will end at an offset from the end time of the primary event, NOEND secondary will be terminated by a future secondary event on the same layer

false

enum (OFFSETFROMEND, DURATION, NOEND)

endOffset

End offset, ([+-]hh:mm:ss.sss), only used when the end mode is OffsetFromEnd. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

id

Event id (UUID)

false

string

layer

Layer used for the logo/graphics, 1 to 8. If missing, the value 1 is used. When graphics overlap, the graphic on the higher layer has priority

false

integer (int32)

origin

Origin (creator) of the event. Events can be created by the operator or traffic/scheduling system

false

enum (UNKNOWN, TRAFFIC, OPERATOR)

startMode

Indicates how the start timing for the secondary event will be calculated, offset from the start or end of the primary event

false

enum (OFFSETFROMSTART, OFFSETFROMEND)

startOffset

Start offset ([+-]hh:mm:ss.sss), only used when the start mode is OffsetFromStart. Can be positive or negative, blank or empty is interpreted as zero offset

false

string

stopAnimationLeadTime

Duration of the graphic’s outro sequence (hh:mm:ss.sss), applies to 3-point animation graphics. The outro will be started this time before the secondary event ends

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcEndOffset

Equivalent to endOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStartOffset

Equivalent to startOffset, but in timecode format ([+-]hh:mm:ss[:;]ff)

false

string

tcStopAnimationLeadTime

Equivalent to stopAnimationLeadTime, but in timecode format (hh:mm:ss[:;]ff)

false

string

templateFields

Additional information that can be passed to HTML graphic templates

false

com.harmonicinc.vos.playout.zookeeper.event.TemplateField array

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.UpdateSequencePrimaryProperties

Name Description Required Schema Default

assetId

Identifier for the asset to be played; a live source name, filename for file assets (the uri of the asset in asset library, with or without file path and extension), or asset title for recorded assets

false

string

assetTitle

Text or additional information about the asset, usually the material title

false

string

audioProfileName

The grooming profile to be used for file assets, to allow the audio tracks of the file to be selected. Grooming profiles are defined in the Asset Acquisition application. Not applicable to live events and recorded assets

false

string

description

Descriptive text that may contain additional information about the event

false

string

duration

Length of the event (hh:mm:ss.sss)

false

string

materialType

Material type of the asset. Special values Program, Avail, and Commercial are used for SCTE-35 generation

false

string

som

Indicates the position in the asset to start playback (hh:mm:ss.sss). When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, it is the timecode value for the starting position in the asset. An empty or blank value is treated as zero offset

false

string

somType

The type of SOM, which determines how the SOM value is used. When the SomType is RELATIVE, the SOM value is the offset from the start of asset. When the SomType is ABSOLUTE, the Som value is the timecode value for the starting position in the asset

false

enum (RELATIVE, ABSOLUTE)

startTrigger

Start trigger name

false

string

tcDuration

Equivalent to duration, but in timecode format (hh:mm:ss[:;]ff)

false

string

tcSom

Equivalent to som, but in timecode format (hh:mm:ss[:;]ff)

false

string

upid

The uPid value is inserted in the segmentation_upid field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL. It is a hexadecimal string, e.g. "0x000000002C11422B" with or without the leading "0x"

false

string

upidType

The uPid type is inserted in the segmentation_upid_type field of the segmentation descriptor in generated SCTE-35 messages. SCTE-35 messages are generated for events with material type PROGRAM, AVAIL, or COMMERCIAL

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.UpdateSequenceProperties

Name Description Required Schema Default

enabled

True if the sequence is enabled. A sequence enabled means that it can be inserted in the playlist manually or by a trigger

false

boolean

name

Name of the sequence

false

string

primaries

List of sequence primary events

false

com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.sequence.InsertSequencePrimaryElement array

startTrigger

Name of the trigger that can be used to insert the sequence into the playlist

false

string

stopTrigger

Name of the trigger that can be used to stop a sequence

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf

Name Description Required Schema Default

id

Trigger id for this trigger configuration

false

string

matchAny

List of trigger properties for this trigger configuration

false

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$TriggerProperties array

name

Trigger name for this trigger configuration

false

string

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$GpiProperties

Name Description Required Schema Default

edge

GPI Edge type, rising or falling, configured in GPI application

false

enum (GPI_RISING, GPI_FALLING)

name

GPI Name, configured in GPI application

false

string

offset

GPI extra offset in milliseconds (range 0…​20000) to trigger the event start

false

integer (int32)

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Match

Name Description Required Schema Default

asserts

List of asserts used to match this messages, in XPath format

false

string array

match

Determines how the match the asserts for this trigger (ALL, ANY, NONE)

false

enum (ALL, ANY, NONE)

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Properties

Name Description Required Schema Default

matchSignal

Scte35 message match properties (asserts) for this trigger configuration

false

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Match

source

Input Source properties for this trigger configuration

false

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Source

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Source

Name Description Required Schema Default

name

Name of the live source that Scte35 message was received from

false

string

onAirSource

Set true if the source that then Scte35 message was received from is currently on-air

false

boolean

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$TriggerProperties

Name Description Required Schema Default

gpiProperties

GPI properties for this trigger configuration

false

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$GpiProperties

scte35Properties

Scte35 properties for this trigger configuration

false

com.harmonicinc.vos.app.playoutcontrolbackend.services.triggerManager.TriggerConf$Scte35Properties

com.harmonicinc.vos.app.scrambling.drm.model.ClearkeyHeader

Name Description Required Schema Default

laUrl

URL for the key acquisition web service

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmCustomHeader

Name Description Required Schema Default

fieldName

Custom Header Field Name

true

string

fieldValue

Custom Header Field Value

true

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedDashResource

Name Description Required Schema Default

dashDrm

The dashDrm of DrmFixedDashResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedDashResource$DashDrm

dashDrms

The dashDrm list of DrmFixedDashResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedDashResource$DashDrm array

fixedIv

The fixedIv of DrmFixedDashResource

false

string

fixedKey

The fixedKey of DrmFixedDashResource

false

string

fixedKeyId

The fixedKeyId of DrmFixedDashResource

false

string

resourceId

The resourceId of DrmFixedDashResource

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedDashResource$DashDrm

Name Description Required Schema Default

clearkeyHeader

The clearkeyHeader of DrmFixedDashResource

false

com.harmonicinc.vos.app.scrambling.drm.model.ClearkeyHeader

manifestHeader

The manifestHeader of DrmFixedDashResource

false

string

name

The name of DrmFixedDashResource

false

string

playReadyHeaderObject

The playReadyHeaderObject of DrmFixedDashResource

false

com.harmonicinc.vos.app.scrambling.drm.model.PlayReadyHeaderObject

psshBox

The psshBox of DrmFixedDashResource

false

string

systemId

The systemId of DrmFixedDashResource

false

string

widevineCencHeader

The widevineCencHeader of DrmFixedDashResource

false

com.harmonicinc.vos.app.scrambling.drm.model.WidevineCencHeader

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource

Name Description Required Schema Default

fixedIv

The fixedIv of HlsDrm

false

string

fixedKey

The fixedIv of HlsDrm

false

string

fixedKeyId

The fixedKeyId of HlsDrm

false

string

hlsDrm

The hlsDrm of HlsDrm

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource$HlsDrm

hlsEncryptionMode

The hlsEncryptionMode of HlsDrm

false

string

keyUrl

The keyUrl of HlsDrm

false

string

playReadyHeader

The playReadyHeader of HlsDrm

false

com.harmonicinc.vos.app.scrambling.drm.model.PlayReadyHeaderObject

playReadyHeaderObject

The playReadyHeaderObject of HlsDrm

false

string

resourceId

The resourceId of HlsDrm

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource$HlsDrm

Name Description Required Schema Default

indexPlaylistTags

The indexPlaylistTags of HlsDrm

false

string array

keyAttributes

The keyAttributes of HlsDrm

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource$KeyAttribute array

name

The name of HlsDrm

false

string

playReadyHeaderObject

The playReadyHeaderObject of HlsDrm

false

com.harmonicinc.vos.app.scrambling.drm.model.PlayReadyHeaderObject

systemId

The systemId of HlsDrm

false

string

variantPlaylistTags

The variantPlaylistTags of HlsDrm

false

string array

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource$KeyAttribute

Name Description Required Schema Default

attributeName

The attributeName of DrmFixedHlsResource

false

string

attributeValue

The attributeValue of DrmFixedHlsResource

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedResource

Name Description Required Schema Default

dashResource

The dashResource of DrmFixedResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedDashResource

hlsResource

The hlsResource of DrmFixedResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedHlsResource

id

The id of DrmFixedResource

false

string

packagingType

The packagingType of DrmFixedResource

false

enum (e_HLS, e_DASH, e_SS, e_SS_PLAYREADY)

ssPlayReadyResource

The ssPlayReadyResource of DrmFixedResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource

ssResource

The ssResource of DrmFixedResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsResource

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource

Name Description Required Schema Default

leafLicense

The leafLicense of DrmFixedSsPlayReadyResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource$LeafLicense array

resourceId

The resourceId of DrmFixedSsPlayReadyResource

false

string

rootLicense

The rootLicense of DrmFixedSsPlayReadyResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource$RootLicense

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource$LeafLicense

Name Description Required Schema Default

fixedKey

The fixedKey of LeafLicense

false

string

fixedKeyId

The fixedKeyId of LeafLicense

false

string

psshBox

The psshBox of LeafLicense

false

string

systemId

The systemId of LeafLicense

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsPlayReadyResource$RootLicense

Name Description Required Schema Default

systemData

The systemData of RootLicense

false

string

systemId

The systemId of RootLicense

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsResource

Name Description Required Schema Default

fixedIv

The fixedIv of DrmFixedSsResource

false

string

fixedKey

The fixedKey of DrmFixedSsResource

false

string

fixedKeyId

The fixedKeyId of DrmFixedSsResource

false

string

resourceId

The resourceId of DrmFixedSsResource

false

string

ssDrm

The ssDrm of DrmFixedSsResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsResource$SsDrm

ssDrms

The SsDrms list of DrmFixedSsResource

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsResource$SsDrm array

com.harmonicinc.vos.app.scrambling.drm.model.DrmFixedSsResource$SsDrm

Name Description Required Schema Default

manifestHeader

The manifestHeader of DrmFixedSsResource

false

string

name

The name of DrmFixedSsResource

false

string

playReadyHeaderObject

The playReadyHeaderObject of DrmFixedSsResource

false

com.harmonicinc.vos.app.scrambling.drm.model.PlayReadyHeaderObject

psshBox

The psshBox of DrmFixedSsResource

false

string

systemId

The systemId of DrmFixedSsResource

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmGroup

Name Description Required Schema Default

drms

List of DRM system id

true

string array

id

ID of DRM Group

true

string

name

DRM Group Name

true

string

packagingType

Packaging Type

true

enum (e_HLS, e_DASH, e_SS, e_CMAF)

com.harmonicinc.vos.app.scrambling.drm.model.DrmKms

Name Description Required Schema Default

httpsCertValidation

Enable Certificate Validation when making HTTPS Connection to KMS Server

true

boolean

rank

Rank of KMS Server

true

integer (int32)

url

URL of KMS Server

true

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmResource

Name Description Required Schema Default

drmTrackFilterId

DRM filtering profile Id

false

string

id

ID of DRM Resource

true

string

name

Resource Name

true

string

packagingType

Packaging Type

true

enum (e_HLS, e_DASH, e_SS, e_CMAF)

resourceId

Resource Id

true

string

widevineCustomContentProtection

Widevine Custom Content Protection

false

string

com.harmonicinc.vos.app.scrambling.drm.model.DrmSettings

Name Description Required Schema Default

enableCmafKeyRotation

Enable or disable CMAF Key Rotation

false

boolean

enableDashKeyRotation

Enable or disable DASH Key Rotation

false

boolean

enableHlsKeyRotation

Enable or disable HLS Key Rotation

false

boolean

enableKeyRotation

Enable or disable key Rotation

false

boolean

enableSsKeyRotation

Enable or disable SS Key Rotation

false

boolean

keyRotationPeriod

Key Rotation period

false

integer (int32)

proxyEndpoint

Proxy endpoint

false

com.harmonicinc.vos.app.scrambling.drm.model.ProxyEndpoint

com.harmonicinc.vos.app.scrambling.drm.model.DrmSystem

Name Description Required Schema Default

cpixDocumentVersion

CPIX document version

false

enum (e_2_2, e_2_3)

customHeader

Custom Header in HTTP Requests connecting to Harmonic KMS

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmCustomHeader

drmGroups

List of DRM Group

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmGroup array

embeddedDrmTrackFilters

Embedded DRM filtering profile properties. It is required in NMS configuration

false

com.harmonicinc.vos.app.scrambling.drm.model.EmbeddedDrmTrackFilter array

encryptionInterfaceType

Encryption Intreface Type

true

enum (e_HKMS_MIN, e_HKMS_FULL, e_WIDEVINE, e_KSM_CPIX, e_INTERNAL, e_FIXED_KEY, e_VERIMATRIX_CPIX, e_APPLE_CPIX, e_HKMS_CPIX)

enforceKeyEncryptionValidation

Boolean value to verify that the key from the Harmonic CPIX response is encrypted

false

boolean

httpMethod

Option to use GET HTTP method for requesting DRM metadata

false

enum (POST, GET)

id

ID of DRM System

true

string

insertContentKeyPeriodIndex

Boolean to force inserting of ContentKeyPeriod@Index into Harmonic CPIX request when key rotation is disabled (for backward compatibility purpose only)

false

boolean

insertDeliveryKeyCertificate

Boolean to control inserting of DeliveryKeyCertificate into Harmonic CPIX request

false

boolean

insertDrmSystemIdInRequest

Boolean to control inserting DRM system ID or not during key retrieval

false

boolean

keyDefaultValue

false

string

keyManagementServers

Key Management Servers

true

com.harmonicinc.vos.app.scrambling.drm.model.DrmKms array

keyRequestSign

Enabling / disabling digital signature of key requests

false

boolean

keyResponsesSignatureValidate

Enabling / disabling the validation of key responses signature

false

boolean

keyRotationSettings

KeyRotation settings

false

com.harmonicinc.vos.app.scrambling.drm.model.KeyRotationSettings

kmsRequestHlsTsCommonEncryptionScheme

Common Encryption Scheme for HLS-sTS

false

enum (NONE, CBC1, CBCS)

name

Name of DRM System

true

string

requestorId

Requestor Id

true

string

resources

Resources

false

com.harmonicinc.vos.app.scrambling.drm.model.DrmResource array

useProxy

Boolean value to use / not use Proxy endpoints

false

boolean

widevineConfig

Widevine-specific configuration

false

com.harmonicinc.vos.app.scrambling.drm.model.WidevineConfig

com.harmonicinc.vos.app.scrambling.drm.model.EmbeddedDrmTrackFilter

Name Description Required Schema Default

drmTrackFilterProfileProperties

false

com.harmonicinc.vos.labwizard.rest.model.DrmTrackFilterProfileProperties

id

false

string

name

false

string

com.harmonicinc.vos.app.scrambling.drm.model.KeyRotationSettings

Name Description Required Schema Default

controller

Is Key period controlled by VOS or KMS ('KMS' by default). The 'controller' property is applicable only for the START_END mode.

true

enum (KMS, VOS)

mode

'INDEX' or 'START_END' ContentKeyPeriod field configuration ('INDEX' by default)

true

enum (INDEX, START_END)

numberOfKeyPeriods

Number of ContentKeyPeriods for CPIX request (1 by default)

true

integer (int32)

preFetchRequestRelativeTime

Time point (in percentages) after the the start of the first period, when new content key(s) should be pre-requested (80% by default). Currently property is applicable only for the START_END mode.

true

integer (int32)

com.harmonicinc.vos.app.scrambling.drm.model.PlayReadyHeaderObject

Name Description Required Schema Default

customAttributes

Arbitrary XML: CUSTOMATTRIBUTES

false

string

dsId

Service ID for the domain service: DS_ID

false

string

includeChecksum

To include checksum or not in PlayReady Header Object: CHECKSUM

false

boolean

kid

Key ID in Base64 representation: KID

false

string

laUrl

URL for the license acquisition Web service: LA_URL

false

string

luiUrl

URL for a non-silent license acquisition Web page: LUI_URL

false

string

com.harmonicinc.vos.app.scrambling.drm.model.ProxyEndpoint

Name Description Required Schema Default

address

IP address of Proxy endpoint

false

string

port

Port number of Proxy endpoint

false

integer (int32)

com.harmonicinc.vos.app.scrambling.drm.model.WidevineCencHeader

Name Description Required Schema Default

algorithm

Encryption Algorithm

false

enum (UNENCRYPTED, AESCTR)

contentId

A content identifier which is specified by content provider

false

string

keyId

Key ID

false

string

policy

The name of a registered policy to be used for this asset

false

string

provider

Content provider name

false

string

trackType

Track type which is used to differentiate content keys used by an asset

false

string

com.harmonicinc.vos.app.scrambling.drm.model.WidevineConfig

Name Description Required Schema Default

signer

Identifies the entity sending the message

true

string

signingIv

Base64-encoded AES init vector used to sign request

true

string

signingKey

Base64-encoded AES key used to sign request

true

string

com.harmonicinc.vos.app.sourcemonitor.model.CloudSource

Name Description Required Schema Default

automaticGrooming

Automatic grooming

false

boolean

cloudInputType

Cloud input type

false

enum (CLOUD_SOURCE, CLOUD_EDGE)

cloudSourceType

Cloud source type

false

enum (SRT, RTMP, RIST)

egressId

Id of the cloud egress

false

string

region

Region of the cloud egress

false

string

resourceMode

Cloud resource mode, determines whether a single stream or multiple different streams are used

false

enum (SHARED, DEDICATED)

sourceId

Id of cloud source

false

string

srtSource

Srt source settings

false

com.harmonicinc.vos.app.sourcemonitor.model.SrtSource

userStreamId

Stream ID for cloud resource

false

string

com.harmonicinc.vos.app.sourcemonitor.model.DemuxSource

Name Description Required Schema Default

demuxServiceId

Indicates the uuid of the Demux service

true

string

com.harmonicinc.vos.app.sourcemonitor.model.DiscoveryProgress

Name Description Required Schema Default

progress

Discovery Progress

true

integer (int32)

state

Discovery State

true

enum (UNINITIALIZED, INITIALIZING, RUNNING, INTERRUPTED, CANCELLED, COMPLETED, DESTROYED, ERROR)

com.harmonicinc.vos.app.sourcemonitor.model.DiscoverySource

Name Description Required Schema Default

cloudSource

CLoud source

false

com.harmonicinc.vos.app.sourcemonitor.model.CloudSource

creationTimestamp

Creation timestamp of Discovery Task

false

integer (int64)

demuxSource

Demux source

false

com.harmonicinc.vos.app.sourcemonitor.model.DemuxSource

hspSource

Hsp Source

false

com.harmonicinc.vos.app.sourcemonitor.model.HspSource

id

Discovery ID

false

string

inputId

Input ID

false

string

ipSourceRange

IP Source Range

false

com.harmonicinc.vos.app.sourcemonitor.model.IPSourceRange

probingDurationInMs

Probing duration in milliseconds. Ranging from 5000 to 30000 ms. Default value is 5000 ms

false

integer (int32)

rfsource

RF source

false

com.harmonicinc.vos.app.sourcemonitor.model.RFSource

sourceId

Source ID

false

string

sourceType

Source Type

true

enum (IP, ZIXI, SRT, HSP, CLOUD, RF, DEMUX)

srtSource

SRT Source

false

com.harmonicinc.vos.app.sourcemonitor.model.SrtSource

zixiSource

Zixi Source

false

com.harmonicinc.vos.app.sourcemonitor.model.ZixiSource

com.harmonicinc.vos.app.sourcemonitor.model.HarmonicUplinkSetting

Name Description Required Schema Default

descramblingKey

Descrambling key

false

string

descramblingRequired

Whether descrambling is required

false

boolean

ipAddress

IPv4 or IPv6 address to receive the input

false

string

ipPort

IP port to receive the input

false

integer (int32)

ipPortRangeEnd

UDP port range end used to receive input

false

integer (int32)

pidList

PID list

false

integer (int32) array

programId

Program ID

false

integer (int32)

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

uplinkGroupId

Id of the uplinkGroup

false

string

uplinkId

Id of the uplink

false

string

com.harmonicinc.vos.app.sourcemonitor.model.HspAuthenticationHeader

Name Description Required Schema Default

isDirty

true

boolean

key

Key

true

string

value

Value

true

string

com.harmonicinc.vos.app.sourcemonitor.model.HspEndpointSettings

Name Description Required Schema Default

authenticationHeader

Authentication header

false

com.harmonicinc.vos.app.sourcemonitor.model.HspAuthenticationHeader

hspEndpoint

HSP Endpoint

true

string

ipNetworkAddress

IP Network Address used to receive the stream

false

string

variantPlaylistFileName

Playlist File Name of the source

true

string

com.harmonicinc.vos.app.sourcemonitor.model.HspSource

Name Description Required Schema Default

authenticationHeader

Authentication header

false

com.harmonicinc.vos.app.sourcemonitor.model.HspAuthenticationHeader

backupEndpointSettings

Backup Live ingest endpoint settings of the source for seamless input redundancy

false

com.harmonicinc.vos.app.sourcemonitor.model.HspEndpointSettings

hspEndpoint

HSP Endpoint

true

string

ipNetworkAddress

IP Network Address used to receive the stream

false

string

scte35Annotation

SCTE-35 annotation format

false

enum (NONE, BASE64_SCTE35_CUE)

variantPlaylistFileName

Playlist File Name of the source

true

string

com.harmonicinc.vos.app.sourcemonitor.model.IPSource

Name Description Required Schema Default

automaticGrooming

Automatic grooming

false

boolean

descramblingKey

Descrambling key

false

string

ip

IP Address of input

true

string

ipNetworkAddress

IP Network Address used to receive the stream

false

string

ipPort

IP Port of input

true

integer (int32)

ssm

SSM Address List of Input

false

string array

com.harmonicinc.vos.app.sourcemonitor.model.IPSourceRange

Name Description Required Schema Default

descramblingKey

Descrambling key

false

string

ipNetworkAddress

IP Network Address used to receive the stream

false

string

ipPortRangeEnd

End IP Port of IP Port Range to Scan

true

integer (int32)

ipPortRangeStart

Start IP Port of IP Port Range to Scan

true

integer (int32)

ipRangeEnd

End IP Address of IP Address Range to Scan

true

string

ipRangeStart

Start IP Address of IP Address Range to Scan

true

string

ssm

Source Specific Address

false

string array

com.harmonicinc.vos.app.sourcemonitor.model.RFSource

Name Description Required Schema Default

adapter

Adapter, corresponds to tuner Ids (adapter 0 is tuner 1)

true

integer (int32)

frontend

Frontend

true

integer (int32)

rfdeliverySystemType

RF Delivery System

true

enum (DVBT, DVBT2, DVBS, DVBS2, ATSCT)

com.harmonicinc.vos.app.sourcemonitor.model.SrtConnectionSettings

Name Description Required Schema Default

ipAddress

Ip address

false

string

ipNetworkAddress

Interface

false

string

latency

Latency parameter

false

integer (int32)

port

Port

false

integer (int32)

srtEncryptionParams

SRT encryption params

false

com.harmonicinc.vos.app.sourcemonitor.model.SrtEncryptionParams

streamId

StreamId specification

false

string

com.harmonicinc.vos.app.sourcemonitor.model.SrtEncryptionParams

Name Description Required Schema Default

encryptionKey

Srt encryption key

false

string

encryptionType

Srt encryption type

false

enum (AES_128, AES_192, AES_256, NO_ENCRYPTION)

com.harmonicinc.vos.app.sourcemonitor.model.SrtSource

Name Description Required Schema Default

automaticGrooming

Automatic grooming

false

boolean

cloudlinkGroupId

Id of the cloudlink group

false

string

cloudlinkId

Id of the cloudlink

false

string

connectionMode

Mode for establishing SRT connection

false

enum (LISTENER, CALLER)

descramblingKey

Descrambling key

false

string

descramblingRequired

Whether descrambling is required

false

boolean

ipAddress

IPv4 or IPv6 address to receive the input

false

string

ipNetworkAddress

Local interface for outgoing connections

false

string

ipPort

IP port to receive the input

false

integer (int32)

ipPortRangeEnd

UDP port range end used to receive input

false

integer (int32)

latency

Latency parameter

false

integer (int32)

pathRedundancyMode

Path redundancy mode

false

enum (SRT_SOCKET_GROUP, ST_2022_7)

pidList

PID list

false

integer (int32) array

programId

Program ID

false

integer (int32)

srtConnectionSettings

Srt connection setting list

false

com.harmonicinc.vos.app.sourcemonitor.model.SrtConnectionSettings array

srtEncryptionParams

SRT encryption params

false

com.harmonicinc.vos.app.sourcemonitor.model.SrtEncryptionParams

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

st20227DelayBufferInMs

Buffer delay for reordering RTP packet

false

integer (int32)

streamIds

StreamId specifications

false

string array

com.harmonicinc.vos.app.sourcemonitor.model.ZixiBroadcasterSetting

Name Description Required Schema Default

channelName

Zixi broadcaster channel name

true

string

decryptionKey

Zixi decryption key

false

string

decryptionType

Zixi decryption type

false

enum (NONE, ZIXI_AES_128, ZIXI_AES_192, ZIXI_AES_256)

hostAddress

Zixi broadcaster host address

true

string

hostPort

Zixi broadcaster host port

true

integer (int32)

password

Zixi broadcaster password

false

string

sessionId

Zixi broadcaster session ID

true

string

com.harmonicinc.vos.app.sourcemonitor.model.ZixiEncoderSetting

Name Description Required Schema Default

decryptionKey

Zixi decryption key

false

string

decryptionType

Zixi decryption type

false

enum (NONE, ZIXI_AES_128, ZIXI_AES_192, ZIXI_AES_256)

zixiEndPointSetting

Zixi End point setting. Only required to fill in end point Id. RecvAddress and recvPort are generated Internally

false

com.harmonicinc.vos.app.sourcemonitor.model.ZixiEndPointSetting

com.harmonicinc.vos.app.sourcemonitor.model.ZixiEndPointSetting

Name Description Required Schema Default

recvAddress

Receiving address of the zixi endpoint

false

string

recvPort

Receiving port of the zixi endpoint

false

integer (int32)

zixiEndpointId

Id of the zixi endpoint

false

string

com.harmonicinc.vos.app.sourcemonitor.model.ZixiSource

Name Description Required Schema Default

harmonicUplinkSetting

Basic setting of harmonic uplink

false

com.harmonicinc.vos.app.sourcemonitor.model.HarmonicUplinkSetting

com.harmonicinc.vos.app.sourcemonitor.model.connection.ConnectionInformation

Name Description Required Schema Default

srtConnectionInfo

Srt connection information details

false

com.harmonicinc.vos.app.sourcemonitor.model.connection.SrtConnectionInfo

com.harmonicinc.vos.app.sourcemonitor.model.connection.SrtConnectionInfo

Name Description Required Schema Default

latency

Negotiated latency for feeder and receiver

false

integer (int32)

rtt

Round-trip time

false

integer (int32)

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.DrmSettings

Name Description Required Schema Default

enableDrm

false

boolean

perPackageDrmSystemIdList

false

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageDrmSystemId array

perPackageDrmTrackFilterList

false

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageDrmTrackFilter array

perPackageResourceIdList

false

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageResourceId array

resourceId

false

string

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageDrmSystemId

Name Description Required Schema Default

drmSystemId

false

string

publishName

false

string

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageDrmTrackFilter

Name Description Required Schema Default

drmTrackFilter

false

string

publishName

false

string

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.PerPackageResourceId

Name Description Required Schema Default

publishName

false

string

resourceId

false

string

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel

Name Description Required Schema Default

cmafPreview

CMAF (HLS) preview info

false

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo

dashPreview

Mpeg DASH preview info

false

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo

hlsPreview

HLS preview info

false

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo

id

ID of channel

true

string

indexerSegmentDurationInMinutes

Segment duration in minutes

true

integer (int64)

name

Full name of channel

true

string

previewInfos

Preview Info List

false

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo array

publishName

Channel name in egress URL

false

string

segmentRetentionPeriodInMinutes

Segment retention period in minutes

true

integer (int64)

ssPreview

Smooth Streaming preview info

false

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo

timeshiftBuffer

Status of the circular buffer for timeshift playback

true

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$TimeshiftBufferStatus

transcodingProfileId

ID of transcoding profile

true

string

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$PlaybackInfo

Name Description Required Schema Default

absoluteCatchUpUrl

URL for playing channel with a specified time range with absolute path

false

string

absoluteLiveUrl

URL for playing the channel live with absolute path

false

string

absoluteStartOverUrl

URL for playing channel from specified start time with absolute path

false

string

catchUpUrl

URL for playing channel with a specified time range

false

string

format

Package format

false

string

liveEventMonitoringUrl

URL for preview Live Event channel

false

string

liveEventUrl

URL for playing clear content

false

string

liveUrl

URL for playing the channel live

false

string

name

Name of playback

false

string

startOverUrl

URL for playing channel from specified start time

false

string

com.harmonicinc.vos.app.unifiedoriginengine.channels.OriginChannel$TimeshiftBufferStatus

Name Description Required Schema Default

currentLengthInSeconds

Current media length in seconds

false

integer (int64)

currentSizeInBytes

Current storage size of media data

false

integer (int64)

Name Description Required Schema Default

id

false

string

privateIp

false

string

privatePort

false

integer (int32)

publicIp

false

string

publicPort

false

integer (int32)

status

false

enum (INITIALIZING, CONFIGURED, ERROR)

Name Description Required Schema Default

customHeaders

Custom headers

false

string array

encapsulationMode

UDP or RTP encapsulation mode

false

enum (e_UDP, e_RTP)

fecColumnOnly

FEC mode

false

boolean

fecColumns

FEC columns

false

integer (int32)

fecEnabled

FEC state

false

boolean

fecRows

FEC rows

false

integer (int32)

id

Destination output id

true

string

ipOutputs

Destination IP address

true

com.harmonicinc.vos.app.uplink.hub.uplinkchannel.impl.IpOutput array

liveUrl

Live URL

true

string

refOutId

Id of corresponding Configure destination object

false

string

Name Description Required Schema Default

inputBitrate

The bitrate (bps) of input

true

integer (int32)

time

The time information for statistic, e.g. 2015-11-04T09:11:33Z

true

string (date-time)

Name Description Required Schema Default

outputBitrate

The ingest bitrate (bps) of output

true

integer (int32)

time

The time information for statistic, e.g. 2015-11-04T09:11:33Z

true

string (date-time)

Name Description Required Schema Default

activeInputIndex

Index of active ip input

false

integer (int32)

downlinkEventReportingList

Event reports of uplink output

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting array

downlinkOutputStatistic

The event description of of the input

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatisticEntry array

downlinkStreamingStatus

The status of the output of uplink, ERROR means no stream output which is not expected.

true

enum (ACTIVE, ERROR)

id

Unique identifier of a DownlinkOutput in UUID format

true

string

pidStatisticsList

Cloudlink Pid Statistic

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.PidStatistics array

Name Description Required Schema Default

dropped

false

integer (int32)

recovered

false

integer (int32)

Name Description Required Schema Default

carryPCR

Carry PCR

true

boolean

ccErrorCount

CCError count

true

integer (int32)

packetCount

Count of packets

true

integer (int32)

pid

TS Pid

true

integer (int32)

pidType

Pid Type

true

enum (PIDTYPE_UNKNOWN, PIDTYPE_PSI, PIDTYPE_VIDEO, PIDTYPE_AUDIO, PIDTYPE_SCTE35, PIDTYPE_SUBTITLE, PIDTYPE_PAT, PIDTYPE_PMT, PIDTYPE_CAT)

Name Description Required Schema Default

inputRtpPacketsDropped

false

integer (int64)

Name Description Required Schema Default

descramblingKey

Descrambling key

false

string

descramblingRequired

Whether input should be descrambled

false

boolean

enableEncryption

Whether to enable encryption

false

boolean

id

Id of the uplink input

true

string

ipInputs

List of IP inputs

false

com.harmonicinc.vos.app.uplink.hub.uplinkchannel.impl.IpInput array

outputAddress

Hostname or IPv4 or IPv6 address to send from uplink to destination

false

string

outputPort

Output UDP port to send from uplink to destination

false

integer (int32)

pidList

List of PID numbers for MPTS-to-SPTS filtering

false

integer (int32) array

programIdList

List of program IDs MPTS-to-SPTS filtering

false

integer (int32) array

resolution

Video resolution

false

enum (SD, HD, UHD, DEFAULT)

Name Description Required Schema Default

clientId

false

string

clientSecret

false

string

currentVersion

Current version of cloudlink.

false

string

id

Id of the uplink

true

string

ipAddress

IP address of the uplink

true

string

isInitialized

[Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.

false

boolean

name

Display name of a uplink

true

string

needToBeUpgraded

If the uplink is needed to be upgraded.

false

boolean

publicIpAddress

Public IP address of the uplink

true

string

rank

Priority of Uplink. Auto assigned when uplink is created. It can be updated afterwards.

false

integer (int32)

version

Version which need to be upgraded to.

false

string

Name Description Required Schema Default

channelName

Channel name for the streaming channel

true

string

cloudlinkOutputs

List of Cloudlink outputs.

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.CloudlinkOutput array

hspInputs

List of Hsp inputs.

false

com.harmonicinc.vos.app.uplink.hub.uplinkchannel.HspInput array

id

Id of the uplinkChannel

true

string

isPersistent

Whether to persistent the uplink channel for database store.

false

boolean

label

Label of the uplinkChannel

true

string

sourceId

Source id

false

string

srtInputs

List of Srt inputs.

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.SrtInput array

uplinkId

Id of the uplink

true

string

uplinkInputs

List of uplink inputs.

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInput array

Name Description Required Schema Default

downlinkOutputStatusList

Status of the downlink output.

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatus array

id

Id of the uplinkChannel

true

string

uplinkEventReportingList

Event reports of uplink channel

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting array

uplinkInputStatusList

Status of the uplink input.

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatus array

Name Description Required Schema Default

eventMessage

The event message happened

true

string

eventType

Type of the event report

true

string

notificationPropertiesMap

The collection which contains notification properties

false

object

reportId

Id of the event report

true

string

time

The time information for statistic e.g. 2015-11-04T09:11:33Z

true

string (date-time)

Name Description Required Schema Default

id

Id of the UplinkGroup

true

string

name

name of the UplinkGroup

true

string

uplinkIds

List of uplinkId, grouped to form a redundancy group with 2 CloudLinks

true

string array

Name Description Required Schema Default

bitrate

Suggested bitrate to transfer content in bps

false

integer (int32)

descramblingKey

Descrambling key

false

string

descramblingRequired

Whether input should be descrambled

false

boolean

enableEncryption

Whether to enable encryption

false

boolean

id

Id of the uplink input

true

string

ipAddress

IPv4 or IPv6 address to receive the input at uplink

false

string

ipInputs

List of IP inputs

false

com.harmonicinc.vos.app.uplink.hub.uplinkchannel.impl.IpInput array

ipPort

UDP port to receive the input at uplink

false

integer (int32)

outputAddress

Hostname or IPv4 or IPv6 address to send from uplink to destination

false

string

outputPort

Output UDP port to send from uplink to destination

false

integer (int32)

pidList

List of PID numbers for MPTS-to-SPTS filtering

false

integer (int32) array

programIdList

List of program IDs MPTS-to-SPTS filtering

false

integer (int32) array

resolution

Video resolution

false

enum (SD, HD, UHD, DEFAULT)

ssmIpAddresses

Source-specific multicast IP addresses at uplink

false

string array

Name Description Required Schema Default

inputBitrate

The ingest bitrate (bps) of input

true

integer (int32)

time

The time information for statistic, e.g. 2015-11-04T09:11:33Z

true

string (date-time)

Name Description Required Schema Default

activeInputIndex

Index of active ip input

false

integer (int32)

fecStatistics

Fec statistic

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.FecStatistic

id

Unique identifier of a UplinkInput in UUID format

true

string

pidStatisticsList

Cloudlink Pid Statistic

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.PidStatistics array

rtpStatistics

Rtp statistic

false

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.RtpStatistics

uplinkEventReportingList

Event reports of uplink input

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting array

uplinkInputStatistic

The event description of of the input

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatisticEntry array

uplinkStreamingStatus

The status of the output of uplink, ERROR means no stream output which is not expected.

true

enum (ACTIVE, ERROR)

Name Description Required Schema Default

outputBitrate

The bitrate (bps) of output

true

integer (int32)

time

The time information for statistic, e.g. 2015-11-04T09:11:33Z

true

string (date-time)

Name Description Required Schema Default

currentVersion

Current version of cloudlink.

false

string

id

Id of the uplink

true

string

ipAddress

IP address of the uplink

true

string

isInitialized

[Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.

false

boolean

name

Display name of a uplink

true

string

needToBeUpgraded

[Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.

false

boolean

publicIpAddress

Public IP address of the uplink

true

string

rank

Priority of Uplink. Auto assigned when uplink is created. It can be updated afterwards.

false

integer (int32)

version

Version which need to be upgraded to.

false

string

Name Description Required Schema Default

downlinkInputStatisticList

The event description of the Downlink input

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkInputStatisticEntry array

uplinkOutputStatisticList

The event description of the Uplink output

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkOutputStatisticEntry array

Name Description Required Schema Default

id

Id of the uplink

true

string

lastActivityTime

Auto generated. last activity timing of uplink.

true

java.time.LocalDateTime

upgradeStatus

Upgrade status of uplink

true

enum (IDLE, UPGRADING, ROLLBACK, AVAILABLE_UPGRADE)

uplinkChannelStatusList

List of UplinkChannelStatus

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkChannelStatus array

uplinkEventReportingList

Event reports of uplink

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting array

uplinkState

Auto generated. if lost communication with up more than 5 minutes, it will become loss.

true

enum (UP, LOST)

uplinkStatistic

Statistic of the uplink.

true

com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatistic

Name Description Required Schema Default

endpointUrl

false

string

id

false

string

ipInputs

false

com.harmonicinc.vos.app.uplink.hub.uplinkchannel.impl.IpInput array

variantPlaylistFileName

false

string

Name Description Required Schema Default

ipAddress

IP address of IP input

true

string

ipPort

IP port of IP input

true

integer (int32)

rank

Rank of IP input

true

integer (int32)

ssmIpAddresses

List of SSM IP addresses of IP input

false

string array

Name Description Required Schema Default

outputIpAddress

Destination IP address

true

string

outputPort

Destination port

true

integer (int32)

rank

Destination rank

true

integer (int32)

com.harmonicinc.vos.asset.acquisition.model.AssetIngestStatistics

Name Description Required Schema Default

count

false

integer (int32)

ecu

false

integer (int32)

ingestDurationInSeconds

false

integer (int64)

llcu

false

integer (int32)

record

false

integer (int32)

sourcesSizeInBytes

false

integer (int64)

timestamp

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.AudioChannel

Name Description Required Schema Default

audioType

false

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY)

ignore

false

boolean

labels

false

string array

language

false

string

position

[@Deprecated FRONT_LEFT (Use LEFT_SURROUND instead). @Deprecated FRONT_RIGHT (Use RIGHT_SURROUND instead). @Deprecated BACK_LEFT (Use LEFT_BACK_SURROUND instead). @Deprecated BACK_RIGHT (Use RIGHT_BACK_SURROUND instead).]

false

enum (LEFT, RIGHT, CENTER, LFE, LEFT_SURROUND, RIGHT_SURROUND, LEFT_BACK_SURROUND, RIGHT_BACK_SURROUND, FRONT_LEFT, FRONT_RIGHT, BACK_LEFT, BACK_RIGHT)

type

false

enum (AUDIO_1_0, AUDIO_2_0, AUDIO_5_1, AUDIO_7_1)

com.harmonicinc.vos.asset.acquisition.model.AudioGrooming

Name Description Required Schema Default

audioTracks

false

com.harmonicinc.vos.asset.acquisition.model.GroomingAudioTrack array

com.harmonicinc.vos.asset.acquisition.model.CuePointInfo

Name Description Required Schema Default

cueIn

false

number (float) array

cueOut

false

number (float) array

cueOutCont

false

number (float) array

com.harmonicinc.vos.asset.acquisition.model.DecisionTemplate

Name Description Required Schema Default

aodTranscodingProfiles

false

string array

groomingProfileIds

false

string array

priority

false

enum (URGENT, RUSH, NORMAL, BACKLOG)

transcodingProfiles

false

string array

transcodingProfilesMap

false

object

com.harmonicinc.vos.asset.acquisition.model.DrmProperties

Name Description Required Schema Default

drmEnabled

false

boolean

drmPropertiesEntries

false

com.harmonicinc.vos.asset.acquisition.model.DrmPropertiesEntry array

com.harmonicinc.vos.asset.acquisition.model.DrmPropertiesEntry

Name Description Required Schema Default

drmResourceID

false

string

drmSystemID

false

string

drmTrackFilter

false

string

id

false

integer (int64)

packageType

false

enum (HLS, DASH, SS, CMAF, TS, THUMBNAIL)

packagingProfilePropertiesName

false

string

com.harmonicinc.vos.asset.acquisition.model.ExternalStorageUsageStatistics

Name Description Required Schema Default

endpointName

false

string

externalAssetStorageName

false

string

externalAssetStorageType

false

string

externalAssetStorageUsageInBytes

false

integer (int64)

id

false

integer (int32)

instanceId

false

string

reportTime

false

string

com.harmonicinc.vos.asset.acquisition.model.GeoBlockingProperties

Name Description Required Schema Default

enabled

Deprecated

false

boolean

geoBlockingMode

Deprecated

false

enum (ALLOW, PROHIBIT)

geoLocations

Deprecated

false

com.harmonicinc.vos.asset.acquisition.model.GeoLocation array

ipAddressWhiteList

Deprecated

false

string array

com.harmonicinc.vos.asset.acquisition.model.GeoLocation

Name Description Required Schema Default

country

false

string

region

false

string

com.harmonicinc.vos.asset.acquisition.model.GroomingAudioTrack

Name Description Required Schema Default

audioChannels

false

com.harmonicinc.vos.asset.acquisition.model.AudioChannel array

size

false

integer (int32)

streamName

false

string

trackId

false

integer (int32)

trackType

false

enum (PCM, DOLBY_E, DOLBY_AC3, AAC, MPEG1)

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

Name Description Required Schema Default

audioGrooming

false

com.harmonicinc.vos.asset.acquisition.model.AudioGrooming

groomingFileType

false

enum (MXF, TS, MP4, MOV, AUDIO_COMPRESSED, AUDIO_UNCOMPRESSED)

groomingMode

false

enum (UPDATE, OVERRIDE)

id

false

string

name

false

string

subtitlesGrooming

false

com.harmonicinc.vos.asset.acquisition.model.SubtitlesGrooming

com.harmonicinc.vos.asset.acquisition.model.GroomingSubtitleTrack

Name Description Required Schema Default

language

false

string

line

false

integer (int32)

page

false

integer (int32)

streamName

false

string

trackId

false

integer (int32)

type

false

enum (CLOSED_CAPTION, TELETEXT, DVB)

com.harmonicinc.vos.asset.acquisition.model.JobStatistics

Name Description Required Schema Default

externalStorageUsageStatistics

false

com.harmonicinc.vos.asset.acquisition.model.ExternalStorageUsageStatistics

overallJobStatistics

false

com.harmonicinc.vos.asset.acquisition.model.OverallJobStatistics

periodicalJobStatistics

false

com.harmonicinc.vos.asset.acquisition.model.PeriodicalJobStatistics array

storageStatistics

false

com.harmonicinc.vos.asset.acquisition.model.StorageStatistics

com.harmonicinc.vos.asset.acquisition.model.OutputAudioTrack

Name Description Required Schema Default

audioTrackType

false

string

bitrate

false

integer (int64)

bitrateMode

false

string

channels

false

string

codec

false

string

codecSettings

false

string

duration

false

integer (int64)

language

false

string

samplingRate

false

string

com.harmonicinc.vos.asset.acquisition.model.OutputSubtitleTrack

Name Description Required Schema Default

duration

false

integer (int64)

format

false

string

language

false

string

subtitleType

false

string

com.harmonicinc.vos.asset.acquisition.model.OutputVideoTrack

Name Description Required Schema Default

bitrateKbps

false

integer (int64)

bitrateMode

false

string

codec

false

string

codecProfile

false

string

colorSpace

false

string

durationSec

false

integer (int64)

dynamicRange

false

string

frameRate

false

number (double)

height

false

integer (int64)

maximumBitrateKbps

false

integer (int64)

resolution

false

string

transferCharacteristics

false

string

videoFrameRate

false

com.harmonicinc.vos.asset.acquisition.rest.model.FrameRate

width

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.OutputsMediaInfo

Name Description Required Schema Default

audioTracks

false

com.harmonicinc.vos.asset.acquisition.model.OutputAudioTrack array

audioTracksNumber

false

integer (int32)

empty

false

boolean

generalTrackDurationMs

false

integer (int64)

subtitleTracks

false

com.harmonicinc.vos.asset.acquisition.model.OutputSubtitleTrack array

subtitleTracksNumber

false

integer (int32)

transcodingProfileId

false

string

videoTracks

false

com.harmonicinc.vos.asset.acquisition.model.OutputVideoTrack array

videoTracksNumber

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.model.OverallJobStatistics

Name Description Required Schema Default

averageQueueTimeInSec

false

integer (int64)

errors

false

integer (int64)

jobsInQueue

false

integer (int32)

jobsNeedDecision

false

integer (int32)

jobsProcessing

false

integer (int32)

overallJobs

false

integer (int64)

titlesInLibrary

false

integer (int64)

transcodedHours

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.PeriodicalJobStatistics

Name Description Required Schema Default

assetIngestStatistics

false

com.harmonicinc.vos.asset.acquisition.model.AssetIngestStatistics

jobsCompleted

false

integer (int32)

jobsFailed

false

integer (int32)

outputDurationSec

false

integer (int64)

readyQueueJobsCount

false

integer (int32)

readyQueueSourceDurationInSeconds

false

integer (int64)

timestamp

false

integer (int64)

transcodedSourcesSizeInBytes

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.Segment

Name Description Required Schema Default

markIn

false

integer (int64)

markOut

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.StorageStatistics

Name Description Required Schema Default

internalStorageUsedInBytes

false

integer (int64)

localAssetStorageInBytes

false

integer (int64)

loopRecordStorageUsedInBytes

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.model.SubtitlesGrooming

Name Description Required Schema Default

dvbSubtitleHandling

false

enum (PASSTHROUGH, OCR_TO_WEBVTT)

ocrConversionBackgroundColor

false

string

subtitles

false

com.harmonicinc.vos.asset.acquisition.model.GroomingSubtitleTrack array

com.harmonicinc.vos.asset.acquisition.model.TaskError

Name Description Required Schema Default

description

false

string

fullErrorMessage

false

string

reason

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.ExportLog

Name Description Required Schema Default

assetId

false

string

destination

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.ExportLogDestination

endTime

false

string

errorMessage

false

string

exportId

false

string

exportType

false

enum (PACKAGE, TRANSCODE)

outputId

false

string

packageId

false

string

startTime

false

string

status

false

enum (PROCESSING, ERROR, FINISHED)

transcodeExporting

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.TranscodeExporting

com.harmonicinc.vos.asset.acquisition.model.fileserver.ExportLogDestination

Name Description Required Schema Default

fileServerId

false

string

path

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAsset

Name Description Required Schema Default

id

false

string

inputAssetFileServer

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.InputAssetFileServer array

labels

false

string array

subtitlesAssetFileServer

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.SubtitlesAssetFileServer array

title

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAssetDetails

Name Description Required Schema Default

inputAssets

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerInputAssetDetails array

vodTitleId

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerAssetExport

Name Description Required Schema Default

destination

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerExportDestination

outputId

false

string

packageId

false

string

transcodeExporting

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.TranscodeExporting

type

false

enum (PACKAGE, TRANSCODE)

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerExportDestination

Name Description Required Schema Default

fileServerId

false

string

path

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerGraphic

Name Description Required Schema Default

fileServerId

false

string

labels

false

string array

path

false

string

title

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerInputAssetDetails

Name Description Required Schema Default

progress

false

integer (int32)

status

false

enum (DOWNLOADING, FAILED, COMPLETED)

com.harmonicinc.vos.asset.acquisition.model.fileserver.FileServerSubtitle

Name Description Required Schema Default

labels

false

string array

subtitlesAssetFileServer

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.SubtitlesAssetFileServer array

title

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.InputAssetFileServer

Name Description Required Schema Default

fileServerId

false

string

path

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.SubtitlesAssetFileServer

Name Description Required Schema Default

fileServerId

false

string

language

false

string

pacParams

false

com.harmonicinc.vos.asset.acquisition.model.fileserver.SubtitlesAssetFileServer$PacParams

path

false

string

subtitleType

false

enum (NORMAL, HARD_OF_HEARING, FORCED)

com.harmonicinc.vos.asset.acquisition.model.fileserver.SubtitlesAssetFileServer$PacParams

Name Description Required Schema Default

codePage

false

enum (LATIN, TURKISH, JAPANESE, KOREAN, CHS, CHT, CYRILLIC, THAI, HEBREW, ARABIC, CZECH, GREEK)

offset

false

string

com.harmonicinc.vos.asset.acquisition.model.fileserver.TranscodeExporting

Name Description Required Schema Default

index

An index (from 1 to xx) for the size of the file to export. index '1' means the bigger file in size will be exported. To export all files, set this to null or remove it.

false

integer (int32)

prefix

false

string

com.harmonicinc.vos.asset.acquisition.model.validation.ExternalValidation

Name Description Required Schema Default

category

false

string

message

false

string

severity

false

enum (INFO, WARNING, ERROR)

testName

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.ActionParameters

Name Description Required Schema Default

actionTypes

false

enum (e_CLONE, e_TRIM, e_TRANSCODE, e_GROOM, e_VQ, e_REINDEX) array

cloneParameters

false

com.harmonicinc.vos.asset.acquisition.rest.model.CloneParameters

groomingParameters

false

com.harmonicinc.vos.asset.acquisition.rest.model.GroomingParameters

transcodingParameters

false

com.harmonicinc.vos.asset.acquisition.rest.model.TranscodingParameters

trimParameters

false

com.harmonicinc.vos.asset.acquisition.rest.model.TrimParameters

vqParameters

false

com.harmonicinc.vos.asset.acquisition.rest.model.VideoQualityParameters

com.harmonicinc.vos.asset.acquisition.rest.model.ActionResponse

Name Description Required Schema Default

assetId

false

string

transcodingJobs

false

string array

com.harmonicinc.vos.asset.acquisition.rest.model.Asset

Name Description Required Schema Default

altThumbnailPath

false

string

creationDate

false

string

cuePoints

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestCuePointsInfo array

description

false

string

destinationProfileId

false

string

drm

false

com.harmonicinc.vos.asset.acquisition.model.DrmProperties

duration

false

integer (int64)

endTime

false

integer (int64)

fileFormat

false

string

filePath

false

string

fileSize

false

integer (int64)

geoBlockingProperties

Deprecated

false

com.harmonicinc.vos.asset.acquisition.model.GeoBlockingProperties

id

false

string

inputAssets

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestInputAsset array

labels

false

string array

location

false

enum (LOCAL, S3, LLCU, ECU, EXTERNAL, BLOB, GCS, LIVE_EVENT_RECORD, LOOP_RECORD, AKAMAI_S3)

logo

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestLogo

outputs

false

com.harmonicinc.vos.asset.acquisition.rest.model.OutputAsset array

refServiceId

false

string

resolution

false

string

startTime

false

integer (int64)

subtitleAssets

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleAsset array

tcEndTime

false

string

tcStartTime

false

string

thumbnailPath

false

string

timeShiftBuffers

false

string array

title

false

string

trimSegments

false

com.harmonicinc.vos.asset.acquisition.model.Segment array

com.harmonicinc.vos.asset.acquisition.rest.model.AssetDestinationProfileDetails

Name Description Required Schema Default

destinationProfileId

false

string

outputs

false

com.harmonicinc.vos.asset.acquisition.rest.model.OutputDestinationProfileDetails array

com.harmonicinc.vos.asset.acquisition.rest.model.AssetMetadata

Name Description Required Schema Default

groomedMediaInfo

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestMediaInfo

originalMediaInfo

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestMediaInfo

outputsMediaInfo

false

com.harmonicinc.vos.asset.acquisition.model.OutputsMediaInfo array

com.harmonicinc.vos.asset.acquisition.rest.model.CloneParameters

Name Description Required Schema Default

replace

false

boolean

title

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.ConfigureServiceInfo

Name Description Required Schema Default

configureServiceType

false

enum (LIVE_EVENT_RECORD, LOOP_RECORD, LIVE)

id

false

string

name

false

string

operationalState

false

enum (OFFLINE, INITIALIZING, RUNNING)

previewInfos

false

com.harmonicinc.vos.asset.acquisition.rest.model.PreviewInfo array

timeShiftBufferSize

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.Decision

Name Description Required Schema Default

assetIds

List of assets to transcode

true

string array

customGroomingProfile

Profile for grooming

false

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

groomingProfileIds

List of grooming profiles to apply to assets

false

string array

labels

false

string array

priority

Job priority

true

enum (URGENT, RUSH, NORMAL, BACKLOG)

transcodingProfiles

List of transcoding profiles to apply to assets

true

string array

com.harmonicinc.vos.asset.acquisition.rest.model.DestinationProfileUpdateRequest

Name Description Required Schema Default

destinationProfileId

false

string

outputs

false

com.harmonicinc.vos.asset.acquisition.rest.model.OutputDestinationProfileUpdate array

com.harmonicinc.vos.asset.acquisition.rest.model.FrameRate

Name Description Required Schema Default

denominator

false

integer (int64)

numerator

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.rest.model.GeneralSettings

Name Description Required Schema Default

applyDefaultDecision

false

boolean

applyS3Refresher

false

boolean

cdnPlaybackProtocol

false

enum (HTTP, HTTPS)

copySourceFilesFromS3

false

boolean

decisionTemplate

false

com.harmonicinc.vos.asset.acquisition.model.DecisionTemplate

defaultFileServerId

false

string

disableDefaultDecisionPath

false

string

drmSettings

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestDrmSettings

enableThumbnailIndexing

false

boolean

eraseInputFiles

false

boolean

externalStorageUsageCollectionPeriodInHours

false

integer (int32)

fileFormatConversionProfileId

false

string

generatePreview

false

boolean

keepSourceFiles

false

boolean

localCopyRevisePeriod

false

integer (int32)

logoTemplateId

false

string

originPlaybackUrlSecured

false

boolean

previewProfileId

false

string

s3CopyFileSizeLimit

false

integer (int64)

s3RefresherInitialDelay

false

integer (int32)

s3RefresherUpdatePeriod

false

integer (int32)

storageUsageCollectionPeriodInHours

false

integer (int32)

subtitlesLanguageCodes

false

string array

com.harmonicinc.vos.asset.acquisition.rest.model.Graphic

Name Description Required Schema Default

creationDate

false

string

description

false

string

durationMs

false

integer (int64)

fileFormat

false

string

filePath

false

string

fileServerId

false

string

fileSize

false

integer (int64)

frameRate

false

number (double)

graphicType

false

enum (GRAPHIC, LOGO, AUDIO, HTML_GRAPHIC)

id

false

string

labels

false

string array

localCopyStatus

false

enum (MISSING, SUBMITTED, LOADING, FAILED, READY)

location

false

enum (LOCAL, S3, LLCU, ECU, EXTERNAL, BLOB, GCS, LIVE_EVENT_RECORD, LOOP_RECORD, AKAMAI_S3)

resolution

false

string

s3Url

false

string

sourceLocalCopyFilePath

false

string

thumbnailPath

false

string

title

false

string

uri

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.GroomingParameters

Name Description Required Schema Default

customGroomingProfile

false

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

groomingProfile

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.Job

Name Description Required Schema Default

assetId

false

string

completedTimestamp

false

integer (int64)

completedTimestampUtc

false

string

estimatedTimestamp

false

integer (int64)

estimatedTimestampUtc

false

string

fileTranscoder

false

enum (INTERNAL, HARMONIC_CLOUD)

groomingProfileId

false

string

id

false

string

jobPriority

false

enum (RUSH, NORMAL, BACKLOG)

jobStatus

false

enum (QUEUED, PROCESSING, FINISHED)

jobType

false

enum (TRANSCODING, PACKAGING, VQ, REINDEXING)

sourceAsset

false

com.harmonicinc.vos.asset.acquisition.rest.model.SourceAsset

sourceAssets

false

com.harmonicinc.vos.asset.acquisition.rest.model.SourceAsset array

startedTimestamp

false

integer (int64)

startedTimestampUtc

false

string

submittedTimestamp

false

integer (int64)

submittedTimestampUtc

false

string

tasks

false

com.harmonicinc.vos.asset.acquisition.rest.model.Task array

validationStatus

false

enum (VALIDATED, REJECTED)

validations

false

com.harmonicinc.vos.asset.acquisition.model.validation.ExternalValidation array

com.harmonicinc.vos.asset.acquisition.rest.model.LlcuAssetBase

Name Description Required Schema Default

drmSetting

false

com.harmonicinc.vos.app.unifiedoriginengine.api.java.llcu.drm.DrmSettings

id

false

string

ingestEndTime

false

string (date-time)

ingestStartTime

false

string (date-time)

sourceUri

false

string

Name Description Required Schema Default

graphicId

false

string

horizontalOffset

false

integer (int32)

id

false

string

name

false

string

opacity

false

integer (int32)

placement

false

enum (TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT)

verticalOffset

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.OriginOutput

Name Description Required Schema Default

packageInfos

false

com.harmonicinc.vos.asset.acquisition.rest.model.PackageInfo array

com.harmonicinc.vos.asset.acquisition.rest.model.OutputAsset

Name Description Required Schema Default

destinationProfileId

false

string

estimationTimeSec

false

integer (int64)

id

false

string

originOutput

false

com.harmonicinc.vos.asset.acquisition.rest.model.OriginOutput

packagedOutputs

Packaged outputs by the cloud engine

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestPackageOutput array

percentage

false

integer (int32)

playbackUrls

false

object

previewUrls

false

object

profileId

false

string

status

false

enum (QUEUED, SUBMITTED, PROCESSING, FINISHED, FAILED, CANCELING, CANCELED, RECONCILING, REJECTED)

vqPassed

false

boolean

com.harmonicinc.vos.asset.acquisition.rest.model.OutputDestinationProfileDetails

Name Description Required Schema Default

destinationProfileId

false

string

profileId

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.OutputDestinationProfileUpdate

Name Description Required Schema Default

destinationProfileId

false

string

profileId

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.PackageInfo

Name Description Required Schema Default

format

false

enum (DASH, HLS, SS, CMAF, RAW_TS, THUMBNAIL, MP4)

name

false

string

url

false

string

urlType

false

enum (PLAYBACK, PREVIEW)

com.harmonicinc.vos.asset.acquisition.rest.model.PreviewInfo

Name Description Required Schema Default

format

false

string

name

false

string

url

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RecordCreationRequest

Name Description Required Schema Default

endTime

false

string (date-time)

id

false

string

refServiceId

false

string

startTime

false

string (date-time)

tcEndTime

false

string

tcStartTime

false

string

title

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestAudioTrack

Name Description Required Schema Default

audioTrackType

false

string

bitDepth

false

integer (int64)

bitrate

false

integer (int64)

bitrateKbps

false

integer (int64)

bitrateMode

false

string

channelS

false

string

codec

false

string

codecSettings

false

string

duration

false

integer (int64)

durationSec

false

integer (int64)

id

false

string

kindOfStream

false

string

labels

false

string array

language

false

string

resolutionNumber

false

integer (int64)

samplingRate

false

string

skipProcessing

false

boolean

com.harmonicinc.vos.asset.acquisition.rest.model.RestBlobServerInstance

Name Description Required Schema Default

accountKey

false

string

accountName

false

string

containerName

false

string

id

false

string

rank

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.RestCuePointsInfo

Name Description Required Schema Default

data

false

string

timeOffset

false

integer (int64)

type

false

enum (OUT)

com.harmonicinc.vos.asset.acquisition.rest.model.RestDataTrack

Name Description Required Schema Default

id

false

integer (int64)

skipProcessing

false

boolean

com.harmonicinc.vos.asset.acquisition.rest.model.RestDrmSettings

Name Description Required Schema Default

destinationProfileID

false

string

drmSystemSettings

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestDrmSystemSettings array

encryptionEnabled

false

boolean

com.harmonicinc.vos.asset.acquisition.rest.model.RestDrmSystemSettings

Name Description Required Schema Default

drmContentId

false

string

drmSystemID

false

string

packagingProfilePropertiesName

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestExternalAssetStatus

Name Description Required Schema Default

errorMessage

false

string

status

false

enum (PROCESSING, DOWNLOADING, READY, FAILED)

url

false

java.net.URL

com.harmonicinc.vos.asset.acquisition.rest.model.RestFileServerSetup

Name Description Required Schema Default

blobInstances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestBlobServerInstance array

ftpInstances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestFtpServerInstance array

gcsInstances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestGcsServerInstance array

id

false

string

mediaGridInstances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestMediaGridServerInstance array

nfsInstances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestNfsServerInstance array

overwrite

false

boolean

ownership

false

enum (User, Harmonic)

retries

false

integer (int32)

s3Instances

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestS3ServerInstance array

timeout

false

integer (int32)

type

false

enum (SFTP, NFS, BLOB, S3, MEDIAGRID, GCS)

com.harmonicinc.vos.asset.acquisition.rest.model.RestFtpServerInstance

Name Description Required Schema Default

hostname

false

string

id

false

string

password

false

string

port

false

integer (int32)

rank

false

integer (int32)

username

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestGcsServerInstance

Name Description Required Schema Default

bucketName

false

string

bucketPrefix

false

string

clientEmail

false

string

hmacAccessKey

false

string

hmacSecretKey

false

string

id

false

string

privateKey

false

string

rank

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.RestGeneralTrack

Name Description Required Schema Default

duration

false

integer (int64)

durationMs

false

integer (int64)

durationTimecode

false

string

format

false

string

size

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.rest.model.RestInputAsset

Name Description Required Schema Default

cuePointInfo

false

com.harmonicinc.vos.asset.acquisition.model.CuePointInfo

duration

false

integer (int64)

durationMs

false

integer (int64)

externalAssetUrl

false

string

fileFormat

false

string

filePath

false

string

fileServerId

false

string

fileSize

false

integer (int64)

groomingProfileId

false

string

invalid

false

boolean

invalidityReason

false

string

localCopyStatus

false

enum (MISSING, SUBMITTED, LOADING, FAILED, READY)

location

false

enum (LOCAL, S3, LLCU, ECU, EXTERNAL, BLOB, GCS, LIVE_EVENT_RECORD, LOOP_RECORD, AKAMAI_S3)

resolution

false

string

s3Url

false

string

sourceLocalCopyFilePath

false

string

uri

false

string

Name Description Required Schema Default

graphicId

false

string

horizontalOffset

false

integer (int32)

opacity

false

integer (int32)

placement

false

enum (TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT)

verticalOffset

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.RestMediaGridServerInstance

Name Description Required Schema Default

hostname

false

string

id

false

string

password

false

string

path

false

string

rank

false

integer (int32)

username

false

string

watchingEnabled

false

boolean

com.harmonicinc.vos.asset.acquisition.rest.model.RestMediaInfo

Name Description Required Schema Default

audioTracks

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestAudioTrack array

audioTracksNumber

false

integer (int32)

dataTracks

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestDataTrack array

generalTrack

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestGeneralTrack

invalidityReason

false

string

subtitleTracks

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleTrack array

subtitlesTracksNumber

false

integer (int32)

videoTrack

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestVideoTrack

videoTracks

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestVideoTrack array

com.harmonicinc.vos.asset.acquisition.rest.model.RestNfsServerInstance

Name Description Required Schema Default

hostname

false

string

id

false

string

path

false

string

rank

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.RestPackageOutput

Name Description Required Schema Default

destinationProfileId

false

string

fileSize

false

integer (int64)

format

false

enum (DASH, HLS, SS, CMAF, RAW_TS, THUMBNAIL, MP4)

url

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestS3ServerInstance

Name Description Required Schema Default

accessKey

false

string

bucket

false

string

bucketPrefix

false

string

hostname

false

string

id

false

string

rank

false

integer (int32)

region

false

string

secretAccessKey

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentList

Name Description Required Schema Default

segments

false

string array

title

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentTitled

Name Description Required Schema Default

markIn

false

integer (int64)

markOut

false

integer (int64)

title

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentation

Name Description Required Schema Default

assetId

false

string

id

false

string

segmentationData

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentationData

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentationData

Name Description Required Schema Default

segments

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentTitled array

segmentsLists

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSegmentList array

com.harmonicinc.vos.asset.acquisition.rest.model.RestSourceDownloadStatus

Name Description Required Schema Default

downloaded

@Deprecated. It will be removed in the coming releases.

false

integer (int64)

fileSize

false

integer (int64)

status

false

enum (PROCESSING, DOWNLOADING, READY, FAILED)

url

false

java.net.URL

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitle

Name Description Required Schema Default

filepath

false

string

language

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleAsset

Name Description Required Schema Default

filePath

false

string

id

false

string

language

false

string

location

false

enum (LOCAL, S3, LLCU, ECU, EXTERNAL, BLOB, GCS, LIVE_EVENT_RECORD, LOOP_RECORD, AKAMAI_S3)

pacParams

false

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleAsset$PacParams

rank

false

integer (int32)

sourceFileName

false

string

subtitleType

false

enum (NORMAL, HARD_OF_HEARING, FORCED)

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleAsset$PacParams

Name Description Required Schema Default

codePage

false

enum (LATIN, TURKISH, JAPANESE, KOREAN, CHS, CHT, CYRILLIC, THAI, HEBREW, ARABIC, CZECH, GREEK)

offset

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestSubtitleTrack

Name Description Required Schema Default

duration

false

integer (int64)

durationSec

false

integer (int64)

format

false

string

id

false

integer (int64)

language

false

string

pageNumber

false

string

subtitleType

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.RestVideoTrack

Name Description Required Schema Default

bitDepth

false

integer (int64)

bitrate

false

integer (int64)

bitrateKbps

false

integer (int64)

bitrateMode

false

string

chromaSubsampling

false

string

codec

false

string

codecProfile

false

string

colorPrimaries

false

string

colorSpace

false

string

colorimetry

false

string

compressionMode

false

string

displayAspectRatio

false

string

duration

false

integer (int64)

durationSec

false

integer (int64)

dynamicRange

false

string

firstFrameTimeCode

false

string

frameRate

false

number (double)

height

false

integer (int64)

id

false

integer (int64)

interlacement

false

string

kindOfStream

false

string

matrixCoefficient

false

string

maximumBitrateMode

false

integer (int64)

maximumBitrateModeKbps

false

integer (int64)

resolution

false

string

resolutionNumber

false

integer (int64)

scanOrder

false

string

scanType

false

string

transferCharacteristics

false

string

videoFrameRate

false

com.harmonicinc.vos.asset.acquisition.rest.model.FrameRate

width

false

integer (int64)

com.harmonicinc.vos.asset.acquisition.rest.model.SourceAsset

Name Description Required Schema Default

duration

false

integer (int64)

durationMs

false

integer (int64)

fileName

false

string

fileSize

false

integer (int64)

format

false

string

frameRate

false

number (double)

scanType

false

string

title

false

string

videoResolution

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.Task

Name Description Required Schema Default

estimationInSec

false

integer (int64)

groomingProfile

false

com.harmonicinc.vos.asset.acquisition.model.GroomingProfile

groomingProfileId

false

string

id

false

string

outputsMediaInfo

false

com.harmonicinc.vos.asset.acquisition.model.OutputsMediaInfo

percentage

false

integer (int32)

profileId

false

string

status

false

enum (QUEUED, PROCESSING, FINISHED, FAILED, REJECTED, CANCELING, CANCELED)

taskError

false

com.harmonicinc.vos.asset.acquisition.model.TaskError

taskId

false

string

transcodingAttempt

false

integer (int32)

com.harmonicinc.vos.asset.acquisition.rest.model.TranscodingParameters

Name Description Required Schema Default

transcodingProfiles

false

string array

com.harmonicinc.vos.asset.acquisition.rest.model.TrimParameters

Name Description Required Schema Default

replace

false

boolean

segments

false

com.harmonicinc.vos.asset.acquisition.model.Segment array

title

false

string

com.harmonicinc.vos.asset.acquisition.rest.model.VideoQualityParameters

Name Description Required Schema Default

assetPath

false

string

fileServerId

false

string

outputAssetId

false

string

com.harmonicinc.vos.backuprestore.DeleteStatus

Name Description Required Schema Default

message

false

string

state

false

enum (COMPLETED, FAILED)

com.harmonicinc.vos.backuprestore.rest.BackupInfo

Name Description Required Schema Default

backupId

false

string

date

false

string (date-time)

imageSoftwareVersion

false

string

size

false

integer (int64)

softwareVersion

false

string

state

false

enum (PENDING, IN_PROGRESS, COMPLETED, FAILED)

com.harmonicinc.vos.backuprestore.rest.ScheduledBackupStatus

Name Description Required Schema Default

enabled

false

boolean

nextBackupTime

false

string (date-time)

periodMs

false

integer (int64)

com.harmonicinc.vos.backuprestore.rest.StartScheduledBackupRequest

Name Description Required Schema Default

initialDelayMs

false

integer (int64)

periodMs

false

integer (int64)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AACAudioProperties

Name Description Required Schema Default

aacAudioType

AAC audio type of aac audio stream

false

enum (AAC, AAC_LATM)

numberOfChannels

Number of channels at aac audio stream

true

integer (int32)

sampleRate

Sample rate at aac audio stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AES3AudioProperties

Name Description Required Schema Default

aes3StreamTypeList

AES3 streams type

true

enum (PCM, DOLBY_EAC3, DOLBY_E, DOLBY_AC3) array

numberOfChannels

Number of channels at aes3 audio stream

true

integer (int32)

sampleRate

Sample rate at aes3 audio stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AudioStream

Name Description Required Schema Default

aacAudioProperties

Properties of AAC audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AACAudioProperties

aes3AudioProperties

Properties of AES3 audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AES3AudioProperties

audioStreamType

Type of audio stream

false

enum (MPEG, AAC, DOLBY_E, DOLBY_DIGITAL, DOLBY_DIGITAL_PLUS, DOLBY_AC4, AES3)

descriptors

Descriptors of audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Descriptor array

dolbyAc4Properties

Properties of dolby digital AC4 audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyAC4Properties

dolbyAudioSystemType

Type of audio system type

false

enum (ATSC, DVB)

dolbyDigitalAudioProperties

Properties of dolby digital audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyDigitalAudioProperties

dolbyEAudioProperties

Properties of dolby E audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyEAudioProperties

maxBitrate

Max Bitrate of audio stream

false

integer (int32)

mpegAudioProperties

Properties of MPEG audio stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MPEGAudioProperties

pid

Pid of audio stream

false

integer (int32)

sampleRate

SampleRate of audio stream

false

integer (int32)

scrambled

Scrambled status of audio stream

false

boolean

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Avs2Properties

Name Description Required Schema Default

avs2Level

Level of AVS2 stream

true

enum (LEVEL_2_0_15, LEVEL_2_0_30, LEVEL_2_0_60, LEVEL_4_0_30, LEVEL_4_0_60, LEVEL_6_0_30, LEVEL_6_2_30, LEVEL_6_0_60, LEVEL_6_2_60, LEVEL_6_0_120, LEVEL_6_2_120, LEVEL_8_0_30, LEVEL_8_2_30, LEVEL_8_0_60, LEVEL_8_2_60, LEVEL_8_0_120, LEVEL_8_2_120, LEVEL_10_0_30, LEVEL_10_2_30, LEVEL_10_0_60, LEVEL_10_2_60, LEVEL_10_0_120, LEVEL_10_2_120)

avs2Profile

Profile of AVS2 stream

true

enum (PROFILE_MAIN_PICTURE, PROFILE_MAIN, PROFILE_MAIN_10)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AvsProperties

Name Description Required Schema Default

avsLevel

Level of AVS stream

true

enum (LEVEL_1_0_0_08_07, LEVEL_1_0_0_08_15, LEVEL_1_0_0_08_30, LEVEL_2_0, LEVEL_2_1_0_08_15, LEVEL_2_1_0_08_30, LEVEL_4_0, LEVEL_4_2, LEVEL_4_0_0_10_30, LEVEL_4_0_0_12_30, LEVEL_4_0_2_08_60, LEVEL_6_0, LEVEL_6_0_1_08_60, LEVEL_6_2, LEVEL_6_0_3_08_60, LEVEL_6_0_5_08_60)

avsProfile

Profile of AVS stream

true

enum (PROFILE_JIZHUN, PROFILE_SHENZHAN, PROFILE_YIDONG, PROFILE_JIAQIANG, PROFILE_GUANGBO)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CaptionServiceDescriptor

Name Description Required Schema Default

captionServiceDescriptorData

Data of Caption Service Descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CaptionServiceDescriptorData array

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number of caption service

true

integer (int32)

language

Language code of caption service

true

string

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CustomDescriptor

Name Description Required Schema Default

descriptorContent

Content of descriptor represented in base64 encoded string

true

string

descriptorTag

Tag of descriptor

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DVB_SubtitlingDescriptor

Name Description Required Schema Default

dvbSubtitlingDescriptorData

Data of DVB Subtitling Descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DVB_SubtitlingDescriptorData array

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DVB_SubtitlingDescriptorData

Name Description Required Schema Default

ancillaryPageId

Ancillary PageId of DVB data stream

true

integer (int32)

compositionPageId

Composition PageId of DVB data stream

true

integer (int32)

language

Language code of data stream

true

string

subtitlingType

Subtitling Type of DVB data stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DataStream

Name Description Required Schema Default

dataStreamType

Type of data stream

false

enum (SCTE27, SCTE35, DVB_SUBTITLING, TELETEXT, ID3, ARIB37, DVB_TTML, ST2038, UNKNOWN)

descriptors

Descriptors of data stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Descriptor array

maxBitrate

Max Bitrate of data stream

false

integer (int32)

pid

Pid of data stream

false

integer (int32)

pmtStreamType

Num value of dataStreamtype from PMT

false

integer (int32)

scrambled

Scrambled status of data stream

false

boolean

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Descriptor

Name Description Required Schema Default

captionServiceDescriptor

Caption Service Descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CaptionServiceDescriptor

customDescriptor

Custom descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.CustomDescriptor

descriptorType

Type of descriptor

true

enum (ISO639, DVB_SUBTITLING, CAPTION_SERVICE, TELETEXT, TTML, CUSTOM)

dvbSubtitlingDescriptor

Dvb descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DVB_SubtitlingDescriptor

iso639Descriptor

ISO639 descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.ISO639Descriptor

teletextDescriptor

Teletext descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TeletextDescriptor

ttmlDescriptor

TTML Descriptor

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TtmlDescriptor

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyAC4Properties

Name Description Required Schema Default

ac4BitrateMode

Ac4 Bitrate mode

true

enum (AC4_CBR, AC4_ABR, AC4_VBR)

dolbyAC4ChannelMode

Ac4 Channel Mode

true

enum (AC4_CHMOD_MONO, AC4_CHMOD_STEREO, AC4_CHMOD_3_0, AC4_CHMOD_5_0, AC4_CHMOD_5_1, AC4_CHMOD_7_0_340, AC4_CHMOD_7_1_340_1, AC4_CHMOD_7_0_520, AC4_CHMOD_7_1_520_1, AC4_CHMOD_7_0_322, AC4_CHMOD_7_1_322_1, AC4_CHMOD_7_0_4, AC4_CHMOD_7_1_4)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyDigitalAudioProperties

Name Description Required Schema Default

dolbyBsid

Bitstream Identification of Dolby Digital audio stream

true

integer (int32)

dolbyDigitalAudioChannelMode

Channel Mode of Dolby Digital audio stream

true

enum (ACM_1_1_DUAL_MONO, ACM_1_0_C, ACM_2_0_LR, ACM_3_0_LCR, ACM_2_1_LRLs, ACM_3_1_LCRLs, ACM_2_2_LRLsRs, ACM_3_2_LCRLsRs, ACM_3_3_LCRCs, ACM_3_4_LCRLsRsLrsRrs)

lfeChannelEnabled

LFE channel turn on/off at audio stream

true

boolean

sampleRate

Sample rate of Dolby Digital audio stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DolbyEAudioProperties

Name Description Required Schema Default

dolbyEFrameRate

Dolby E Frame rate

true

enum (DOLBYE_FR_23_98, DOLBYE_FR_24, DOLBYE_FR_25, DOLBYE_FR_29_97, DOLBYE_FR_30)

dolbyEProgramConfig

Number of programs at Dolby E audio stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.FrameRate

Name Description Required Schema Default

denominator

Denominator of framerate

true

integer (int32)

numerator

Numerator of framerate

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.H264Properties

Name Description Required Schema Default

h264Level

Level of H264 stream

true

enum (LEVEL_1_0, LEVEL_1_1, LEVEL_1_2, LEVEL_1_3, LEVEL_2_0, LEVEL_2_1, LEVEL_2_2, LEVEL_3_0, LEVEL_3_1, LEVEL_3_2, LEVEL_4_0, LEVEL_4_1, LEVEL_4_2, LEVEL_5_0, LEVEL_5_1, LEVEL_5_2)

h264Profile

Profile of H264 stream

true

enum (BASELINE, MAIN, EXTENDED, HIGH, HIGH_10, HIGH_422, HIGH_444)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.H265Properties

Name Description Required Schema Default

h265Level

Level of H265 stream

true

enum (LEVEL_1_0, LEVEL_2_0, LEVEL_2_1, LEVEL_3_0, LEVEL_3_1, LEVEL_4_0, LEVEL_4_1, LEVEL_5_0, LEVEL_5_1, LEVEL_5_2, LEVEL_6_0, LEVEL_6_1, LEVEL_6_2)

h265Profile

Profile of H265 stream

true

enum (MAIN, MAIN_10, MAIN_STILL_PICTURE, MAIN_422_10)

h265Tier

Tier of H265 stream

true

enum (MAIN, HIGH)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.ISO639Descriptor

Name Description Required Schema Default

iso639DescriptorData

Data of ISO639 Descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.ISO639DescriptorData array

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.ISO639DescriptorData

Name Description Required Schema Default

iso639AudioType

AudioType of audio stream

true

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE)

language

Language code of stream

true

string

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.JpegxsProperties

Name Description Required Schema Default

jpegxsLevel

Level of JPEG-XS stream

true

enum (LEVEL_UNRESTRICTED, LEVEL_1_K_1, LEVEL_2_K_1, LEVEL_4_K_1, LEVEL_4_K_2, LEVEL_4_K_3, LEVEL_8_K_1, LEVEL_8_K_2, LEVEL_8_K_3, LEVEL_10_K_1)

jpegxsProfile

Profile of JPEG-XS stream

true

enum (PROFILE_UNRESTRICTED, PROFILE_LIGHT_422_10, PROFILE_LIGHT_444_12, PROFILE_LIGHT_SUBLINE_422_10, PROFILE_MAIN_420_12, PROFILE_MAIN_422_10, PROFILE_MAIN_444_12, PROFILE_MAIN_4444_12, PROFILE_HIGH_444_12, PROFILE_HIGH_4444_12, PROFILE_MLS_12, PROFILE_LIGHT_BAYER, PROFILE_MAIN_BAYER, PROFILE_HIGH_BAYER)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MPEG2VideoProperties

Name Description Required Schema Default

mpeg2ProfileAndLevel

Level and profile of MPEG2 stream

true

enum (PL_SIMPLE_MAIN, PL_MAIN_HIGH, PL_MAIN_HIGH_1440, PL_MAIN_MAIN, PL_MAIN_LOW, PL_HIGH_HIGH, PL_HIGH_HIGH_1440, PL_HIGH_MAIN, PL_422_MAIN, PL_422_HIGH)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MPEGAudioProperties

Name Description Required Schema Default

mpegAudioChannelMode

Channel Mode of mpeg audio stream

true

enum (STEREO, JOINT_STEREO, DUAL_CHANNEL, SINGLE_CHANNEL)

mpegAudioType

MPEG audio type of mpeg audio stream

false

enum (MPEG, MPEG_1, MPEG_2)

sampleRate

Sample rate of Dolby Digital audio stream

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MediaInfoProbeResult

Name Description Required Schema Default

completionTimestamp

Completion Timestamp of Discovery Task

false

integer (int64)

connectionInformation

Information about connection to source

false

com.harmonicinc.vos.app.sourcemonitor.model.connection.ConnectionInformation

demuxSource

Demux Source

true

com.harmonicinc.vos.app.sourcemonitor.model.DemuxSource

hspSource

HSP Source

true

com.harmonicinc.vos.app.sourcemonitor.model.HspSource

ipSource

IP setting of Source

true

com.harmonicinc.vos.app.sourcemonitor.model.IPSource

mpegPrograms

Information of MPEG Programs

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MpegProgram array

probingDurationInMs

Probing duration used for discovery in milliseconds

false

integer (int32)

rfsource

RF Source

true

com.harmonicinc.vos.app.sourcemonitor.model.RFSource

sourceType

Type of source

true

enum (IP, ZIXI, SRT, HSP, CLOUD, RF, DEMUX)

srtSource

SRT Source

true

com.harmonicinc.vos.app.sourcemonitor.model.SrtSource

zixiSource

Zixi Source

true

com.harmonicinc.vos.app.sourcemonitor.model.ZixiSource

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MpegProgram

Name Description Required Schema Default

audioStreams

Properties of Audio Streams

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AudioStream array

dataStreams

Properties of Data Streams

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.DataStream array

descriptors

Descriptors of Mpeg program

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Descriptor array

pcrPid

Program clock Reference pid

false

integer (int32)

pmtPid

Program map table pid

false

integer (int32)

programName

Program name of mpeg program

false

string

programNameCodingTable

Hex value of coding table of program name. Support range defined in Annex A of ETSI EN 300 468 V1.16.1 (e.g. will return "0x14" for Traditional Chinese).

false

string

programNameUTF8

Program name of mpeg program in UTF-8

false

string

programNumber

Program number of the mpeg program

false

integer (int32)

providerName

Provider name of mpeg program

false

string

providerNameCodingTable

Hex value of coding table of provider name. Support range defined in Annex A of ETSI EN 300 468 V1.16.1 (e.g. will return "0x14" for Traditional Chinese).

false

string

providerNameUTF8

Provider name of mpeg program in UTF-8

false

string

serviceType

Service type of the mpeg program

false

integer (int32)

videoStream

Properties of Video Stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.VideoStream

videoStreamList

Properties of Video Streams

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.VideoStream array

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Resolution

Name Description Required Schema Default

height

Height of resolution

true

integer (int32)

width

Width of resolution

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TeletextDescriptor

Name Description Required Schema Default

teletextDescriptorData

Data of Teletext Descriptor

true

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TeletextDescriptorData array

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TeletextDescriptorData

Name Description Required Schema Default

language

Language code of data stream

true

string

teletextMagazineNumber

Magazine number of teletext stream

true

integer (int32)

teletextPageNumber

Page number of teletext stream

true

integer (int32)

teletextType

Type of teletext

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.TtmlDescriptor

Name Description Required Schema Default

ttmlExtPayload

Remaining descriptor payload

true

string

ttmlLanguage

TTML Language Code

true

string

ttmlSubtitlePurpose

TTML subtitle_purpose

true

integer (int32)

ttmlTtsSuitability

TTML TTS Suitability

true

integer (int32)

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.VideoStream

Name Description Required Schema Default

avs2Properties

Properties of AVS2 stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Avs2Properties

avsProperties

Properties of AVS stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.AvsProperties

descriptors

Descriptors of video stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Descriptor array

frameRate

FrameRate of video stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.FrameRate

h264Properties

Properties of H264 stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.H264Properties

h265Properties

Properties of H265 stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.H265Properties

jpegxsProperties

Properties of JPEG-XS stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.JpegxsProperties

maxBitrate

Max Bitrate of video stream

false

integer (int32)

mpeg2VideoProperties

Properties of MPEG2 Video stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.MPEG2VideoProperties

pid

Pid of video stream

false

integer (int32)

resolution

Resolution of video stream

false

com.harmonicinc.vos.datapath.sourcemonitor.probe.result.model.Resolution

scrambled

Scrambled status of video stream

false

boolean

videoStreamType

Type of video stream

false

enum (H264, H265, MPEG2, AVS, AVS2, JPEGXS)

com.harmonicinc.vos.esam.pois.config.EsamConfig

Name Description Required Schema Default

numberOfInstances

Number of instances of ESAM Pod, set to 1 to enable and 0 to disable ESAM Pod

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.AACProfileProperties

Name Description Required Schema Default

aacCenterMixLevel

Center Mix Level (DownMix metadata)

false

enum (e_0Db, e_Minus_1dot5Db, e_Minus_3Db, e_Minus_4dot5Db, e_Minus_6Db, e_Minus_7dot5Db, e_Minus_9Db, e_MinusInfinityDb)

aacComprTargetRefLevel

[-31 to -1] Compr Target Reference Level (ETSI metadata)

false

integer (int32)

aacDownmixMethod

Downmix Method (DownMix metadata)

false

enum (e_Both, e_MatrixMixDown, e_AncillaryData)

aacDrcProfile

DRC profile (MPEG metadata)

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

aacDrcTargetRefLevel

[-31 to -1] DRC Target Reference Level (MPEG metadata)

false

integer (int32)

aacHeader

AAC Header

false

enum (e_ADTS, e_LATM)

aacHeavyCompressionProfile

Heavy Compression Profile (ETSI metadata)

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

aacMetadataEnable

AAC meta data enable/disable

false

boolean

aacMpegVersion

AAC standard (Mpeg Version)

false

enum (e_MPEG2, e_MPEG4)

aacProgramReferenceLevel

[-31 to -1] program reference level (MPEG metadata)

false

integer (int32)

aacSurroundMixLevel

Surround Mix Level (DownMix metadata)

false

enum (e_0Db, e_Minus_1dot5Db, e_Minus_3Db, e_Minus_4dot5Db, e_Minus_6Db, e_Minus_7dot5Db, e_Minus_9Db, e_MinusInfinityDb)

fallbackAacCenterMixLevel

Fallback Center Mix Level (DownMix metadata)

false

enum (e_0Db, e_Minus_1dot5Db, e_Minus_3Db, e_Minus_4dot5Db, e_Minus_6Db, e_Minus_7dot5Db, e_Minus_9Db, e_MinusInfinityDb)

fallbackAacComprTargetRefLevel

[-31 to -1] Fallback Compr Target Reference Level (ETSI metadata)

false

integer (int32)

fallbackAacDrcProfile

Fallback DRC profile (MPEG metadata)

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

fallbackAacDrcTargetRefLevel

[-31 to -1] Fallback DRC Target Reference Level (MPEG metadata)

false

integer (int32)

fallbackAacHeavyCompressionProfile

Fallback Heavy Compression Profile (ETSI metadata)

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

fallbackAacProgramReferenceLevel

[-31 to -1] Fallback program reference level (MPEG metadata)

false

integer (int32)

fallbackAacSurroundMixLevel

Fallback Surround Mix Level (DownMix metadata)

false

enum (e_0Db, e_Minus_1dot5Db, e_Minus_3Db, e_Minus_4dot5Db, e_Minus_6Db, e_Minus_7dot5Db, e_Minus_9Db, e_MinusInfinityDb)

com.harmonicinc.vos.labwizard.rest.model.ATSDestinationProfileProperties

Name Description Required Schema Default

abWatermarkIncrementValue

Port offset to apply to B output from A value when Nagra A/B OTT watermark is enabled

false

integer (int32)

audioCarriedMode

Describe the way that the audio will be delivered.

true

enum (e_ALL, e_TOP, e_MATCH)

dataCarriedMode

Describe the way that the data will be delivered.

true

enum (e_ALL, e_TOP)

ebpAudioFragmentSize

false

integer (int32)

ebpExplicitAudio

EBP Explicit Audio

false

boolean

ebpInterval

EBP Interval

false

integer (int32)

ebpOffsetInMs

Offset of EBP timestamp

false

integer (int32)

ebpOnIFrame

EBP on I Frame

false

boolean

ebpSegmentSize

EBP Segment Size

false

integer (int32)

ebpTimelineEnum

EBP Timeline

false

enum (e_ETT_LOCAL_TIMELINE, e_ETT_INCOMING_TIMELINE)

encapsulationSettings

Encapsulation Settings.

true

com.harmonicinc.vos.labwizard.rest.model.EncapsulationSettings

excludedDescriptorTags

List of descriptor tags to exclude from the output PMT.

false

integer (int32) array

eyeQEncapsulation

EyeQ encapsulation mode.

false

enum (e_TRIM_NULL_PACKET, e_PRESERVE_NULL_PACKET)

muteOutputOnSignalLoss

Mute TS output when input signal loss

false

boolean

rtvodFlag

The Nielsen RTVOD flag to be inserted to the audio.

false

enum (e_NONE, e_AUTO, e_C3, e_C7)

rules

List of ATS Rules

true

com.harmonicinc.vos.labwizard.rest.model.ATSRule array

com.harmonicinc.vos.labwizard.rest.model.ATSRule

Name Description Required Schema Default

atsRuleType

ATS Rule Type

true

enum (e_BITRATE_RULE, e_VIDEORES_RULE, e_CODEC_RULE)

bitrateRule

ATS Bitrate Rules

false

com.harmonicinc.vos.labwizard.rest.model.ATSRule$AtsBitrateRule

com.harmonicinc.vos.labwizard.rest.model.ATSRule$AtsBitrateRule

Name Description Required Schema Default

maxBitrate

ATS max bit rate

true

integer (int32)

minBitrate

ATS min bit rate

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.AllowedAddon

Name Description Required Schema Default

isLiveEvent

Enable/Disable Live Event service support.

false

boolean

isVideoSlateInsertion

Enable/Disable VideoSlate Insertion. When disabled, will generate alarm if VideoSlate is provisioned to the service.

false

boolean

com.harmonicinc.vos.labwizard.rest.model.AribAmcList

Name Description Required Schema Default

mode0x01

Applied when received mode from B.39 is 0x01

false

enum (e_Noop, e_Mono_1, e_Stereo_11, e_Stereo_Silence)

mode0x02

Applied when received mode from B.39 is 0x02

false

enum (e_Noop, e_Dual_12, e_Stereo_11, e_Stereo_22, e_Mono_1, e_Mono_2, e_Stereo_Silence)

mode0x09

Applied when received mode from B.39 is 0x09

false

enum (e_Noop, e_Stereo_12, e_Stereo_Silence)

mode0x0a

Applied when received mode from B.39 is 0x0a

false

enum (e_Noop, e_Stereo_12, e_Stereo_34, e_Stereo_78, e_Dual_Down12_Down34, e_Dual_Down12_Down78, e_Stereo_Silence)

mode0x12

Applied when received mode from B.39 is 0x12

false

enum (e_Noop, e_Multich51_123456, e_Stereo_Down123456, e_Stereo_78, e_Stereo_Silence)

mode0x15

Applied when received mode from B.39 is 0x15

false

enum (e_Noop, e_Multich51_123456, e_Stereo_Down123456, e_Stereo_78, e_Stereo_Silence)

modeBackup

Applied when B.39 is missing

false

enum (e_Noop, e_Multich51_123456, e_Stereo_12, e_Stereo_34, e_Dual_12, e_Stereo_Silence)

modeDefault

Applied at the start-up

false

enum (e_Multich51_123456, e_Stereo_12, e_Stereo_78, e_Dual_12)

modeUndefined

When value received from B.39 is not defined, this value is used

false

enum (e_Noop, e_Dual_12)

com.harmonicinc.vos.labwizard.rest.model.AribAudioModeChange

Name Description Required Schema Default

aribAmcList

Arib AMC List for VANC input

false

com.harmonicinc.vos.labwizard.rest.model.AribAmcList

backupPair

Fallback pair

false

enum (e_None, e_G1P1, e_G1P2)

enableAudioMode

Enable aribAmcList

false

boolean

es2ExBackToLeadPair

LeadPair used for Es2 and Es2_Ex

false

enum (e_None, e_G1P2, e_G2P2)

secondBitrate

Override Bitrate in case of ES_1

false

integer (int32)

vancModeChange

Arib Vanc Audio Mode change

false

enum (e_None, e_ES1, e_ES2, e_ES2_Extended)

com.harmonicinc.vos.labwizard.rest.model.AttributeCustomizationProfileProperties

Name Description Required Schema Default

attributeCustomizationProperties

attributeCustomizationProperties

false

com.harmonicinc.vos.labwizard.rest.model.AttributeCustomizationProperties array

name

name

false

string

com.harmonicinc.vos.labwizard.rest.model.AttributeCustomizationProperties

Name Description Required Schema Default

bandwidthTune

bandwidthTune

false

com.harmonicinc.vos.labwizard.rest.model.BandwidthTune

streamSelectionGroup

streamSelectionGroup

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.StreamSelectionGroup

com.harmonicinc.vos.labwizard.rest.model.AudioLevelAdjustmentProperties

Name Description Required Schema Default

audioLevelAlgorithm

audio level algorithm

false

enum (e_None, e_StaticGain, e_HALC)

targetLevel

static gain target level

false

enum (e_None, e_m15, e_m16, e_m17, e_m18, e_m19, e_m20, e_m21, e_m22, e_m23, e_m24, e_m25, e_m26, e_m27, e_m28, e_m29, e_m30, e_m31)

com.harmonicinc.vos.labwizard.rest.model.AudioMixingProperties

Name Description Required Schema Default

firstAudioTargetLevel

Target intermediate loudness for the first mixing audio

false

enum (e_None, e_m15, e_m16, e_m17, e_m18, e_m19, e_m20, e_m21, e_m22, e_m23, e_m24, e_m25, e_m26, e_m27, e_m28, e_m29, e_m30, e_m31)

secondAudioTargetLevel

Target intermediate loudness for the second mixing audio

false

enum (e_None, e_m15, e_m16, e_m17, e_m18, e_m19, e_m20, e_m21, e_m22, e_m23, e_m24, e_m25, e_m26, e_m27, e_m28, e_m29, e_m30, e_m31)

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixerConfig

Name Description Required Schema Default

upmixerConfig

Configuration for audio channel upmixer

false

enum (e_Disable, e_Upmix, e_UpmixWithAutoSense)

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixingProperties

Name Description Required Schema Default

upmixingMode

Upmixing Mode

false

enum (e_GROUP_3_PAIRS_INTO_5_1_OUTPUT)

com.harmonicinc.vos.labwizard.rest.model.BandwidthTune

Name Description Required Schema Default

averageBandwidthDeviation

averageBandwidthDeviation

false

integer (int32)

bandwidthDeviation

bandwidthDeviation

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.CaptionServiceDescriptor

Name Description Required Schema Default

captionServiceDescriptorData

false

com.harmonicinc.vos.labwizard.rest.model.CaptionServiceDescriptorData array

com.harmonicinc.vos.labwizard.rest.model.CaptionServiceDescriptorData

Name Description Required Schema Default

captionServiceNumber

Caption service number of caption service in the range [1..63] if digital_cc == 1. It has no meaning if digital_cc == 0

true

integer (int32)

digitalCc

Digital CC of caption service: 0⇒608, 1⇒708

true

integer (int32)

easyReader

Easy reader of caption service. It has no meaning if digital_cc == 0

true

integer (int32)

language

ISO 639.2/B 3 character language code of caption service. It has no meaning if digital_cc == 0

true

string

line21Field

Line21 field if digital_cc == 0. It has no meaning if digital_cc == 1

true

integer (int32)

wideAspectRatio

Wide aspect ratio of caption service: 0=4/3, 1=16/9. It has no meaning if digital_cc == 0

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.CcToDvbSubtitleConversionProperties

Name Description Required Schema Default

bkgTransparency

Background transparency (range: 0-100, default: 100)

false

integer (int32)

dvbPageTimeout

Specifies the DVB PageTimeOut value (integer value in sec)

false

number (double)

font

Font name (default: dejavu)

false

string

fontDensity

Horizontal font density

false

number (double)

forceDdsOn

Display Definition Segment flag (default: false)

false

boolean

frameSize

Subtitle frame size (default: e_FOLLOW_OUTPUT)

false

enum (e_1920x1080, e_1280x720, e_720x576, e_720x480, e_FOLLOW_OUTPUT)

language

Subtitle language (default:ENG)

false

enum (ENG, DEU, SWE, FIN, HUN, ITA, FRA, POR, SPA, CES, SLK, POL, TUR, SRP, HRV, SLV, RON, EST, LAV, LIT, RUS, BUL, UKR, ELL, ARA, HEB)

pageId

Page ID (range: 0-255, default: 0)

false

integer (int32)

subtitleType

Output DVB subtitle descriptor type (default: e_NORMAL_0x10)

false

enum (e_NORMAL_0x10, e_NORMAL_4_3_0x11, e_NORMAL_16_9_0x12, e_NORMAL_2_21_1_0x13, e_NORMAL_HD_0x14, e_HEARING_0x20, e_HEARING_4_3_0x21, e_HEARING_16_9_0x22, e_HEARING_2_21_1_0x23, e_HEARING_HD_0x24)

txtOutlineWidth

Outline width in pixel (range: 0.0-10.0, default: 0)

false

number (double)

com.harmonicinc.vos.labwizard.rest.model.CmafPackagingProperties

Name Description Required Schema Default

adaptationSetIdPattern

The pattern for generating the AdaptationSet ID in MPD document.The following patterns are supported:%mediaType - stream media type, %index - numbers in order

false

string

altWatermarkOutputPrefix

Alternative watermark output prefix, which will be added to the beginning of all playlist, manifest and segment name.

false

string

availabilityTimeOffset

The availability time offset property (expressed in milliseconds) for chunked CMAF low-latency mode.
Will be calculated automatically if -1 is set.

false

integer (int32)

ccHandling

(Deprecated) Enable CC subtitle conversion

false

enum (e_NONE, e_TO_IMSC1)

chunkDurationInMillisecond

The duration of the CMAF chunk in milliseconds.

false

integer (int32)

cmafEncryptionMethod

Specify which encryption method should be used when integrate with DRM.

true

enum (e_CLEAR, e_CENC)

commonEncryptionScheme

Common encryption scheme

false

enum (CENC_CBCS, CENC_CENC)

customGroupingProfileId

Specify the HLS Audio Grouping Profile to customize the HLS playlist audio and video grouping.

false

string

dashAnnotationType

DASH annotation type

false

enum (e_NONE, e_NBC, e_GENERIC)

dashCcHandling

Enable CC subtitle conversion for DASH

false

enum (e_NONE, e_PASSTHROUGH, e_TO_IMSC1, e_TO_WEBVTT_FMP4, e_TO_WEBVTT) array

dashEnableFillGapNearPeriodStart

Enable CMAF DASH period alignment

false

boolean

dashInsertAudioRole

Include the AudioRole tag to the audio Adaption Set. Used only if mediaPresentationProfile is e_ISO_LIVE

false

boolean

dashInsertCustomStreamName

Insert custom name as label in CMAF-DASH manifest.

false

boolean

dashKeyRotationSignalling

Configuration of DASH key rotation signalling:
- MANIFEST_BASED_SINGLE_PERIOD (Manifest-based, Single Period)
- IN_BAND (Segment-based, Single Period)
Default: MANIFEST_BASED_SINGLE_PERIOD

false

enum (MANIFEST_BASED_SINGLE_PERIOD, IN_BAND)

dashScte35Carriage

Obsolete

false

enum (e_INBAND_SEGMENT_BINARY, e_IN_MPD_BASE64) array

dashScte35GenericProperties

DASH SCTE-35 Generic Properties

false

com.harmonicinc.vos.labwizard.rest.model.Scte35GenericProperties

dashTeletextHandling

Enable Teletext subtitle conversion for DASH

false

enum (e_NONE, e_TO_IMSC1, e_TO_WEBVTT_FMP4, e_TO_WEBVTT) array

dashUsePtsAsPto

Use PTS as PTO in DASH manifest

false

boolean

decodeTimeShiftToPlayTime

Enable to shift decoding timeline to match the presentation timeline, resulting in same first DTS and PTS for each segment, as well as potential negative CTO in segment

false

boolean

disableHdrEssentialProperty

Disable EssentialProperty from DASH Manifest

false

boolean

displayHResolutionRounding

The function that will be used to round the display horizontal resolution.

false

enum (e_TO_FLOOR, e_TO_CLOSEST_EVEN)

displayHdcpLevelAttribute

Specify whether to show HDCP-LEVEL attribute for each stream on HLS master playlist.

false

boolean

dvrWindowSize

Control of the availability of media segment files most recently added to the Media Presentation Description (MPD) file (expressed in seconds).

true

integer (int32)

enableChunkedCMAF

Enable chunked CMAF to support low latency OTT delivery

false

boolean

enableCountryCode

Use ISO Country Code in language identification

false

boolean

enableExtXGapTag

Enable the insertion of HLS GAP tag in the playlist during periods of content loss. This helps indicate missing content segments in the HLS stream.

false

boolean

enableKeyRotation

Enable key rotation.

true

boolean

enablePackageBasedKeyRotation

Override the DRM global setting and enable customized per Package output key rotation setting

true

boolean

enablePackagingWatermarking

Enable Synamedia Watermark feature

false

boolean

enableThumbnailGeneration

Enable segment thumbnail generation

false

boolean

encryptSEI

Enable SEI encryption for HLS fmp4 package output, if value is false, encryption of SEI entry will be skipped

false

boolean

hlsAnnotationType

HLS annotation type

false

enum (e_NONE, e_NBC, e_GENERIC)

hlsCcHandling

Enable CC subtitle conversion for HLs

false

enum (e_NONE, e_PASSTHROUGH, e_TO_IMSC1, e_TO_WEBVTT) array

hlsInsertCustomStreamName

Insert custom name as NAME attribute in CMAF-HLS manifest.

false

boolean

hlsScte35GenericProperties

SCTE-35 Generic Properties

false

com.harmonicinc.vos.labwizard.rest.model.HlsScte35GenericProperties

hlsTeletextHandling

Enable Teletext subtitle conversion for HLS

false

enum (e_NONE, e_TO_IMSC1, e_TO_WEBVTT) array

indexFileNameForIFrameOnlyStreamForFlattenedMode

An index file is an ordered list of media URLs and informational tags. Each media URL refers to a media file which is a segment of a I-Frame Only stream. This setting specifies the file name of the index file for each variant stream excluding file extension (i.e. .m3u8).

Supported escape pattern:
%streamid Stream ID

Sample configuration: %streamid
Resultant file name: 01.m3u8

true

string

indexFileNameForMediaStreamForFlattenedMode

An index file is an ordered list of media URLs and informational tags. Each media URL refers to a media file which is a segment of a single contiguous stream. This setting specifies the file name of the index file for each variant stream excluding file extension (i.e. .m3u8).

Supported escape pattern:
%streamid Stream ID
%streamid:streamIdFormat=%0{number}llu Stream ID in some format, for example %01llu. %02llu is the default.

Sample configuration: %streamid
Resultant file name: 01.m3u8
Sample configuration: %streamid:streamIdFormat=%01llu
Resultant file name: 1.m3u8

true

string

insertAdaptationSetId

Include the Id attribute to the AdaptionSet element in MPD document

false

boolean

insertAudioChannels

Specify whether the CHANNEL value must be inserted in master playlist for each audio track.

false

boolean

insertDefaultKIDToManifest

Insert default Key ID to CMAF-DASH manifest. Default value is true.

false

boolean

insertParAndSarAttributesInMpd

Include AdaptationSet@par and Representation@sar attributes in DASH manifest.

false

boolean

insertPrftToManifest

Insert ProducerReferenceTime to manifest.

false

boolean

keepOverlayPlcmtOppInClear

Keep Overlay Placement Opportunity in Clear

false

boolean

keyChangePeriod

The key change period for key rotation (expressed in seconds).

true

integer (int32)

latencyMax

Service Description: the service provider’s indication about the maximum presentation latency in milliseconds.

false

integer (int32)

latencyMin

Service Description:: the service provider’s indication about the minimum presentation latency in milliseconds.

false

integer (int32)

latencyTarget

Service Description: the service provider’s preferred presentation latency in milliseconds compared to the producer reference time.

false

integer (int32)

minBufferTimeInMs

The minimum buffer time of dash manifest.

false

integer (int32)

minimumUpdatePeriod

The minimum update period of dash manifest.

false

integer (int32)

mpdAccessibilityComplianceMode

Change the Accessibility tag compliance in the Media Presentation Description (MPD). Used to switch to DASH-IF compliance mode

false

enum (e_DVB_DASH, e_DASH_IF, e_BYTEL)

mpdFileName

The name of Media Presentation Description (MPD) file which is used to describe a Media Presentation.

true

string

nameAttribute

Name attribute

false

enum (DEFAULT, IN_ENGLISH, IN_NATIVE)

numberBasedSegments

Enable number based segment instead of time based segments

false

boolean

passThroughParameterSets

Pass-through Parameter Sets. Video parameter sets can be stored in sample entry only (sample entry name is 'hvc1' for HEVC or 'avc1' for AVC) or video parameter sets can be stored in sample entry and samples (sample entry name is 'hev1' for HEVC or 'avc3' for AVC).

false

enum (e_AVC1_HVC1, e_AVC3_HEV1)

playbackRateMax

Service Description:: the maximum playback rate that the content provider indicates is appropriate for the purposes of automatically adjusting playback latency and buffer occupancy during normal playback, where 1.0 is normal playback speed.

false

number (double)

playbackRateMin

Service Description:: the minimum playback rate that the content provider indicates is appropriate for the purposes of automatically adjusting playback latency and buffer occupancy during normal playback, where 1.0 is normal playback speed.

false

number (double)

scopeSchemeIdUri

Service Description: Scope element SchemeIdUri

false

string

scopeValue

Service Description: Scope element Value

false

string

scte35AnnotationTag

Control the tag for annotating SCTE35 message on HLS playlist

false

enum (e_SCTE35, e_DATERANGE, e_ALL_ANNOTATION)

scte35CreateNewPeriodForNbcOverlayPlacement

Creation of a new period for Overlay Placement SCTE-35 messages in NBC mode.

false

boolean

scte35DaterangeTagsInMs

Use milliseconds for SCTE-35 EXT-X-DATERANGE tag

false

boolean

scte35DefaultAutoReturnDuration

SCTE-35 Default Auto-return Duration, for segmentation mode e_NBC only.

false

integer (int32)

scte35RetainProgramChapterStart

Retain program/chapter start SCTE-35 messages in NBC mode

false

boolean

scte35SegmentationMode

SCTE 35 segmentation mode

true

enum (e_NONE, e_NBC, e_GENERIC)

segmentFileExtension

Segment file extension

false

enum (e_M4V_M4A, e_MP4)

segmentLengthInMillisecond

The duration of the media segment files (in seconds).

true

integer (int32)

segmentRetentionPeriod

The duration that the media segment files actually retain in the publishing server (expressed in minutes).

true

integer (int32)

segmentTemplateType

The type of segment template for constructing segment URL. 'TIME_BASED' means time-based segment template; 'NUMBER_BASED' means number-based segment template. Default is 'TIME_BASED'

false

enum (e_TIME_BASED, e_NUMBER_BASED)

serviceDescription

Add Service Description in manifest. It allows to sync all the players (supporting low-latency) to a similar latency, based on the PRFT value.

false

boolean

skipDuplicateExtXKeyTag

Skip duplicate EXT-X-KEY tags

false

boolean

specifyStartingLivePoint

Specify starting live point

false

boolean

startingLivePoint

Starting live point in seconds. A positive number indicates a time offset from the beginning of the Playlist. A negative number indicates a negative time offset from the end of the last Media Segment in the Playlist.

false

integer (int32)

suggestedPresentationDelayMillisecond

The suggested presentation delay is to let the player to play behind the live point (expressed in milliseconds) to encounter buffer issues.
Optimal value will be used if -1 is set.
Default value is -1.

false

integer (int32)

targetDuration

Set the target duration in playlist (in seconds). 0 means follow segment duration

false

integer (int32)

teletextHandling

(Deprecated) Enable Teletext subtitle conversion

false

enum (e_NONE, e_TO_IMSC1)

thumbnailHeight

Segment thumbnail height

false

integer (int32)

ttmlTemplate

The TTML template. String in XML that allows to control how output TTML looks like.

false

string

urlOrderOfVariantPlaylist

Specify how the playlist URLs are arranged in the variant playlist.

true

enum (e_BITRATE_ASCENDING, e_BITRATE_DESCENDING)

useISO6391LanguageCode

Use ISO 639-1 language codes

false

boolean

useUnifiedSegmenter

Use UnifiedSegmenter for new CMAF live data-path

false

boolean

utcTimingSchemeIdUri

UTCTiming element SchemeIdUri, this element will be added in Dash manifest to help synchronize Dash client with the server

false

enum (e_NONE, e_HTTP_XSDATE, e_HTTP_ISO, e_HTTP_NTP, e_NTP, e_HTTP_HEAD)

utcTimingValue

UTCTiming element Value, available if UtcTimingSchemeIdUri is not 'None'

false

string

variantPlaylistFileName

The variant playlist lists the URLs of each variant stream to allow clients to switch between encodings dynamically. This setting specifies the file name of the variant playlist excluding file extension (i.e. .m3u8). For example, if this value is set to 'master' (excluding ''), the actual file name will be 'master.m3u8'.

true

string

com.harmonicinc.vos.labwizard.rest.model.CustomDescriptor

Name Description Required Schema Default

descriptorContent

Content of descriptor represented in HEX string

true

string

descriptorTag

Tag of descriptor

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.DashPackagingProperties

Name Description Required Schema Default

adaptationSetIdPattern

The pattern for generating the AdaptationSet ID in MPD document.The following patterns are supported:%mediaType - stream media type, %index - numbers in order

false

string

altWatermarkOutputPrefix

Alternative watermark output prefix, all the manifest and segments will be appended with this prefix.

false

string

audioSegmentLength

(Deprecrated) The duration of the audio segment files (expressed in seconds).

true

integer (int32)

audioSegmentLengthInMillisecond

(Deprecrated) The duration of the audio segment files (expressed in milliseconds).

false

integer (int32)

availabilityStartTimeOffsetInMs

Offset (in milliseconds) applied to MPD@availabilityStartTime

false

integer (int32)

availabilityTimeOffset

The availability time offset property (expressed in milliseconds) for DASH chunked CMAF low-latency mode.
Will be calculated automatically if -1 is set.

false

integer (int32)

chunkDurationInMillisecond

The duration of the CMAF chunk in milliseconds.

false

integer (int32)

closedCaptionHandling

The way to handle closed caption. Can be passthrough and/or converted to SMPTE-TT and/or converted to WebVTT. Empty list implies to ignore closed caption.

false

enum (e_PASSTHROUGH, e_TO_SMPTE_TT, e_TO_WEBVTT) array

disableHdrEssentialProperty

Disable EssentialProperty from DASH Manifest

false

boolean

disableRawLines

Disable usage of Raw lines PSM and split lines algo for OCR

false

boolean

dvbSubtitleHandling

The way to handle DVB subtitle. Can be converted to SMPTE-TT and/or converted to WebVTT thanks to OCR and/or converted to SMPTE-TT text based thanks to OCR. Empty list implies to ignore DVB subtitle.

false

enum (e_TO_SMPTE_TT, e_TO_WEBVTT_OCR, e_TO_SMPTE_TT_TEXT_OCR) array

dvbTtmlHandling

The way to handle DVB TTML. Can be converted to SMPTE-TT. Empty list implies to ignore DVB TTML.

false

enum (e_TO_SMPTE_TT) array

dvrWindowSize

Control of the availability of media segment files most recently added to the Media Presentation Description (MPD) file (expressed in seconds).

true

integer (int32)

enableAMSPlayerBehavior

Enable AMS Player behavior

false

boolean

enableChunkedCMAF

Enable chunked CMAF for Dash to support low latency OTT delivery

false

boolean

enableCommonSegmentUrlDelivery

Enable common segment URL delivery.

false

boolean

enableCountryCode

Use ISO Country Code in language identification

false

boolean

enableEarlyAvailablePeriod

Specify is Early Available Periods enabled, if so, in low latency mode scte35 will be inserted into manifest as Early Available Period

false

boolean

enableFillGapNearPeriodStart

Enable CMAF DASH period alignment

false

boolean

enableKeyRotation

Enable key rotation.

true

boolean

enableOttWatermark

(Deprecated) Enable OTT watermarking. When this parameter is true, two set of AB outputs will be generated with only filename difference.

false

boolean

enableOutputTtml

(Deprecated) Enable Ttml output for Dash

true

boolean

enableOutputWebvtt

(Deprecated) Enable Webvtt output for Dash

true

boolean

enablePackageBasedKeyRotation

Override the DRM global setting and enable customized per Package output key rotation setting

true

boolean

enableThumbnailGeneration

Enable thumbnail generation

false

boolean

enableWebVttSourcePositioning

Enable source positioning for WebVTT

false

boolean

enableWebVttStyling

Enable styling for WebVTT

false

boolean

encryptionMethod

Specify which encryption method should be used when integrate with DRM.

true

enum (e_PLAYREADY, e_WIDEVINE, e_CLEAR, e_CENC)

firstCodecGroupInManifest

First codec group that appears in the manifest

false

enum (e_HEVC, e_AVC)

hideLatestSegment

Hide latest segment in SegmentationTimeline. Possibly needed if watermarking is enabled

false

boolean

imageSpriteInColumn

Static POTF thumbnail per column in one tile

false

integer (int32)

imageSpriteInRow

Static POTF thumbnail per row in one tile

false

integer (int32)

insertAdaptationSetId

Include the Id attribute to the AdaptionSet element in MPD document

false

boolean

insertAudioChannelConfiguration

Include the AudioChannelConfiguration tag to the AAC Adaption Set.

false

boolean

insertAudioRole

Include the AudioRole tag to the audio Adaption Set. Used only if mediaPresentationProfile is e_ISO_LIVE

false

boolean

insertContentType

Include the ContentType attribute to the AdaptionSet element in MPD document

false

boolean

insertDefaultKIDToManifest

Insert default Key ID to manifest. Default value is false.

false

boolean

insertLabelElement

Insert Label element to Adaptation Set in DASH manifest.

false

boolean

insertParAndSarAttributesInMpd

Include AdaptationSet@par and Representation@sar attributes in DASH manifest.

false

boolean

insertPrftToManifest

Insert ProducerReferenceTime to manifest.

false

boolean

insertPrftToTimeshiftManifest

Insert ProducerReferenceTime to Timeshift manifest

false

boolean

keyChangePeriod

The key change period for key rotation (expressed in seconds).

true

integer (int32)

keyRotationSignalling

Configuration of key rotation signalling:
- MANIFEST_BASED_SINGLE_PERIOD (Manifest-based, Single Period)
- IN_BAND (Segment-based, Single Period)
Default: MANIFEST_BASED_SINGLE_PERIOD

false

enum (MANIFEST_BASED_SINGLE_PERIOD, IN_BAND)

latencyMax

Service Description: the service provider’s indication about the maximum presentation latency in milliseconds.

false

integer (int32)

latencyMin

Service Description:: the service provider’s indication about the minimum presentation latency in milliseconds.

false

integer (int32)

latencyTarget

Service Description: the service provider’s preferred presentation latency in milliseconds compared to the producer reference time.

false

integer (int32)

maxSegmentDurationSignaling

Include the MaxSegmentDuration tag to the Media Presentation Description (MPD) file. Used only if segmentTemplateType is e_TIME_BASED

false

enum (e_NONE, e_STANDARD)

mediaPresentationProfile

The profile used for generating Media Presentation Description (MPD) file that enables interoperability and signaling use of features in a Media Presentation.

The following types are supported:
ISO Live: refers to the ISO/IEC 23009-1, 8.4 ISO Base media file format live profile.
HbbTV ISO BMFF Live: refers to HbbTV ISOBMFF defined in HbbTV 1.5 specification.
DVB DASH Live: refers to ETSI TS 103 285 (MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks) specification

true

enum (e_ISO_LIVE, e_HBBTV_ISOBMFF_LIVE, e_DVB_DASH_LIVE, e_ATSC3_LIVE)

minBufferTimeInMs

The minimum buffer time of dash manifest.

false

integer (int32)

minimumUpdatePeriod

The minimum update period of dash manifest.

false

integer (int32)

mpdAccessibilityComplianceMode

Change the Accessibility tag compliance in the Media Presentation Description (MPD). Used to switch to DASH-IF compliance mode

false

enum (e_DVB_DASH, e_DASH_IF, e_BYTEL)

mpdFileName

The name of Media Presentation Description (MPD) file which is used to describe a Media Presentation.

true

string

parentalControlSignaling

Specify which parental control signal should be used.

false

enum (e_TTML, e_EMSG)

passThroughParameterSets

Pass-through Parameter Sets. When this parameter is true, the video parameter sets store in the sample entry and the samples, and the sample entry name is 'hev1' for HEVC or 'avc3' for AVC. Otherwise, the video parameter sets store only in the sample entry, and the sample entry name is 'hvc1' for HEVC or 'avc1' for AVC.

false

boolean

playbackRateMax

Service Description:: the maximum playback rate that the content provider indicates is appropriate for the purposes of automatically adjusting playback latency and buffer occupancy during normal playback, where 1.0 is normal playback speed.

false

number (double)

playbackRateMin

Service Description:: the minimum playback rate that the content provider indicates is appropriate for the purposes of automatically adjusting playback latency and buffer occupancy during normal playback, where 1.0 is normal playback speed.

false

number (double)

relativePathSegmentTemplate

Relative or absolute path in segment template

false

enum (e_AUTO, e_TRUE, e_FALSE)

representationIdPattern

The pattern for generating the Representation ID which is used in the Media Presentation Description (MPD) for each encoded version of video/audio.

The following patterns are supported:
%starttimeitem4The start time of the Publishing session
%streamIditem4Stream ID
%PIDitem4PID
%bitrate - bitrate of the representation

true

string

scopeSchemeIdUri

Service Description: Scope element SchemeIdUri

false

string

scopeValue

Service Description: Scope element Value

false

string

scte27SubtitleHandling

The way to handle SCTE-27 subtitles. Can be converted to SMPTE-TT. Empty list implies to ignore SCTE-27 subtitle.

false

enum (e_TO_SMPTE_TT, e_TO_WEBVTT_OCR, e_TO_SMPTE_TT_TEXT_OCR) array

scte35CIDPassthrough

Enable SCTE35 ContentID Handling. When this parameter is true, the Content ID signal will be pass-through by inserting a event message with base64 string on the manifest.

false

boolean

scte35Carriage

Obsolete

false

enum (e_INBAND_SEGMENT_BINARY, e_IN_MPD_BASE64) array

scte35CreateNewPeriodForNbcOverlayPlacement

Creation of a new period for Overlay Placement SCTE-35 messages in NBC mode.

false

boolean

scte35DefaultAutoReturnDuration

SCTE-35 Default Auto-return Duration, for HARMONIC handling mode only.

false

integer (int32)

scte35GenericProperties

SCTE-35 Generic Properties

false

com.harmonicinc.vos.labwizard.rest.model.Scte35GenericProperties

scte35Signaling

The way of handling SCTE35 messages. 'NONE' means ignoring the messages; 'BASE64' means writing the SCTE35 data to playlist in base64 format; 'HARMONIC' means writing the SCTE35 data to playlist in Harmonic Inc defined SCTE35 format. Default is 'NONE'

false

enum (e_NONE, e_BASE64, e_HARMONIC, e_NBC, e_GENERIC)

segmentFileExtension

Segment file extension

false

enum (e_M4V_M4A, e_MP4, e_MP4_ALL)

segmentLengthInMillisecond

The duration of the media segment files (expressed in milliseconds).

false

integer (int32)

segmentRetentionPeriod

The duration that the media segment files actually retain in the publishing server (expressed in minutes).

true

integer (int32)

segmentTemplateType

The type of segment template for constructing segment URL. 'TIME_BASED' means time-based segment template; 'NUMBER_BASED' means number-based segment template. Default is 'TIME_BASED'

false

enum (e_TIME_BASED, e_NUMBER_BASED)

serviceDescription

Add Service Description in manifest. It allows to sync all the players (supporting low-latency) to a similar latency, based on the PRFT value.

false

boolean

suggestedPresentationDelayMillisecond

The suggested presentation delay is to let the player to play behind the live point (expressed in milliseconds) to encounter buffer issues.
Optimal value will be used if -1 is set.
Default value is -1.

false

integer (int32)

teletextHandling

The way to handle teletext. Can be converted to WebVTT and/or converted to SMPTE-TT. Empty list implies to ignore DVB subtitle.

false

enum (e_TO_WEBVTT, e_TO_SMPTE_TT) array

thumbnailHeight

Thumbnail height

false

integer (int32)

ttmlTemplate

The TTML template. String in XML that allows to control how output TTML looks like.

false

string

useAbsoluteTimestamps

Property to control the availability start time. Default value is false.

false

boolean

usePtsAsPto

Use PTS as PTO in DASH manifest

false

boolean

utcTimingSchemeIdUri

UTCTiming element SchemeIdUri, this element will be added in Dash manifest to help synchronize Dash client with the server

false

enum (e_NONE, e_HTTP_XSDATE, e_HTTP_ISO, e_HTTP_NTP, e_NTP, e_HTTP_HEAD)

utcTimingValue

UTCTiming element Value, available if UtcTimingSchemeIdUri is not 'None'

false

string

videoAdaptationSetGrouping

Video Adaptation Set Grouping configuration

false

enum (BY_CODEC) array

videoSegmentLength

(Deprecrated) The duration of the video segment files (expressed in seconds).

true

integer (int32)

videoSegmentLengthInMillisecond

(Deprecrated) The duration of the video segment files (expressed in milliseconds).

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.DemuxProfileProperties

Name Description Required Schema Default

demuxMode

Specifies the demux mode

true

enum (e_MPTS_RF_TO_SPTS_IP, e_MPTS_RF_TO_MPTS_IP, e_MPTS_IP_TO_SPTS_IP)

com.harmonicinc.vos.labwizard.rest.model.DestinationProfileProperties

Name Description Required Schema Default

enableOttWatermark

Enable OTT Watermarking.

true

boolean

enablePushPackaging

External push packaging endpoints can only be specified if push packaging is enabled.

true

boolean

maxSourceTimeCodeOffset

When packager clock is source timecodes , the maximum offset , in milliseconds, between source timecodes and system time. A positive value when timecode is in the past, a negative value when timecode is in the future.

false

integer (int32)

muteOutputOnSignalLoss

Mute packager ouput on input signal loss (do not use for a packager-only service)

false

boolean

packagerClock

The originator providing source time for packager clock to follow

true

enum (e_SYSTEM_WALL_CLOCK, e_SOURCE_TIMECODES)

packagingProfilePropertiesList

The List of packaging profile properties.

true

com.harmonicinc.vos.labwizard.rest.model.PackagingProfileProperties array

timecodeLockPeriodInS

When packager clock is source timecodes , time period in s that we wait to apply a timecode jump to wall clock.

false

integer (int32)

timecodeMaxFrameCount

Applicable when packager clock is source timecodes. Defines expected max frame ticks per second for incoming timecodes (i.e. ff in hh:mm:ss:ff)

false

enum (e_SMPTE_ST_12_1, e_FRAMES_PER_SECONDS)

timecodeThresholdInMs

When packager clock is source timecodes , threshold in ms to apply to timecode checking, when comparing received timecode to expected timecode. To be frame accurate threshold must be set to 0 ms.

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.DolbyAC4AdvanceProperties

Name Description Required Schema Default

ac4AudioCodingMode

AudioCodingMode based on the standard/manual

false

enum (e_AC4ACM_10, e_AC4ACM_20, e_AC4ACM_32, e_AC4ACM_3214)

ac4AudioLevel

(Deprecated) [-31 to -1] audio level when AudioLevelAdjustment is set to Manual

false

integer (int32)

ac4AutoAudioLevelAdjustment

(Deprecated) AudioLevelAdjustment based on the standard/manual

false

enum (e_MANUAL, e_ATSC_A85, e_EBU_R128, e_ARIB_TR_B32, e_FREETV_OP59)

ac4FrameRate

AC4 FrameRate

false

enum (e_FRE_25, e_FRE_29_97)

ac4IframeInterval

range=12-1000 when FrameRate='25', range=14-1000 when FrameRate='29.97'

false

integer (int32)

bitstreamMode

Audio Service Type within the Bit Stream

false

enum (e_CompleteMain, e_MusicAndEffects, e_VisuallyImpaired, e_HearingImpaired, e_Dialog, e_Commentary, e_Emergency, e_KaraokeVoiceOver)

dialogueNormalization

Dialogue normalization. If not specified, it means auto. it should be negative

false

integer (int32)

dolbySurroundExMode

Dolby Surround EX mode. If not specified, it means auto

false

enum (e_NotIndicated, e_Disabled, e_Enabled)

fallbackBitstreamMode

Fallback Audio Service Type within the Bit Stream

false

enum (e_CompleteMain, e_MusicAndEffects, e_VisuallyImpaired, e_HearingImpaired, e_Dialog, e_Commentary, e_Emergency, e_KaraokeVoiceOver)

fallbackDialogueNormalization

Fallback Dialogue normalization. If not specified, device default value will be used as fallback

false

integer (int32)

fallbackLineModeDrc

Fallback Line mode DRC/Home Theatre. If not specified, device default value will be used as fallback

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

fallbackLoRoCenterMixLevel

Fallback Lo/Ro Center Downmix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLoRoSurroundMixLevel

Fallback Lo/Ro surround Downmix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLtRtCenterMixLevel

Fallback Lt/Rt Center Downmix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLtRtSurroundMixLevel

Fallback Lt/Rt surround Downmix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackPhaseShift

Fallback 90-degree phase shift. If not specified, device default value will be used as fallback

false

boolean

fallbackPortableHeadphoneDrc

Fallback Portable Headphone DRC. If not specified, device default value will be used as fallback

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

fallbackPortableSpeakersDrc

Fallback Portable Speakers DRC. If not specified, device default value will be used as fallback

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

fallbackRfModeDrc

Fallback RF mode DRC/Flat Panel. If not specified, device default value will be used as fallback

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

fallbackStereoDownmixPreference

Fallback Stereo downmix preference. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_NotIndicated, e_LtRtDownmix, e_LoRoDownmix)

fallbackSurroundAttenuation

Fallback 3 dB attenuation. If not specified, device default value will be used as fallback

false

boolean

heightChannelDownmix

AC4 metadata in the AC4 stream. Default: e_Auto

false

enum (e_Auto, e_Front, e_Surround, e_FrontAndSurround)

heightTrim

heightTrim, HeightMixGain) is AC4 metadata in the AC4 stream. Default: e_Height_M30.

false

enum (e_Height_00, e_Height_M15, e_Height_M30, e_Height_M45, e_Height_M60, e_Height_M90, e_Height_M120, e_Height_MINF)

lfeChannel

Specify whether to enable Lfe channel

false

boolean

lfeLowPassFilter

Lfe low pass filter. If not specified, it means auto

false

boolean

lineModeDrc

Line mode DRC/Home Theatre. If not specified, it means auto

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

loRoCenterMixLevel

Lo/Ro Center Downmix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

loRoSurroundMixLevel

Lo/Ro surround Downmix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

ltRtCenterMixLevel

Lt/Rt Center Downmix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

ltRtSurroundMixLevel

Lt/Rt surround Downmix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

phaseShift

90-degree phase shift. If not specified, it means auto

false

boolean

portableHeadphoneDrc

Portable Headphone DRC

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

portableSpeakersDrc

Portable Speakers DRC

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

rfModeDrc

RF mode DRC/Flat Panel. If not specified, it means auto

false

enum (e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech, e_Auto)

stereoDownmixPreference

Stereo downmix preference. If not specified, it means auto

false

enum (e_Auto, e_NotIndicated, e_LtRtDownmix, e_LoRoDownmix)

surroundAttenuation

3 dB attenuation. If not specified, it means auto

false

boolean

surroundTrim

surroundTrim, SurroundMixGain is AC4 metadata in the AC4 stream. Default: e_Surround_Auto

false

enum (e_Surround_Auto, e_Surround_00, e_Surround_M15, e_Surround_M30, e_Surround_M45, e_Surround_M60, e_Surround_MINF)

com.harmonicinc.vos.labwizard.rest.model.DolbyPlusAdvanceProperties

Name Description Required Schema Default

bitstreamMode

Audio Service Type within the Bit Stream

false

enum (e_CompleteMain, e_MusicAndEffects, e_VisuallyImpaired, e_HearingImpaired, e_Dialog, e_Commentary, e_Emergency, e_KaraokeVoiceOver)

dcHighpassFilter

DC high pass filter. If not specified, it means auto

false

boolean

dialogueNormalization

Dialogue normalization. If not specified, it means auto. it should be negative

false

integer (int32)

digitalDeEmphasis

Digital de-emphasis. If not specified, it means auto

false

boolean

dolbySurroundExMode

Dolby Surround EX mode. If not specified, it means auto

false

enum (e_NotIndicated, e_Disabled, e_Enabled)

dolbySurroundMode

Dolby Surround mode. If not specified, it means auto

false

enum (e_NotIndicated, e_Disabled, e_Enabled)

fallbackBitstreamMode

Fallback Audio Service Type within the Bit Stream

false

enum (e_CompleteMain, e_MusicAndEffects, e_VisuallyImpaired, e_HearingImpaired, e_Dialog, e_Commentary, e_Emergency, e_KaraokeVoiceOver)

fallbackDialogueNormalization

Fallback Dialogue normalization. If not specified, device default value will be used as fallback

false

integer (int32)

fallbackLineModeDrc

Fallback Line mode DRC. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

fallbackLoRoCenterMixLevel

Fallback Lo/Ro Center mix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLoRoSurroundMixLevel

Fallback Lo/Ro surround mix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLtRtCenterMixLevel

Fallback Lt/Rt Center mix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackLtRtSurroundMixLevel

Fallback Lt/Rt surround mix level. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

fallbackPhaseShift

Fallback 90-degree phase shift. If not specified, device default value will be used as fallback

false

boolean

fallbackRfModeDrc

Fallback RF mode DRC. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

fallbackStereoDownmixPreference

Fallback Stereo downmix preference. If not specified, device default value will be used as fallback

false

enum (e_Auto, e_NotIndicated, e_ProLogic, e_Stereo, e_ProLogicII)

fallbackSurroundAttenuation

Fallback 3 dB attenuation. If not specified, device default value will be used as fallback

false

boolean

followInputAudioCodingMode

false

boolean

heightTrim

heightTrim is E-AC3 metadata in the E-AC3 stream. This metadata supports -3db to -12db in 3db steps. Default: -3db.

false

enum (e_Auto, e_Neg_3, e_Neg_6, e_Neg_9, e_Neg_12)

lfeChannel

Specify whether to enable Lfe channel

false

boolean

lfeLowPassFilter

Lfe low pass filter. If not specified, it means auto

false

boolean

lineModeDrc

Line mode DRC. If not specified, it means auto

false

enum (e_Auto, e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

loRoCenterMixLevel

Lo/Ro Center mix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

loRoSurroundMixLevel

Lo/Ro surround mix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

ltRtCenterMixLevel

Lt/Rt Center mix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_30, e_MixLevel_15, e_MixLevel_00, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

ltRtSurroundMixLevel

Lt/Rt surround mix level. If not specified, it means auto

false

enum (e_Auto, e_MixLevel_M15, e_MixLevel_M30, e_MixLevel_M45, e_MixLevel_M60, e_MixLevel_MINF)

objectBasedAudio

Flag for deciding when channel mode is Passthrough, whether E-AC3 output should support 5.1.4 or not, i.e. whether to enable DDP-JOC encoder. Default: false

false

boolean

phaseShift

90-degree phase shift. If not specified, it means auto

false

boolean

rfModeDrc

RF mode DRC. If not specified, it means auto

false

enum (e_Auto, e_None, e_FilmStandard, e_FilmLight, e_MusicStandard, e_MusicLight, e_Speech)

stereoDownmixPreference

Stereo downmix preference. If not specified, it means auto

false

enum (e_Auto, e_NotIndicated, e_ProLogic, e_Stereo, e_ProLogicII)

surroundAttenuation

3 dB attenuation. If not specified, it means auto

false

boolean

surroundTrim

surroundTrim is E-AC3 metadata in the E-AC3 stream. This metadata supports 0db to -9db in 3db steps. Default: -3db

false

enum (e_Auto, e_Zero, e_Neg_3, e_Neg_6, e_Neg_9)

tSMultiplexingMode

TS Mux Standard

false

enum (e_ATSC, e_DVB)

com.harmonicinc.vos.labwizard.rest.model.DpiProcessingProperties

Name Description Required Schema Default

discontinuityAtSplicePt

Insert Dicsontinuity indicator in the video stream at splice point

false

boolean

dpiPidIndex

For this DPI component, only output SCTE35 messages related to SCTE104 messages with a matching DPI_PID_INDEX field. It is used to generate multi SCTE3( PIDs from one SCTE104 transport

false

integer (int32)

dpiProcessingMode

['e_PASS_THROUGH','e_REGENERATION' ,'e_ENCODING_ONLY' ] dpiProcessingMode='e_PASS_THROUGH' for transcode with SCTE35
dpiProcessingMode='e_ENCODING_ONLY' is necesary for SCTE104 (deprecated, use dpiProcessingOption instead)

false

enum (e_PASS_THROUGH, e_REGENERATION, e_ENCODING_ONLY)

dpiProcessingOption

['e_IB_PASSTHROUGH_ONLY', 'e_OOB_ESAM_ONLY', 'e_IB_ESAM_OOB_ESAM', 'e_IB_PASSTHROUGH_OOB_ESAM','e_DSMCC'] Determine the behavior of in-band (IB) and out-of-band (OOB) ESAM, or set to DSMCC stream

false

enum (e_IB_PASSTHROUGH_ONLY, e_OOB_ESAM_ONLY, e_IB_ESAM_OOB_ESAM, e_IB_PASSTHROUGH_OOB_ESAM, e_DSMCC)

dpiSource

['e_IP', 'e_ESAM', 'e_UMP_AS', ' e_VANC' , 'e_DTMF', 'e_ESAM_AND_UMP_AS'] dpiSource ='e_VANC' is necesary for SCTE104 over SDI (deprecated, use dpiProcessingOption instead)

false

enum (e_IP, e_ESAM, e_UMP_AS, e_VANC, e_DTMF, e_ESAM_AND_UMP_AS)

dpiStbMode

e_PROPRIETARY_MODE_1 enables proprietary tier and time-signal keep-alive handling, e_PROPRIETARY_MODE_2 enables pre-roll extended to 30 seconds for SCTE-104 commands

false

enum (e_STANDARD, e_PROPRIETARY_MODE_1, e_PROPRIETARY_MODE_2)

dpiTimeOffset

parameter in milliseconds to adjust Splice timing in the video stream. Default is 0ms.

false

integer (int32)

enableSpliceAutoReturn

generate automatic splice-in message for SCTE 104 splice insert command. Default is true.

false

boolean

enableSpliceInsertRepetition

Controls splice_insert() messages repetition every second during the 5s preroll period. Default is true.

false

boolean

enableSpliceNull

generates splice_null() SCTE35 messages in this DPI component

false

boolean

enableTimeDescriptor

Enable time_descriptor() optional extension to the splice_insert(), splice_null() and time_signal() commands that allows a programmer’s wall clock time to be sent to a client

false

boolean

ignoreSpliceCmdList

list of splice command types of SCTE35 messages to be filtered out for this DPI component

false

integer (int32) array

ignoreSpliceInsert

filter-out splice_insert SCTE35 messages for this DPI component

false

boolean

ignoreTimeSignal

filter-out time_signal SCTE35 messages for this DPI component

false

boolean

insertIDR

controls IDR insert for this DPI component. Default is true.

false

boolean

scte104PrerollMode

Minimum pre-roll required for this DPI component. Default is e_4_SEC. e_0_SEC/e_1_SEC allows support of low pre-roll component at the expense of longer video latency. Applicable use cases include baseband inputs (SCTE-104), TS inputs (SCTE-35 and SCTE-104 over ST-2038), and out-of-band inputs (SCTE-104, ESAM).

false

enum (e_4_SEC, e_1_SEC, e_0_SEC)

timeDescriptorOffset

paratemer required to adjust programmer’s wall clock time to be sent to a client with time_descriptor() optionnal mesages

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.DrmTrackFilterProfileProperties

Name Description Required Schema Default

drmTrackFilterProperties

List of drm track filter properties

true

com.harmonicinc.vos.labwizard.rest.model.DrmTrackFilterProperty array

name

DRM track filter name

true

string

com.harmonicinc.vos.labwizard.rest.model.DrmTrackFilterProperty

Name Description Required Schema Default

audioStreamSelections

audioStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem array

clearOutput

clearOutput

false

boolean

name

An optional description of the track type

true

string

trackType

trackType

true

string

videoStreamSelections

videoStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem array

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitleToDvbSubtitleConversionProperties

Name Description Required Schema Default

verticalOffset

Vertical offset (in pixels) applied to the DVB-Subtitles position, to the top of the screen. default: 0. range 0-1080. 0 means the DVB-Subtitles position is not modified. If the offset is too high, the DVB-Subtitles are displayed at the top of the screen.

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitlingDescriptor

Name Description Required Schema Default

dvbSubtitlingDescriptorData

Data of DVB Subtitling Descriptor

true

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitlingDescriptorData array

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitlingDescriptorData

Name Description Required Schema Default

ancillaryPageId

Ancillary PageId of DVB data stream

true

integer (int32)

compositionPageId

Composition PageId of DVB data stream

true

integer (int32)

language

Language code of data stream

true

string

subtitlingType

Subtitling Type of DVB data stream

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.EncapsulationSettings

Name Description Required Schema Default

enableFEC

Enable FEC

false

boolean

enablePipAudio

Enable PIP Audio

false

boolean

enablePipData

Enable PIP Data

false

boolean

encapsulationMode

Encapsulation Mode.

true

enum (e_UDP, e_RTP)

fecColumn

FEC Column

false

integer (int32)

fecMinimumTsBitrate

FEC required minimum TS bitrate

false

integer (int32)

fecRow

FEC Row

false

integer (int32)

incrementMode

Increment Mode.

false

enum (e_PORT, e_MULTICAST_ADDRESS)

incrementValue

The value that the port or multicast IP address increase by.

false

integer (int32)

isFecColumnOnly

Enable FEC column only mode

false

boolean

com.harmonicinc.vos.labwizard.rest.model.FileTranscodingProfileProperties

Name Description Required Schema Default

abrCommonSettings

Variable bitrate settings

false

com.harmonicinc.vos.labwizard.rest.model.FtAbrCommonSettings

category

Transcoding category - group of profile

true

string

outputs

Output a/v or variable bitrate profiles

true

com.harmonicinc.vos.labwizard.rest.model.FtOutput array

type

Transcoding Type - Output format

true

enum (3gp, advanced_dash, advanced_hls, advanced_mss, android, dnxhd, dnxhd_mxf, fl9, flv, fmp4_hls, hds, kindle_fire, m4v, mov, mp4, mpeg1, mpeg2, mpegts, mpeg_dash, muxer, mxf, ogg, prores, psp, roku_1200, roku_1800, roku_2700, roku_800, roku_hls, vp6_flix, webm, wmv, zune, eac3, m4a, mp3, wav, wma, wrapper)

com.harmonicinc.vos.labwizard.rest.model.FtAbrCommonSettings

Name Description Required Schema Default

cloudNorm

false

enum (no, yes)

encryption

Enable encryption

true

enum (no, yes)

encryption_iv

Encryption Initialization Vector
32 hexidecimal characters ([0-9a-f])

false

string

encryption_key

Encryption key
32 hexidecimal characters ([0-9a-f])

false

string

encryption_key_file

Encryption Key File URL
Valid URL

false

string

encryption_method

Encryption method: aes-128-cbc or sample-aes

false

enum (aes-128-cbc, sample-aes)

loud_norm

Audio loud normalization according to EBU standard R128. Does not apply to passthrough audio.

true

enum (no, yes)

segment_duration

Segment duration to split media (in seconds)
Non-negative integer

true

string

com.harmonicinc.vos.labwizard.rest.model.FtAudioStream

Name Description Required Schema Default

audio_bitrate

N - where N is any non-zero number of Kbps
3GP: 4.75k, 5.15k, 5.9k, 6.7k, 7.4k, 7.95k, 10.2k, 12.2k
FLV, WMV, MP3, WMA, ZUNE: 32k, 40k, 48k, 56k, 64k, 80k, 96k, 112k, 128k, 144k, 160k, 192k, 224k, 256k, 320k
OGG, WEBM: 45k,64k, 80k, 96k, 112k, 128k, 160k, 192k, 224k, 256k, 320k, 500k

true

string

audio_channels_number

Number of audio channels

true

string

audio_codec

MP3: LIBMP3LAME
M4A: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, EAC3
FLV: LIBMP3LAME, LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2
MP4: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, AC3, EAC3
FL9, M4V, IPOD, IPHONE, IPAD, PSP: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2
ROKU_*, KINDLE_FIRE: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, EAC3
MOV: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, EAC3, PCM_F32BE, PCM_F32LE
IPHONE_STREAM, IPAD_STREAM: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2
ROKU_HLS, HDS: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, EAC3
SMOOTH_STREAMING: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, EAC3
ADVANCED HLS STREAM: LIBFAAC, DOLBY_AAC, DOLBY_HEAAC, DOLBY_HEAACV2, AC3, EAC3, LIBMP3LAME(only for 'v3' segmenter)
LIVE HLS STREAM: LIBFAAC, AC3, LIBMP3LAME
WMV, WMA, ZUNE: WMAV2, LIBMP3LAME
WAV: PCM_S16LE, PCM_S24LE, PCM_S32LE
OGG, WEBM: LIBVORBIS
3GP: LIBAMR_NB
ANDROID: LIBAMR_NB, LIBFAAC
MPEG2: PCM_S16BE, PCM_S16LE, AC3
MPEG1: MP2, COPY
MPEGTS: AC3, EAC3
MPEG_DASH: LIBFAAC, EAC3
MOV_PRORES: PCM_S16LE, PCM_S24LE
MXF: PCM_S16LE, PCM_S24LE, COPY
DNXHD_MXF: PCM_S16LE, PCM_S24LE, COPY

true

enum (none, libmp3lame, libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, ac3, pcm_f32be, pcm_f32le, pcm_s24le, pcm_s16le, mp2, wmav2, copy)

audio_sample_rate

Audio sampling frequency (Hz)
All: any non-zero integer3gp: 8000
flv, mp3: 11025, 22050, 44100
ogg, webm: 16000, 32000, 44100, 22050, 11025, 192000
wmv, wma, zune: 11025, 22050, 32000, 44100, 48000
mpeg2: 44100, 48000

true

string

language

Audio language

true

string

layout

Audio channels layout

true

enum (mono, stereo, 2.1, 3.0, 3.0_back, 4.0, quad, quad_side, 3.1, 5.0, 5.0_side, 4.1, 5.1, 5.1_side, 6.0, 6.0_front, hexagonal, 6.1, 6.1_front, 7.0, 7.0_front, 7.1, 7.1_wide, 7.1_wide_side, octagonal, downmix)

use_stream_id

Source audio stream index

true

string

com.harmonicinc.vos.labwizard.rest.model.FtCommonSettings

Name Description Required Schema Default

closed_caption

no — no closed caption
timed-text — Closed Captions would be muxed in video as 3GPP Timed Text track
cea-608 — Closed Captions would be muxed in video as cea-608 track
cea-708 — 608 closed captions would be up-converted to 708 closed captions. And both, cea-608 and cea-708 closed captions, would be muxed in video stream

true

enum (no, timed-text, cea-608, cea-708)

cloudNorm

false

enum (no, yes)

loud_norm

Audio loud normalization according to EBU standard R128. Does not apply to passthrough audio.

true

enum (no, yes)

com.harmonicinc.vos.labwizard.rest.model.FtOutput

Name Description Required Schema Default

audioStreams

false

com.harmonicinc.vos.labwizard.rest.model.FtAudioStream array

commonSettings

false

com.harmonicinc.vos.labwizard.rest.model.FtCommonSettings

videoSettings

false

com.harmonicinc.vos.labwizard.rest.model.FtVideoSettings

com.harmonicinc.vos.labwizard.rest.model.FtVideoSettings

Name Description Required Schema Default

aspect_ratio

Any non-zero integer or N:M where N and M are non-zero integers
'source' - copy from source aspect ratio
'original' - keep original aspect ratio

true

string

bitrate

Video bit rate
All: N (where N is any non zero integer of Kbps)

true

string

cbr

Whether to use CBR (Constant bitrate)

true

enum (yes, no)

container

Wrapper container type

true

enum (, mxfop1a)

force_interlaced

Interlaced encoding type. Only works with MPEG-TS
mpegts: tff, bff, no
mxf: tff, bff, source, no
mov_prores: tff, bff, source, no

true

enum (tff, bff, source, no)

framerate

Any non-zero integer or N/M where N and M are non-zero integers
'copy' - take source’s framerate

true

string

hard_cbr

Specify HRD information and pack the bitstream to the specified bitrate

true

enum (yes, no)

horizontal_resolution

Video Horizontal Resolution
All: WxH, where W and N are any even integers.
3gp (h263): 128x96, 176x144, 352x288, 704x576, 1408x1152
zune: 320x180, 320x240
mxf: 720x480, 960x720, 1280x720, 1280x1080, 1440x1080, 1920x1080
Custom: To match your source aspect ratio, set X value to zero and Y value to your desired height. For example, 0x360 or 0x480.

true

string

idr_period

IDR period: N (where N is integer >=1 and ⇐ 15)

true

string

profile

The standard defines various sets of capabilities, which are referred to as profiles, targeting specific classes of applications
high, main, baseline
mov_prores: hq, std, lt, proxy

true

enum (high, main, baseline, hq, std, lt, proxy)

two_pass

2-pass encoding toggle

true

enum (no, yes)

two_pass_decoding

Decode to a lossless format prior to encoding to reduce errors

true

enum (none, 1)

vertical_resolution

Video Vertical Resolution
All: WxH, where W and N are any even integers.
3gp (h263): 128x96, 176x144, 352x288, 704x576, 1408x1152
zune: 320x180, 320x240
mxf: 720x480, 960x720, 1280x720, 1280x1080, 1440x1080, 1920x1080
Custom: To match your source aspect ratio, set X value to zero and Y value to your desired height. For example, 0x360 or 0x480.

true

string

video_codec

flv: flv, libx264, copy
fl9: libx264, copy
wmv, zune: wmv2, msmpeg4, copy
3gp, android: h263, mpeg4, libx264, copy
m4v: mpeg4, copy
ipod, iphone, ipad, psp: mpeg4, libx264, copy
fmp4_hls: libx264, hevc
advanced_hls: libx264
advanced_mss: libx264, libvpx-vp9
advanced_dash: libx264, libvpx-vp9, hevc
mpeg_dash: mpeg4, libx264, hevc
mp4: mpeg4, libx264, hevc, copy
ogg: libtheora, copy
webm: libvpx, libvpx-vp9, copy
mp3, wma: none
mpeg2: mpeg2video, copy
mpeg1: mpeg1video, copy
mov: mpeg4, libx264, xdcam, dvcpro, dvcpro50, dvcprohd, mjpeg, copy
mpegts: libx264, mpeg2video
mxf: dvcpro, dvcpro50, dvcprohd, xdcamhd422, imx30, copy
kindle_fire: mpeg4, libx264, hevc, copy
dnxhd, dnxhd_mxf: dnxhd, copy
mov_prores: prores, copy
Note: With 'copy' video codec video will be repacked to the new format without transcoding. All video settings would be ignored

true

enum (none, flv, libx264, wmv2, msmpeg4, h263, mpeg4, libvpx-vp9, hevc, libtheora, libvpx, mpeg1video, mpeg2video, xdcam, dvcpro, dvcpro50, dvcprohd, mjpeg, xdcamhd422, imx30, dnxhd, prores, copy)

com.harmonicinc.vos.labwizard.rest.model.HALCAudioLevelAdjustementProperties

Name Description Required Schema Default

alcGain

Volume gain (in dB) before ALC

false

integer (int32)

alcMode

ALC mode

false

enum (e_ATSC_A85, e_EBU_R128, e_A_WEIGHTING)

alcPreset

ALC preset

false

enum (e_SOFT, e_MEDIUM, e_HARD)

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties

Name Description Required Schema Default

audioStreamSelections

audioStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$AudioStreamSelectionItem array

videoStreamSelections

videoStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$VideoStreamSelectionItem array

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$AudioStreamSelectionItem

Name Description Required Schema Default

audioCodecSelection

audioCodecSelection

false

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, MPEGH, ALL)

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem$AudiobitrateRange

groupId

groupId

false

string

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$VideoStreamSelectionItem

Name Description Required Schema Default

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$VideoStreamSelectionItem$BitrateRange

groupId

groupId

false

string

videoCodecSelection

videoCodecSelection

false

enum (H_265, H_264, ALL)

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties$VideoStreamSelectionItem$BitrateRange

Name Description Required Schema Default

esBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$EsBitrateRange

com.harmonicinc.vos.labwizard.rest.model.HlsPackagingProperties

Name Description Required Schema Default

absoluteIFrameOnlyPlaylistFileName

Absolute I-frame only playlist filename pattern, which is supported as listed below.

Supported escape pattern:
%streamid Stream ID
%streamid:streamIdFormat=%0{number}llu Stream ID in some format, for example %01llu. %02llu is the default.

Sample configuration: %streamid-iframe
Resultant file name: 01-iframe.m3u8
Sample configuration: %streamid:streamIdFormat=%01llu-iframe
Resultant file name: 1-iframe.m3u8

false

string

absoluteMediaPlaylistFileName

Absolute media playlist filename. Value is a suffix to relative media playlist filename if absoluteMediaPlaylistFileNameAsSuffix is true. Otherwise, the value is the absolute media playlist filename pattern, which is supported as listed below.

Supported escape pattern:
%streamid Stream ID
%streamid:streamIdFormat=%0{number}llu Stream ID in some format, for example %01llu. %02llu is the default.

Sample configuration: %streamid
Resultant file name: 01.m3u8
Sample configuration: %streamid:streamIdFormat=%01llu
Resultant file name: 1.m3u8

false

string

absoluteMediaPlaylistFileNameAsSuffix

Indicate whether absolute media playlist filename is specified as suffix or pattern

false

boolean

absoluteVariantPlaylistFileName

Absolute master playlist filename

false

string

altWatermarkOutputPrefix

Alternative watermark output prefix, all the playlists and segments will be appended with this prefix.

false

string

attributeCustomizationProfileId

Specify the Variant Customization Profile to tune the HLS playlist attributes.

false

string

bandwidthBasedOnEsBitrate

To base the BANDWIDTH attribute on ES bitrate instead of TS bitrate in variant playlist

false

boolean

chunkDurationInMillisecond

The duration of the CMAF chunk in milliseconds

false

integer (int32)

closedCaptionHandling

The way to handle Closed Caption. Can be passthrough and/or converted to WebVTT, and/or converted to IMSC1. Empty list implies to ignore closed caption

false

enum (e_TO_WEBVTT, e_PASSTHROUGH, e_TO_IMSC1) array

commonEncryptionScheme

Common encryption scheme

false

enum (CENC_CBCS, CENC_CENC)

contentSteeringPlaylistFileName

Content steering master playlist filename

false

string

customGroupingProfileId

Specify the HLS Audio Grouping Profile to customize the HLS playlist audio and video grouping.

false

string

decodeTimeShiftToPlayTime

Enable to shift decoding timeline to match the presentation timeline, resulting in same first DTS and PTS for each segment, as well as potential negative CTO in segment. Take effect only on fMP4 package output

false

boolean

disableRawLines

Disable usage of Raw lines PSM and split lines algo for OCR

false

boolean

displayHResolutionRounding

The function that will be used to round the display horizontal resolution.

false

enum (e_TO_FLOOR, e_TO_CLOSEST_EVEN)

displayHdcpLevelAttribute

Specify whether to show HDCP-LEVEL attribute for each stream on HLS master playlist.

false

boolean

dropSgpdBox

Drop sgpd and sbgp box in fMP4

false

boolean

dvbSubtitleHandling

The way to handle DVB subtitle. Can be passthrough and/or converted to SMPTE-TT (in ID3), and/or converted to Webvtt thanks to OCR. Empty list implies to ignore DVB subtitle

false

enum (e_TO_SMPTE_TT, e_PASSTHROUGH, e_TO_WEBVTT_OCR, e_TO_IMSC1) array

dvbTtmlHandling

The way to handle DVB TTML. Can be converted to WebVTT. Empty list implies to ignore DVB TTML

false

enum (e_TO_WEBVTT, e_TO_IMSC1) array

dvrWindowSize

Control the availability of media segment files most recently added to the index file (in seconds).

true

integer (int32)

enableAbsoluteSegmentURL

Enable absolute URL in media playlist to reference stream playlist

false

boolean

enableAbsoluteURL

Enable absolute URL in master playlist to reference stream playlist

false

boolean

enableAverageBandwidthAttribute

Enable AVERAGE-BANDWIDTH attribute in variant playlist

false

boolean

enableCcDeclaration

Declare CC in playlist

false

boolean

enableChunkedCMAF

Enable chunked CMAF to support low latency OTT delivery

false

boolean

enableCodecsAttributeInVariantPlaylist

Whether to specify CODECS attribute in EXT-X-STREAM-INF in variant playlist

true

boolean

enableCommonSegmentUrlDelivery

Enable common segment URL delivery.

false

boolean

enableContentSteeringPlaylist

Enable the content steering master playlist to check cluster status and steer the content to the available cluster.

false

boolean

enableCountryCode

Use ISO Country Code in language identification

false

boolean

enableDiscreteIframeSegmentEncryption

Enable discrete I-frame segment encryption

false

boolean

enableExtXGapTag

Enable the insertion of a GAP tag in the playlist during periods of content loss. This helps indicate missing content segments in the HLS stream.

false

boolean

enableKeyRotation

Enable key rotation.

true

boolean

enableLegacySpliceInsertHandle

Enable handle splice insert with no segmentation descriptor in STANDARD mode. Default is false

false

boolean

enableLowLatencyMode

Obsolete

false

boolean

enableOttWatermark

(Deprecated) Enable OTT watermarking. When this parameter is true, two set of AB outputs will be generated with only filename difference.

false

boolean

enablePackageBasedKeyRotation

Override the DRM global setting and enable customized per Package output key rotation setting

true

boolean

enablePartialSegment

Obsolete

false

boolean

enablePlaylistTypeEventTag

Enable inserion of "EXT-X-PLAYLIST-TYPE:EVENT" tag in Start-over mode

false

boolean

enableSubFolderMode

Use sub-folder mode for HLS in WebDav Mode

false

boolean

enableWebVttSourcePositioning

Enable source positioning for WebVTT

false

boolean

enableWebVttStyling

Enable styling for WebVTT

false

boolean

encryptSEI

Enable SEI encryption for HLS fmp4 package output, if value is false, encryption of SEI entry will be skipped

false

boolean

fakeSegmentationType

Which segmentation type to use for fake segmentation when enableLegacySpliceInsertHandle is true. Default is 54 (0x36 Distributor Placement Opportunity Start)

false

integer (int32)

firstSegmentProgramDateTime

When this parameter is true, only the first segment has EXT-X-PROGRAM-DATE-TIME tag. Otherwise, program data time tags are set for every segment.

false

boolean

floatingPointDurationInPlaylist

The EXTINF tag value will be presented in floating point.

true

boolean

generateAudioOnlyStream

Generate audio-only stream

true

boolean

generateIFrameOnlyPlaylist

Enable generating I-frame only playlist.

true

boolean

hlsEncryptionMethod

Specify which encryption method should be used when integrate with DRM.

true

enum (e_HLS_SAMPLE_AES, e_AUTHENTEC_PLAYREADY, e_COMMON_ENCRYPTION, e_DISCRETIX_PLAYREADY, e_IRDETO_PLAYREADY, e_HLS_AES, e_FAIRPLAY, e_SECURE_MEDIA, e_CLEAR)

hlsScte35GenericProperties

SCTE-35 Generic Properties

false

com.harmonicinc.vos.labwizard.rest.model.HlsScte35GenericProperties

iframeCodec

The codec used for I-frame only segment

false

enum (e_VIDEO, e_MJPG, e_BOTH)

iframeDiscreteSegmentInterval

The interval to generate discrete I-frame based on the IDR for VOD I-frame only playlist

false

enum (e_PER_SEGMENT, e_PER_IDR)

iframeEnableInitSection

Enable to add EXT-X-MAP in I-frame only playlist. Value only takes effect for package in TS

false

boolean

iframeMjpegSegmentInterval

The interval to generate thumbnails based on the IDR for I-frame only playlist for MJPEG codecs.

false

enum (e_PER_SEGMENT, e_PER_IDR)

iframeSegmentHandling

The method to record the IDR for I-frame only playlist.

false

enum (e_BYTE_RANGE, e_IDR_SEGMENT)

indexFileNameForIFrameOnlyStreamForFlattenedMode

An index file is an ordered list of media URLs and informational tags. Each media URL refers to a media file which is a segment of a I-Frame Only stream. This setting specifies the file name of the index file for each variant stream excluding file extension (i.e. .m3u8).

Supported escape pattern:
%streamid Stream ID

Sample configuration: %streamid
Resultant file name: 01.m3u8

true

string

indexFileNameForMediaStreamForFlattenedMode

An index file is an ordered list of media URLs and informational tags. Each media URL refers to a media file which is a segment of a single contiguous stream. This setting specifies the file name of the index file for each variant stream excluding file extension (i.e. .m3u8).

Supported escape pattern:
%streamid Stream ID
%streamid:streamIdFormat=%0{number}llu Stream ID in some format, for example %01llu. %02llu is the default.

Sample configuration: %streamid
Resultant file name: 01.m3u8
Sample configuration: %streamid:streamIdFormat=%01llu
Resultant file name: 1.m3u8

true

string

indexPlaylistCustomization

Index Playlist customization settings

false

com.harmonicinc.vos.labwizard.rest.model.hlsCustomization.IndexPlaylistCustomization

insertAudioChannels

Specify whether the CHANNEL value must be inserted in master playlist for each audio track.

false

boolean

insertCustomStreamName

Insert custom name to NAME attribute of EXT-X-MEDIA tag in HLS manifest.

false

boolean

insertPlaylistCustomTag

Insert custom tag in Master playlist header

false

boolean

isoLanguageCode

Define ISO language code to use for audio and subtitles.

false

enum (e_ISO_639_1, e_ISO_639_2_3)

keepOverlayPlcmtOppInClear

Keep Overlay Placement Opportunity in Clear

false

boolean

keyChangePeriod

The key change period for key rotation (expressed in seconds).

true

integer (int32)

lateBindingAudio

Enable late binding audio at manifest. If set to Both, two variant playlists will be generated.

true

enum (e_ENABLE_LATE_BINDING_AUDIO, e_DISABLE_LATE_BINDING_AUDIO, e_BOTH)

masterPlaylistCustomization

Master Playlist customization settings

false

com.harmonicinc.vos.labwizard.rest.model.hlsCustomization.MasterPlaylistCustomization

nameAttribute

Name attribute

false

enum (DEFAULT, IN_ENGLISH, IN_NATIVE)

noExtXKeyTagForUnencryptedStreams

No EXT-X-KEY tag for unencrypted streams

false

boolean

packagingEncryptionProfileId

Enable packaging encryption

false

string

partHoldBackInMs

Set the part hold back duration in low-latency HLS playlist (in milliseconds). -1 means 3 x part target duration

false

integer (int32)

partTargetDurationInMs

Set the part target duration in low-latency HLS playlist (in milliseconds). 0 means auto

false

integer (int32)

passThroughParameterSets

Pass-through Parameter Sets. When this parameter is true, the video parameter sets store in the sample entry and the samples, and the sample entry name is 'hev1' for HEVC or 'avc3' for AVC. Otherwise, the video parameter sets store only in the sample entry, and the sample entry name is 'hvc1' for HEVC or 'avc1' for AVC.

false

boolean

playlistCustomTag

Insert custom string tag in HLS manifest.

false

string

richSegmentUriInfo

Rich Segment URI Info option provides an alternative playlist generation method which is easier for publishing destinations to parse the playlists.

true

boolean

scte27SubtitleHandling

The way to handle SCTE-27 subtitles. Can be converted to SMPTE-TT. Empty list implies to ignore SCTE-27 subtitle.

false

enum (e_TO_SMPTE_TT, e_TO_WEBVTT_OCR) array

scte35AnnotationTag

Control the tag for annotating SCTE35 message on HLS playlist

false

enum (e_SCTE35, e_DATERANGE, e_ALL_ANNOTATION)

scte35CIDPassthrough

Enable SCTE35 ContentID Handling. When this parameter is true, the Content ID signal will be pass-through by inserting a event message with base64 string on the manifest.

false

boolean

scte35DaterangeTagsInMs

Use milliseconds for SCTE-35 EXT-X-DATERANGE tag

false

boolean

scte35DefaultAutoReturnDuration

SCTE-35 Default Auto-return Duration, for signaling mode e_STANDARD, e_GOOGLE_DOUBLE_CLICK, e_UK_1, e_NBC and e_HULU only.

false

integer (int32)

scte35GoogleHlsVodAnnotationType

The way of handling Google Double Click VOD SCTE35 messages. 'NONE' means ignoring the messages; 'e_placementOpportunity' means when a SCTE-35 message provider placement opportunity start with duration=0 is received, the PTS in this message will be used to start a new segment and the #EXT-X-PLACEMENT-OPPORTUNITY tag, will be inserted in the manifest for this segment.

false

enum (e_NONE, e_PLACEMENT_OPPORTUNITY)

scte35RetainProgramChapterStart

Retain program/chapter start SCTE-35 messages in NBC mode

false

boolean

scte35Signaling

The way of handling SCTE35 messages. 'NONE' means ignoring the messages; 'BASE64' means writing the SCTE35 data to playlist in base64 format.; 'STANDARD' means writing the SCTE35 data to playlist in SCTE35 Standard format; 'GOOGLE DOUBLE CLICK' means writing the SCTE35 data to playlist in Google Double Click format; 'UK 1' means writing the SCTE35 data to playlist in UK 1 format; 'NBC' means writing the SCTE35 data to playlist in NBC annotation; 'HULU' means writing the SCTE35 data to playlist in Hulu annotation; Default is 'NONE'

false

enum (e_NONE, e_BASE64, e_STANDARD, e_GOOGLE_DOUBLE_CLICK, e_UK_1, e_NBC, e_HULU, e_SAMSUNG_TV_PLUS, e_GENERIC)

segmentFileNamePrefixForFlattenedMode

The file name prefix of the media segment files.

Supported escape pattern:
%starttime Publishing session start time
%sequence Media segment sequence number
%streamid Stream ID
%time - Segment start time

Sample configuration: %starttime-%streamid-%sequence
Resultant file name: 20120108T035411-01-13949.ts

true

string

segmentLength

(Deprecated) The duration of the media segment files (in seconds).

false

integer (int32)

segmentLengthInMillisecond

The duration of the media segment files (in milliseconds).

true

integer (int32)

segmentRetentionPeriod

The duration that the media segment files actually retain in the publishing server (in minutes).

true

integer (int32)

skipDuplicateExtXKeyTag

Skip duplicate EXT-X-KEY tags

false

boolean

specifyStartingLivePoint

Specify starting live point

false

boolean

startingLivePoint

Starting live point in seconds. A positive number indicates a time offset from the beginning of the Playlist. A negative number indicates a negative time offset from the end of the last Media Segment in the Playlist.

false

integer (int32)

subtitleNamePattern

The subtitle name pattern.

Supported escape pattern:
%LANG Subtitle language code in uppercase
%lang Subtitle language code in uppercase
%index Subtitle track index

Sample configuration: Sub%lang or Sub%LANG or Sub%index or Sub%LANG%index (for language: ita)
Resultant subtitle name: Subita or SubITA or Sub1 or SubITA1

true

string

targetDuration

Set the target duration in playlist (in seconds). 0 means follow segment duration

false

integer (int32)

teletextHandling

(Deprecated) The way to handle teletext. Can be converted to WebVTT or passthrough

false

enum (e_NONE, e_TO_WEBVTT, e_PASSTHROUGH, e_TO_IMSC1)

teletextHandlingList

The way to handle teletext. Can be passthrough and/or converted to WebVTT, and/or converted to IMSC1

false

enum (e_NONE, e_TO_WEBVTT, e_PASSTHROUGH, e_TO_IMSC1) array

ttmlTemplate

The TTML template. String in XML that allows to control how output TTML looks like

false

string

urlOrderOfVariantPlaylist

Specify how the playlist URLs are arranged in the variant playlist.

true

enum (e_BITRATE_ASCENDING, e_BITRATE_DESCENDING)

useCmaf

Package in fMP4

false

boolean

variantPlaylistFileName

The variant playlist lists the URLs of each variant stream to allow clients to switch between encodings dynamically. This setting specifies the file name of the variant playlist excluding file extension (i.e. .m3u8). For example, if this value is set to 'master' (excluding ''), the actual file name will be 'master.m3u8'.

true

string

com.harmonicinc.vos.labwizard.rest.model.HlsScte35GenericProperties

Name Description Required Schema Default

scte35AnnotationTag

Control the tag for annotating SCTE35 message on HLS playlist

false

enum (e_SCTE35, e_DATERANGE) array

com.harmonicinc.vos.labwizard.rest.model.IPTVDestinationProfileProperties

Name Description Required Schema Default

ebpAudioFragmentSize

false

integer (int32)

ebpExplicitAudio

EBP Explicit Audio

false

boolean

ebpInterval

EBP Interval

false

integer (int32)

ebpOffsetInMs

Offset of EBP timestamp

false

integer (int32)

ebpOnIFrame

EBP on I Frame

false

boolean

ebpSegmentSize

EBP Segment Size

false

integer (int32)

ebpTimelineEnum

EBP Timeline

false

enum (e_ETT_LOCAL_TIMELINE, e_ETT_INCOMING_TIMELINE)

encapsulationSettings

Encapsulation Settings.

true

com.harmonicinc.vos.labwizard.rest.model.EncapsulationSettings

muteOutputOnSignalLoss

Mute TS output when input signal loss

false

boolean

outputMode

Output mode for the IPTV service.

false

enum (e_CBR, e_STATMUX)

pip

Picture in picture mode.

true

enum (e_SPTS, e_MPTS)

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties

Name Description Required Schema Default

audioMatchingMode

The audio matching mode indicates how the audio encoding profile is specified. User can specify audio encoding profile per each language type, or specify the audio encoding profile based on the label associated with the input audio

false

enum (e_MATCH_BY_LANGUAGE, e_MATCH_BY_LABEL)

audios

List of IPTV audio processing setting

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Audio array

bandwidth

Maximum bitrate of output stream in Mbps

true

integer (int32)

breakoutCode

The breakout code indicates the preferred Nielsen crediting model, which is based on the type of content and Ad-load model

false

enum (e_NONE, e_LIVE_CONTENT_WITH_SAME_TV_ADS, e_LIVE_CONTENT_WITHOUT_SAME_TV_ADS)

customDescriptors

Custom Descriptors of the program. Applicable for ATSC

false

com.harmonicinc.vos.labwizard.rest.model.CustomDescriptor array

data

List of IPTV data processing setting

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Data array

dataFilteringMode

Data filtering mode

false

enum (e_INCLUDE_ALL_DATA, e_FILTER_BY_SRC_LABEL)

dvbProgramNameCodingTable

Program name coding table bytes of the DVB SDT. Applicable when sdtGenerationMode is e_GENERATE. Support range defined in Annex A of ETSI EN 300 468 V1.16.1 (e.g. 0x14 for Traditional Chinese). If not defined, the default coding table as defined in the annex would be used.

false

string

dvbProviderName

Provider name of the DVB SDT. Applicable when sdtGenerationMode is e_GENERATE

false

string

dvbProviderNameCodingTable

Provider name coding table bytes of the DVB SDT. Applicable when sdtGenerationMode is e_GENERATE. Support range defined in Annex A of ETSI EN 300 468 V1.16.1 (e.g. 0x14 for Traditional Chinese). If not defined, the default coding table as defined in the annex would be used.

false

string

editingStatus

The editing status indicate which properties group is in manual mode, user cannot configure properties on the left parametric section in the profile editor

false

integer (int32)

extraVideoDelay

Extra video delay in milliseconds. Default is 0.

false

integer (int32)

outputPcrPid

Output PID of the PCR

false

integer (int32)

outputPipPcrPid

PIP output PID of the PCR

false

integer (int32)

outputPipPmtPid

PIP output PID of the PMT. Default value is equal to -1

false

integer (int32)

outputPmtPid

Output PMT PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 32 if not defined in source grooming (non-TS source for example). If -2 is set, the value is initialized at service start with input PMT PID, or 32 for non-TS source (-2 is available for backward compatibility and is not recommended). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

receiverTimezone

IATA timezone for receiver

false

string

scheduling

Scheduling setting

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Scheduling

sdtGenerationMode

SDT generation mode: e_FOLLOW_INPUT to transmit the ingress SDT, e_GENERATE to set the DVB service name to the VOS service name, set the NetworkId to 0 and transmit that SDT or e_DISABLE to disable the SDT output

false

enum (e_FOLLOW_INPUT, e_GENERATE, e_DISABLE)

setTopBoxProfileId

Specify the id of the set top box profile

true

string

stereoDownmixMode

Downmix mode for stereo

false

enum (e_Auto, e_LtRt, e_LoRo)

streamBasedAudios

List of IPTV Stream based audio processing setting

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$StreamBasedAudio array

upsignal

Enable AC-3 upsignaling (supports AC-3 5.1 audio output only)

false

boolean

video

IPTV video processing setting

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Video

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Audio

Name Description Required Schema Default

audioTrackIndex

(Deprecrated) Audio track index used to map the audio track in input audio grooming

false

integer (int32)

bitrate

(Deprecrated) Audio bitrate in bps

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

(Deprecrated) Audio channel setting for converting

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

codec

(Deprecrated) Audio codec used for converting

false

enum (e_AC_4, e_E_AC_3, e_AC_3, e_HE_AAC_v2, e_HE_AAC_v1, e_AAC_LC, e_MPEG1_L2, e_PCM)

dialnorm

(Deprecrated) Audio dialogue normalization (average loudness) in dB, applied for AC-4, AC-3, E-AC3 codec

false

integer (int32)

gain

(Deprecrated) Audio gain in dB when LevelMagic leveling is disabled, Dialnorm will be set as default value

false

integer (int32)

labels

(Deprecrated) Labels identifier of audio

false

string array

language

Used for mapping audio source with processing profile

false

string

languageIndex

Audio index used to mapping the languages defined in Configure app’s setting, support up to 16 audio tracks, range 1~16

false

integer (int32)

leveling

(Deprecrated) Enable audio LevelMagic leveling

false

boolean

loudnessTarget

(Deprecrated) Loudness setting in LKFS when LevelMagic leveling is enabled, Dialnorm will be overridden

false

integer (int32)

outputBasePid

(Deprecrated) Output base PID of the audio

false

integer (int32)

processing

(Deprecrated) Convert or pass-through audio

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

profiles

List of audio processing setting.

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$AudioProfile array

sampleRate

(Deprecrated) Audio sampling rate in Hz

false

enum (e_16, e_32, e_44, e_48)

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$AudioProfile

Name Description Required Schema Default

aacProfileProperties

AAC profile properties - AAC meta data

false

com.harmonicinc.vos.labwizard.rest.model.AACProfileProperties

aribAudioModeChange

Arib Audio Mode Change Properties

false

com.harmonicinc.vos.labwizard.rest.model.AribAudioModeChange

audioAUPerPES

Number of audio AU per PES

false

enum (e_Auto, e_1AU_per_PES, e_5AU_per_PES, e_6AU_per_PES)

audioLevelAdjustmentProperties

General Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.AudioLevelAdjustmentProperties

audioUpmixerConfig

Configuration for audio upmixer

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixerConfig

bitrate

Audio bitrate in bps

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

bitrateSecondary

Bitrate used with a 5.1 PCM input when it switches to stereo. Ignored if channels is not e_PASSTHROUGH. Ignored if the input is not defined as 5.1 PCM.

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

Audio channel setting for converting

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

codec

Audio codec used for converting

false

enum (e_AC_4, e_E_AC_3, e_AC_3, e_HE_AAC_v2, e_HE_AAC_v1, e_AAC_LC, e_MPEG1_L2, e_PCM)

dialnorm

(Deprecrated) Audio dialogue normalization (average loudness) in dB, applied for AC-4, AC-3, E-AC3 codec

false

integer (int32)

dolbyAC4AdvanceProperties

Dolby AC4 Advanced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyAC4AdvanceProperties

dolbyPlusAdvanceProperties

Dolby Plus Adavnced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyPlusAdvanceProperties

gain

Audio gain in dB when LevelMagic leveling is disabled, Dialnorm will be set as default value

false

integer (int32)

halcAudioLevelAdjustementProperties

HALC Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.HALCAudioLevelAdjustementProperties

kantarSnapWatermarkEnabled

Enable Kantar Snap watermarking for this channel

false

boolean

labels

Labels identifier of audio

false

string array

leveling

Enable audio LevelMagic leveling

false

boolean

loudnessTarget

Loudness setting in LKFS when LevelMagic leveling is enabled, Dialnorm will be overridden

false

integer (int32)

mpeg1L2ProfileProperties

Mpeg1 Layer2 Profile Properties

false

com.harmonicinc.vos.labwizard.rest.model.Mpeg1L2ProfileProperties

nielsenWatermarkProperties

Nielsen Watermarking Configurations

false

com.harmonicinc.vos.labwizard.rest.model.NielsenWatermarkProperties

outputBasePid

(Deprecrated) Output base PID of the audio

false

integer (int32)

processing

Convert or pass-through audio

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

sampleRate

Audio sampling rate in Hz

false

enum (e_16, e_32, e_44, e_48)

sourceChannel

Audio M1L2 source channel used for converting

false

enum (e_LEFT, e_RIGHT)

sourceDolbyEProgramNumber

(Deprecrated) Source DolbyE program number for the audio

false

integer (int32)

streamDescriptors

Stream descriptor of audio

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$CbrDuringAdProperties

Name Description Required Schema Default

bitrate

Bitrate for AD in kbps

false

integer (int32)

extendedCbrTime

CBR time extension in seconds

false

integer (int32)

maxCbrTime

Maximum CBR time during AD in seconds

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Data

Name Description Required Schema Default

ccToDvbSubtitleConversionProperties

properties related to CC to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.CcToDvbSubtitleConversionProperties

dataMaxBitrate

false

integer (int32)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

dpiProcessingProperties

properties for SCTE35 processing options

false

com.harmonicinc.vos.labwizard.rest.model.DpiProcessingProperties

dvbSubtitleToDvbSubtitleConversionProperties

properties related to DVB subtitle to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitleToDvbSubtitleConversionProperties

enableDvbSubtitleBurnIn

Enable DVB Subtitle BurnIn

false

boolean

generateSmpte2038

Generate Smpte2038 from VANC input

false

boolean

maxBitRate

Max Bitrate of the data

false

integer (int32)

outputBasePid

(Deprecrated) Output base PID of the data

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 582 (or higher) if not defined in source grooming (non-TS source for example). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

outputPipPid

PIP Output PID of the data

false

integer (int32)

scte27ToDvbSubtitleConversionProperties

properties related to SCTE27 to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.Scte27ToDvbSubtitleConversionProperties

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

sourceLabels

List of label of the source stream to be processed

false

string array

streamDescriptors

Stream descriptor of data

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

teletextToDvbSubtitleConversionProperties

properties related to teletext to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.TeletextToDvbSubtitleConversionProperties

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Scheduling

Name Description Required Schema Default

blackoutScheduling

Enable blackout scheduling

false

boolean

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$StreamBasedAudio

Name Description Required Schema Default

aacProfileProperties

AAC profile properties - AAC meta data

false

com.harmonicinc.vos.labwizard.rest.model.AACProfileProperties

aribAudioModeChange

Arib Audio Mode Change Properties

false

com.harmonicinc.vos.labwizard.rest.model.AribAudioModeChange

audioAUPerPES

Number of audio AU per PES

false

enum (e_Auto, e_1AU_per_PES, e_5AU_per_PES, e_6AU_per_PES)

audioLevelAdjustmentProperties

General Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.AudioLevelAdjustmentProperties

audioMixingProperties

Settings for audio mixing

false

com.harmonicinc.vos.labwizard.rest.model.AudioMixingProperties

audioUpmixerConfig

Configuration for audio upmixer

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixerConfig

audioUpmixingProperties

Settings for audio upmixing

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixingProperties

bitrate

Audio bitrate in bps

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

bitrateSecondary

Bitrate used with a 5.1 PCM input when it switches to stereo. Ignored if channels is not e_PASSTHROUGH. Ignored if the input is not defined as 5.1 PCM.

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

Audio channel setting for converting

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

codec

Audio codec used for converting

false

enum (e_AC_4, e_E_AC_3, e_AC_3, e_HE_AAC_v2, e_HE_AAC_v1, e_AAC_LC, e_MPEG1_L2, e_PCM)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

dialnorm

(Deprecrated) Audio dialogue normalization (average loudness) in dB, applied for AC-4, AC-3, E-AC3 codec

false

integer (int32)

dolbyAC4AdvanceProperties

Dolby AC4 Advanced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyAC4AdvanceProperties

dolbyPlusAdvanceProperties

Dolby Plus Adavnced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyPlusAdvanceProperties

fallbackOnSilenceDetection

Fallback on silence detection

false

boolean

gain

Audio gain in dB when LevelMagic leveling is disabled, Dialnorm will be set as default value

false

integer (int32)

halcAudioLevelAdjustementProperties

HALC Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.HALCAudioLevelAdjustementProperties

kantarSnapWatermarkEnabled

Enable Kantar Snap watermarking for this channel

false

boolean

labels

Labels identifier of audio

false

string array

leveling

Enable audio LevelMagic leveling

false

boolean

loudnessTarget

Loudness setting in LKFS when LevelMagic leveling is enabled, Dialnorm will be overridden

false

integer (int32)

mpeg1L2ProfileProperties

Mpeg1 Layer2 Profile Properties

false

com.harmonicinc.vos.labwizard.rest.model.Mpeg1L2ProfileProperties

nielsenWatermarkProperties

Nielsen Watermarking Configurations

false

com.harmonicinc.vos.labwizard.rest.model.NielsenWatermarkProperties

outputBasePid

(Deprecrated) Output base PID of the audio

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If 0 is set, source grooming value (as set during discover process) will be used, or 482 (or higher) if not defined in source grooming (non-TS source for example). If -1 is set, the PID is not present in the output. Any other value is not recommended and will behave as 0 in current version.

false

integer (int32)

outputPipPid

PIP Output PID of the audio

false

integer (int32)

processing

Convert or pass-through audio

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

sampleRate

Audio sampling rate in Hz

false

enum (e_16, e_32, e_44, e_48)

secondSourceLabels

List of label of the second source stream to be processed

false

string array

sourceAudioProcessingMode

Audio Stream Processing Mode

false

enum (e_SWITCH, e_MIX, e_UPMIX)

sourceChannel

Audio M1L2 source channel used for converting

false

enum (e_LEFT, e_RIGHT)

sourceDolbyEProgramNumber

(Deprecrated) Source DolbyE program number for the audio

false

integer (int32)

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

sourceLabels

List of label of the source stream to be processed

false

string array

streamDescriptors

Stream descriptor of audio

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

thirdSourceLabels

List of label of the third source stream to be processed

false

string array

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$Video

Name Description Required Schema Default

aribAspectRatioConversionMode

This feature implements proprietary handling of 1080i to 480i scaling.
When aribAspectRatioConversionMode is set to e_ANAMORPHIC, video mode change follows the ARIB B.32 spec.
When aribAspectRatioConversionMode is set to e_PRESERVER_ASPECT_RATIO, VAR is always set to 4x3, regardless of input.
When input VRAR is 0(4x3), a center-cut operation is performed; when VRAR is 1 (16x9), a letterbox transformation is performed.
When aribAspectRatioConversionMode is set to e_FORCE_PROPRIETARY_LETTERBOX_MODE, output VAR and DRAR are set to 4x3,
regardless of input, and a letterbox transformation is performed.

false

enum (e_ANAMORPHIC, e_PRESERVE_ASPECT_RATIO, e_FORCE_PROPRIETARY_LETTERBOX_MODE)

aspectRatio

Aspect ratio of video

false

enum (e_16_9, e_4_3, e_PASSTHROUGH)

bitrate

Bitrate of video in bps

false

integer (int32)

bitrateMaximumAvailable

Maximum available means device need to automatically calculate the video bitrate by subtracting all the configured or passthrough audio/data streams bitrates from configured Max bitrate. When any audio/data stream becomes unavailable, device need to adjust the video bitrate by adding the unused bandwidth which was allocated by the audio/data stream.

false

boolean

cbrDuringAdProperties

Bitrate Properties during AD time

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties$CbrDuringAdProperties

closedCaption

Closed captions passthrough setting

false

enum (e_AUTO, e_ATSC, e_NONE)

codec

Video codec used for converting

false

enum (e_HEVC, e_AVC, e_MPEG2, e_BASEBAND)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

dolbyVisionConfigFile

Dolby-Vision Configuration file path

false

string

dvbAuInfor

Enable DVB AU Information

false

boolean

dynamicFrameRateMode

Enable Dynamic Frame Rate mode per service

false

enum (e_OFF, e_AUTO)

ebpMode

Encoder boundary point structure standard

false

enum (e_NONE, e_PRE_STANDARD, e_CABLELABS, e_CABLELABS_ATS)

enableOutputAfd

Obsolete

false

boolean

enableVideoModeChange

Enable/Disable VANC control for video mode change

false

boolean

enableVitcOutput

Enable VITC output

false

boolean

encodingLevel

Obsolete: use encodingLevelV2 instead

false

enum (e_H264_AUTO, e_H264_1, e_H264_1_1, e_H264_1_2, e_H264_1_3, e_H264_2, e_H264_2_1, e_H264_2_2, e_H264_3, e_H264_3_1, e_H264_3_2, e_H264_4, e_H264_4_1, e_H264_4_2, e_H264_5, e_H264_5_1, e_H264_5_2, e_H265_AUTO, e_H265_1, e_H265_2, e_H265_2_1, e_H265_3, e_H265_3_1, e_H265_4, e_H265_4_1, e_H265_5, e_H265_5_1, e_H265_5_2, e_H265_6, e_H265_6_1, e_H265_6_2, e_MPEG2_AUTO, e_MPEG2_MAIN, e_MPEG2_HIGH)

encodingLevelV2

Encoding level for video

false

enum (e_H264_AUTO, e_H264_1, e_H264_1_1, e_H264_1_2, e_H264_1_3, e_H264_2, e_H264_2_1, e_H264_2_2, e_H264_3, e_H264_3_1, e_H264_3_2, e_H264_4, e_H264_4_1, e_H264_4_2, e_H264_5, e_H264_5_1, e_H264_5_2, e_H265_AUTO, e_H265_1, e_H265_2, e_H265_2_1, e_H265_3, e_H265_3_1, e_H265_4, e_H265_4_1, e_H265_5, e_H265_5_1, e_H265_5_2, e_H265_6, e_H265_6_1, e_H265_6_2, e_MPEG2_AUTO, e_MPEG2_MAIN, e_MPEG2_HIGH)

encodingProfile

Encoding profile for video

false

enum (e_H264_HIGH, e_H264_MAIN, e_H264_BASELINE, e_H265_MAIN, e_H265_MAIN_10_BIT, e_MPEG2_MAIN, e_H264_HIGH_422)

framerate

Frame rate of video

false

enum (e_25, e_29_97, e_50, e_59_94, e_23_98, e_FOLLOW_INPUT)

gopLenM

GOP Len M

false

enum (e_AUTO, e_IP, e_IBP, e_IBBP, e_IBBBP, e_IBBBBBBBP)

gopLenN

GOP Len N

false

integer (int32)

gopOption

GOP option

false

enum (e_OPEN_FIXED, e_OPEN_VARIABLE, e_OPEN_CAPPED, e_CLOSED_FIXED, e_CLOSED_VARIABLE, e_OPEN_FIXED_M, e_CLOSED_FIXED_M)

hdrDynamicMetadataPassthrough

Enable the Dolby-Vision 8.1 or AHDR SL-HDR1 metadata passthrough. If the input is HEVC with metadata, the metadata will be passthrough, otherwise they are generated. False by default.

false

boolean

hdrMetadataMode

Select HDR10 metadata generation method : manual, auto

false

enum (e_MANUAL, e_AUTO)

hdrMetadataPreset

Choose HDR10 preset from selection

false

enum (e_BT_2020, e_DCI_P3_THEATER, e_DCI_P3_DISPLAY)

hdrSignaling

HDR Signaling, work with HEVC codec and H265 Main10 encoding Profile

false

enum (e_NONE, e_PASSTHROUGH, e_BT_709_HLG, e_BT_709_SDR, e_BT_2020, e_BT_2020_HLG, e_BT_2020_HLG_14, e_BT_2020_HDR10, e_BT_2020_DoVi_5, e_BT_2020_DoVi_8_1, e_BT_2020_DoVi_8_1_ST2094_40, e_BT_2020_DoVi_8_4, e_BT_2020_DoVi_8_4_14, e_BT_2020_ST2094_10, e_BT_2020_ST2094_40, e_BT_2020_ST2094_10_40, e_BT_709_SL_HDR1, e_BT_2020_DR_PASSTHROUGH, e_BT_709_DR_PASSTHROUGH)

idrPeriod

IDR frame period of video in second

false

integer (int32)

irisVQBoost

Select to improve the VQ by adjusting the on/off/setting of each video filter, based on input frames

false

enum (e_DISABLED, e_ENABLED)

keepGfxColorSpace

Disable GFX color-space conversion

false

boolean

labels

Labels identifier of video

false

string array

latencyOption

Set latency mode: low, reduced, default

false

enum (e_2_5, e_3_5, e_5_5, e_LOW, e_REDUCED, e_DEFAULT)

lookAheadBuffer

Obsolete, decide by latencyOption, Look ahead buffer size in milliseconds

false

enum (e_500, e_1000)

lutHlgBt2020ToSdrBt709

LUT file configuraton for BT.2020 HLG to BT.709 SDR conversion

false

string

lutPqBt2020ToSdrBt709

LUT file configuraton for BT.2020 PQ to BT.709 SDR conversion

false

string

lutSdrBt709ToHlgBt2020

LUT file configuraton for BT.709 SDR to BT.2020 HLG conversion

false

string

lutSdrBt709ToPqBt2020

LUT file configuraton for BT.709 SDR to BT.2020 PQ conversion

false

string

maxCll

Configure maximum content light level for HDR10 metadata

false

integer (int32)

maxFall

Configure maximum average frame level for HDR10 metadata

false

integer (int32)

maxLuminance

Configure maximum luminance for HDR10 metadata

false

integer (int32)

minLuminance

Configure minimum luminance for HDR10 metadata

false

integer (int32)

muteOutputAfd

Mute output AFD, default : false

false

boolean

outputBasePid

(Deprecrated) Output base PID of the video

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 481 if not defined in source grooming (non-TS source for example). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

outputPipPid

PIP Output PID of the video

false

integer (int32)

pictureEnhancement

Picture color enhancement control

false

enum (e_DISABLE, e_WEAK, e_VERY_WEAK, e_VIVID, e_TONE_EXPANSION, e_TONE_EXPANSION_PRO)

pipBitrate

Bitrate of PIP video in bps

false

integer (int32)

pipEncodingLevel

Encoding level for PIP video

false

enum (e_H264_AUTO, e_H264_1, e_H264_1_1, e_H264_1_2, e_H264_1_3, e_H265_AUTO, e_H265_2)

pipEncodingProfile

Encoding profile for pip

false

enum (e_H264_HIGH, e_H264_MAIN, e_H264_BASELINE, e_H265_MAIN, e_H265_MAIN_10_BIT, e_MPEG2_MAIN)

pipFramerate

Frame rate of PIP video

false

enum (e_14_98, e_25, e_29_97)

pipGenerate

PIP Generate

false

boolean

pipIsdbt1seg

PIP as ISDB-T 1-SEG

false

boolean

pipResolutionHV

Horizontal and Vertical Resolution of PIP video

false

enum (e_96x96, e_128x96, e_192x192, e_144x192, e_192x144, e_320x180, e_320x240)

processing

Convert or pass-through video

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

ptsSpacingOption

PTS Spacing Option

false

enum (e_COMPLIANT, e_UNCONSTRAINED)

resolution

Vertical Resolution of video

false

enum (e_480I, e_576I, e_720P, e_1080I, e_1080P, e_1440P, e_1800P, e_2160P, e_540P)

resolutionHV

Horizontal and Vertical Resolution of video

false

enum (e_352x480I, e_480x480I, e_528x480I, e_544x480I, e_640x480I, e_704x480I, e_720x480I, e_352x576I, e_480x576I, e_528x576I, e_544x576I, e_640x576I, e_704x576I, e_720x576I, e_640x720P, e_960x720P, e_1280x720P, e_960x1080I, e_1280x1080I, e_1440x1080I, e_1920x1080I, e_960x1080P, e_1280x1080P, e_1440x1080P, e_1920x1080P, e_2560x1440P, e_3200x1800P, e_3840x2160P, e_960x540P, e_FOLLOW_INPUT)

reverseTelecine

Enable Reverse Telecine per service

false

boolean

segmentSize

Segment size defined with encoder boundary point

false

integer (int32)

slHdr1ConfigFile

AHDR SL-HDR1 Configuration file path

false

string

streamDescriptors

Stream descriptor of video

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

stressBias

Controls the stress on the encoded content at various bit rates

false

enum (e_CLEAN, e_BALANCED, e_SHARP)

vbvDelay

Obsolete, decide by latencyOption, Video buffering verifier buffer time in miliseconds, and value under 10 represents time in seconds

false

integer (int32)

videoFixedImageConversion

Obsolete

false

enum (e_NONE, e_FORCE_CENTER_CUT, e_CONVERT_14_9_PILLARBOX_TO_LETTERBOX, e_SQUEEZE_TO_ANAMORPHIC, e_FORCE_PILLAR, e_FORCE_LETTER, e_REMOVE_LETTER, e_CONVERT_LETTER_TO_PILLAR_14_9, e_ANAMORPHIC)

vqMode

Video quality mode, preference between density and quality

false

enum (e_AUTOMATIC, e_HIGH_VQ, e_OBJECTIVE, e_HIGH_DENSITY)

com.harmonicinc.vos.labwizard.rest.model.ISO639Descriptor

Name Description Required Schema Default

iso639DescriptorData

Data of ISO639 Descriptor

true

com.harmonicinc.vos.labwizard.rest.model.ISO639DescriptorData array

com.harmonicinc.vos.labwizard.rest.model.ISO639DescriptorData

Name Description Required Schema Default

iso639AudioType

Audio Type of audio stream

true

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE)

language

Language code of stream

true

string

com.harmonicinc.vos.labwizard.rest.model.Information

Name Description Required Schema Default

createUser

The create user of the profile version

false

string

createUserEmail

The create user email of the profile version

false

string

description

List of properties changes

false

com.harmonicinc.vos.labwizard.rest.model.Information$ProfileChanges array

note

The descriptive note user enter when saving a new profile version

false

string

supercede

The profile version which is replaced by current version

false

string

validateUser

The validate user of the profile version

false

string

validateUserEmail

The validate user email of the profile version

false

string

com.harmonicinc.vos.labwizard.rest.model.Information$ProfileChanges

Name Description Required Schema Default

key

The name of the changed property

false

string

newValue

The updated value of the changed property

false

string

oriValue

The original value of the changed property

false

string

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties

Name Description Required Schema Default

audioStreamSelections

audioStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$AudioStreamSelectionItem array

videoStreamSelections

videoStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem array

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$AudioStreamSelectionItem

Name Description Required Schema Default

audioCodecSelection

audioCodecSelection

false

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, MPEGH, ALL)

audioLanguageSelections

audioLanguageSelections

false

string array

audioTypeSelections

audioTypeSelections

false

enum (UNDEFINED, CLEAN_EFFECTS, HEARING_IMPAIRED, VISUAL_IMPAIRED_COMMENTARY, PRIMARY, NATIVE) array

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem$AudiobitrateRange

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem

Name Description Required Schema Default

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem$BitrateRange

frameRateRange

frameRateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$FrameRateRange

horizontalResolutionRange

horizontalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem$HorizontalResolutionRange

verticalResolutionRange

verticalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$VerticalResolutionRange

videoCodecSelection

videoCodecSelection

false

enum (H_265, H_264, ALL)

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem$BitrateRange

Name Description Required Schema Default

esBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$EsBitrateRange

exclude

false

boolean

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties$VideoStreamSelectionItem$HorizontalResolutionRange

Name Description Required Schema Default

maxHorizontalResolution

false

integer (int32)

minHorizontalResolution

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.InternalPackagingProperties

Name Description Required Schema Default

fromliveSegmentDuration

The duration of a from-live media segment file (expressed in minutes).

true

integer (int32)

fromliveSegmentRetentionPeriod

The duration that the from-live media segment files actually retain in the internal storage (expressed in minutes).

true

integer (int32)

liveSegmentRetentionPeriod

The duration that the live media segment files actually retain in the internal storage (expressed in minutes).

true

integer (int32)

rtvodFlag

The Nielsen RTVOD flag to be inserted to the audio.

false

enum (e_NONE, e_AUTO, e_C3, e_C7)

com.harmonicinc.vos.labwizard.rest.model.IrdetoWatermarkProperties

Name Description Required Schema Default

banner

Irdeto watermark banner

false

enum (e_OFF, e_ON, e_QR)

customParameters

Irdeto watermark custom parameters

false

string

nbIdrPerSequence

Irdeto watermark number of IDR frames per sequence

false

integer (int32)

profile

Irdeto watermark profile

false

enum (e_DEFAULT, e_CUSTOM, e_CUSTOMVMASK)

psnr

Irdeto watermark PSNR

false

number (double)

scdfactor

Irdeto watermark factor parameter for the scene-cut detection

false

number (double)

com.harmonicinc.vos.labwizard.rest.model.LabWizardProfile

Name Description Required Schema Default

allowedAddon

AllowedAddon of profile

false

com.harmonicinc.vos.labwizard.rest.model.AllowedAddon

atsDestinationProfileProperties

Properties of ATS destination profile

false

com.harmonicinc.vos.labwizard.rest.model.ATSDestinationProfileProperties

attributeCustomizationProfileProperties

Properties of HLS streams filtering

false

com.harmonicinc.vos.labwizard.rest.model.AttributeCustomizationProfileProperties

broadcastCBRProfileProperties

not yet defined, will have a strong-typed profile

false

object

creationTime

creation time of the profile

true

string

customerVersion

The Customer Version of the profile

false

string

demuxProfileProperties

Properties of DEMUX profile

false

com.harmonicinc.vos.labwizard.rest.model.DemuxProfileProperties

destinationProfileProperties

Properties of destination profile

false

com.harmonicinc.vos.labwizard.rest.model.DestinationProfileProperties

drmTrackFilterProfileProperties

Properties of DrmTrack Filter profile

false

com.harmonicinc.vos.labwizard.rest.model.DrmTrackFilterProfileProperties

fileTranscodingProfileProperties

Properties of File Transcoding profile

false

com.harmonicinc.vos.labwizard.rest.model.FileTranscodingProfileProperties

harmonicVersion

The Harmonic Version of the profile

false

string

hlsGroupingProfileProperties

Properties of HLS audio grouping profile

false

com.harmonicinc.vos.labwizard.rest.model.HlsGroupingProfileProperties

id

identifier of profile

false

string

information

Information of profile

false

com.harmonicinc.vos.labwizard.rest.model.Information

inputStreamSelectionProfileProperties

Properties of Input Stream Selection profile

false

com.harmonicinc.vos.labwizard.rest.model.InputStreamSelectionProfileProperties

iptvDestinationProfileProperties

Properties of IPTV destination profile

false

com.harmonicinc.vos.labwizard.rest.model.IPTVDestinationProfileProperties

iptvProfileProperties

Properties of iptv profile

false

com.harmonicinc.vos.labwizard.rest.model.IPTVProfileProperties

isCustomized

If it is a customer created profile, it can be deleted in RT.

false

boolean

isLiveEvent

false

boolean

isReadonly

If it is a readonly profile, no property can be modified

false

boolean

isTemplate

If it is a template, it will not be allowed to be deleted, modified

false

boolean

labels

Labels are used to specify identifying metadata

true

string array

lastUpdatedTime

last update time of the profile

true

string

loopRecordProfileProperties

false

com.harmonicinc.vos.labwizard.rest.model.LoopRecordProfileProperties

manipulationProfileProperties

Properties of Manipulation profile

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties

masterId

The Master Id of the profile

false

string

minRequiredVosBundleVersion

false

string

mmsTranscodeRequirements

Optional field for defining the computing resource requirement on each transcode node. (only used for MMS)

false

com.harmonicinc.vos.labwizard.rest.model.MmsTranscodeRequirement array

mptsDestinationProfileProperties

Properties of MPTS destination profile

false

com.harmonicinc.vos.labwizard.rest.model.MptsDestinationProfileProperties

mptsProfileProperties

Properties of MPTS profile

false

com.harmonicinc.vos.labwizard.rest.model.MptsProfileProperties

multiscreenProfileProperties

Properties of multiscreen profile

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties

name

Display name of profile

true

string

ottStbProfileProperties

Properties of ott set top box profile

false

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties

processingRequirementProperties

Optional field on defining the computing resource requirement on processing this profile. (only used for Transcoding profile)

false

com.harmonicinc.vos.labwizard.rest.model.ProcessingRequirementProperties

pureOttPlayoutDestinationProfileProperties

Properties of Pure OTT Playout destination profile

false

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties

pureOttPlayoutProfileProperties

Properties of Pure OTT Playout profile

false

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutProfileProperties

stbProfileProperties

Properties of set top box profile

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties

type

The type of profiles

true

enum (e_IPTV, e_STB, e_MULTISCREEN, e_OTT_STB, e_BOARDCAST_CBR, e_MPTS, e_DESTINATION, e_IPTV_DESTINATION, e_FILE_DESTINATION, e_ATS_DESTINATION, e_MULTISCREEN_PASSTHROUGH, e_FILE_TRANSCODING, e_MANIPULATION, e_MPTS_DESTINATION, e_PURE_OTT_PLAYOUT, e_PURE_OTT_PLAYOUT_DESTINATION, e_LOOP_RECORD, e_IPTV_PASSTHROUGH, e_DRMTRACK, e_HLS_GROUPING, e_DEMUX, e_INPUT_STREAM_SELECTION, e_HLS_ATTRIBUTE_CUSTOMIZATION)

validateTime

The Validate Time of the profile

false

string

validated

Is profile valid?

false

boolean

version

The minimal required VOS bundle version to use this profile

false

string

com.harmonicinc.vos.labwizard.rest.model.LoopRecordProfileProperties

Name Description Required Schema Default

proxyChannelEnabled

Proxy channel enabled

false

boolean

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties

Name Description Required Schema Default

audioStreamSelections

audioStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem array

key

match key of the manipulation profile

true

string

preferredVideoStreamIndex

preferred Video Stream Index

false

integer (int32)

videoStreamSelections

videoStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem array

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem

Name Description Required Schema Default

audioCodecSelection

audioCodecSelection

false

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, MPEGH, ALL)

audioLanguageSelections

audioLanguageSelections

false

string array

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem$AudiobitrateRange

withAudioGain

withAudioGain

false

enum (ENABLE, DISABLE, ALL)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$AudioStreamSelectionItem$AudiobitrateRange

Name Description Required Schema Default

maxBitrateInbps

maxBitrateInbps

false

integer (int32)

minBitrateInbps

minBitrateInbps

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem

Name Description Required Schema Default

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange

frameRateRange

frameRateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$FrameRateRange

horizontalResolutionRange

horizontalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$HorizontalResolutionRange

verticalResolutionRange

verticalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$VerticalResolutionRange

videoCodecSelection

videoCodecSelection

false

enum (H_265, H_264, ALL)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange

Name Description Required Schema Default

esBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$EsBitrateRange

exclude

false

boolean

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

tsBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$TsBitrateRange

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$EsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$BitrateRange$TsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

false

integer (int32)

minBitrateInbps

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$FrameRateRange

Name Description Required Schema Default

maxFrameRate

false

integer (int32)

minFrameRate

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$HorizontalResolutionRange

Name Description Required Schema Default

maxHorizaontalResolution

Obsolete

false

integer (int32)

maxHorizontalResolution

false

integer (int32)

minHorizaontalResolution

Obsolete

false

integer (int32)

minHorizontalResolution

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ManipulationProfileProperties$VideoStreamSelectionItem$VerticalResolutionRange

Name Description Required Schema Default

maxVerticalResolution

false

integer (int32)

minVerticalResolution

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.MmsTranscodeRequirement

Name Description Required Schema Default

cpuLimit

The CPU limit (maximum number of cores) on handle this profile.

false

number (double)

cpuRequirement

The CPU requirement (number of core) on handle this profile.

true

number (double)

gpuRequirement

The GPU requirement (number of core) on handle this profile

true

number (double)

memoryRequirement

The Memory requirement (in MB) on handle this profile

true

number (double)

mmsGroup

The corresponding MmsGroup ID of this processing requirement setting.

true

integer (int32)

readyForProvision

Ready for provision

false

boolean

com.harmonicinc.vos.labwizard.rest.model.Mpeg1L2ProfileProperties

Name Description Required Schema Default

transportStream

Transport Stream type

false

enum (e_MPEG1, e_MPEG2)

com.harmonicinc.vos.labwizard.rest.model.MptsDestinationProfileProperties

Name Description Required Schema Default

encapsulationSettings

Encapsulation Settings.

false

com.harmonicinc.vos.labwizard.rest.model.MptsEncapsulationSettings

muteOutputOnSignalLoss

Mute mux output on input signal loss

false

boolean

serviceRedundancyMode

Service redundancy mode for the MPTS service.

false

enum (e_ACTIVE_BACKUP, e_ACTIVE_ACTIVE)

com.harmonicinc.vos.labwizard.rest.model.MptsDimProperties

Name Description Required Schema Default

maxNbTSSource

Maximum number of TS sources initialized at startup in the range [0..50]

false

integer (int32)

maxNbTranscodeSource

Maximum number of statmux transcoding sources initialized at startup

false

integer (int32)

maxNbTsSrtSource

Maximum number of SRT sources initialized at startup in the range [0..50]

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.MptsEncapsulationSettings

Name Description Required Schema Default

enableFEC

Enable FEC

false

boolean

encapsulationMode

Encapsulation Mode.

true

enum (e_UDP, e_RTP)

fecColumn

FEC Column

false

integer (int32)

fecRow

FEC Row

false

integer (int32)

isFecColumnOnly

Enable FEC column only mode

false

boolean

com.harmonicinc.vos.labwizard.rest.model.MptsProfileProperties

Name Description Required Schema Default

bandwidth

Bitrate of output stream in bps

true

integer (int32)

dimProperties

Dimension settings of the mux

false

com.harmonicinc.vos.labwizard.rest.model.MptsDimProperties

mptsType

MPTS type

false

enum (e_MPEG, e_ATSC, e_DVB_SIS_DSA)

muxWithBlackout

precise the capability of the mux to do blackout

false

boolean

pidScheme

PID allocation scheme

false

com.harmonicinc.vos.labwizard.rest.model.PidScheme

signalingTables

Signaling Tables of output stream

false

com.harmonicinc.vos.labwizard.rest.model.SignalingTables

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties

Name Description Required Schema Default

audioMatchingMode

The audio matching mode indicates how the audio encoding profile is specified. User can specify audio encoding profile per each language type, or specify the audio encoding profile based on the label associated with the input audio

false

enum (e_MATCH_BY_LANGUAGE, e_MATCH_BY_LABEL)

audios

List of multiscreen audio processing setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenAudio array

breakoutCode

Obsolete

false

enum (e_NONE, e_LIVE_CONTENT_WITH_SAME_TV_ADS, e_LIVE_CONTENT_WITHOUT_SAME_TV_ADS)

data

List of mutliscreen data processing setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenData array

dataFilteringMode

Data filtering mode

false

enum (e_INCLUDE_ALL_DATA, e_FILTER_BY_SRC_LABEL)

dvbProviderName

Provider name of the DVB SDT. Applicable when sdtGenerationMode is e_GENERATE

false

string

editingStatus

The editing status indicate which properties group is in manual mode, user cannot configure properties on the left parametric section in the profile editor

false

integer (int32)

endpoint

Specify end point support Adaptive Transport Stream or Multi-bitrate

false

enum (e_ATS, e_HARMONIC_MBTS)

extraVideoDelay

Extra video delay in milliseconds. Default is 0.

false

integer (int32)

outputPcrPid

Output PID of the PCR

false

integer (int32)

outputPidId3Descriptor

Define output PID of Nielsen ID3 descriptor

false

integer (int32)

outputPmtPid

Output PMT PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 32 if not defined in source grooming (non-TS source for example). If -2 is set, the value is initialized at service start with input PMT PID, or 32 for non-TS source (-2 is available for backward compatibility and is not recommended). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

preferredAudioProfile

Select audio profile profile as preferred bit rate for multiscreen profile, range from 1-16, default will be 1

false

integer (int32)

preferredVideoProfile

Select video profile profile as preferred bit rate for multiscreen profile, range from 1-11, default will be one level above the lowest video bit rate

false

integer (int32)

receiverTimezone

IATA timezone for receiver

false

string

scheduling

Scheduling setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$Scheduling

sdtGenerationMode

SDT generation mode: e_FOLLOW_INPUT to transmit the ingress SDT and patch the program name with the VOS service name, the resolution, the frame-rate and the bitrate, e_GENERATE to set the DVB service name to service name+resolution+framerate+bitrate, set the NetworkId to 0 and transmit that SDT or e_DISABLE to disable the SDT output

false

enum (e_FOLLOW_INPUT, e_GENERATE, e_DISABLE)

setTopBoxProfileId

Specify the Id of STB profile

true

string

stereoDownmixMode

Downmix mode for stereo

false

enum (e_Auto, e_LtRt, e_LoRo)

streamBasedAudios

List of multiscreen pid based audio processing setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenStreamBasedAudio array

upsignal

Enable AC-3 upsignaling (supports AC-3 5.1 audio output only)

false

boolean

video

Multicreen video processing setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideo

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$LcevcParam

Name Description Required Schema Default

lcevcEnabled

Enable LCEVC

false

boolean

lcevcScalingMode

Specifies the scaling mode for the base encoder picture in the LCEVC hierarchy

false

enum (e_AUTO, e_0D, e_1D, e_2D)

lcevcTune

Specifies the targeted quality metric for the LCEVC layer

false

enum (e_VQ, e_PSNR, e_SSIM, e_VMAF, e_VMAF_NEG, e_ANIMATION)

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenAudio

Name Description Required Schema Default

audioTrackIndex

Audio track index used to map the audio track in input audio grooming

false

integer (int32)

language

Used for mapping audio source with processing profile, 'All Language', means the setting of 1st language will overwrite all the setting for other languages

false

string

languageIndex

Audio index used to mapping the languages defined in Configure app’s setting, support up to 16 audio tracks, range 1~16

false

integer (int32)

profiles

List of multiscreen audio processing setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenAudioProfile array

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenAudioProfile

Name Description Required Schema Default

aacProfileProperties

AAC profile properties - AAC meta data

false

com.harmonicinc.vos.labwizard.rest.model.AACProfileProperties

audioAUPerPES

Number of audio AU per PES

false

enum (e_Auto, e_1AU_per_PES, e_5AU_per_PES, e_6AU_per_PES)

audioLevelAdjustmentProperties

General Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.AudioLevelAdjustmentProperties

audioUpmixerConfig

Configuration for audio upmixer

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixerConfig

bitrate

Audio bitrate in bps

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

Audio channel setting for converting

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

codec

Audio codec used for converting

false

enum (e_AC_4, e_E_AC_3, e_AC_3, e_HE_AAC_v2, e_HE_AAC_v1, e_AAC_LC, e_MPEG1_L2, e_MPEGH)

dialnorm

(Deprecrated) Audio dialogue normalization (average loudness) in dB, applied for AC-4, AC-3, E-AC3 codec

false

integer (int32)

dolbyAC4AdvanceProperties

Dolby AC4 Advanced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyAC4AdvanceProperties

dolbyPlusAdvanceProperties

Dolby Plus Adavnced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyPlusAdvanceProperties

gain

Audio gain in dB when LevelMagic leveling is disabled, Dialnorm will be set as default value

false

integer (int32)

halcAudioLevelAdjustementProperties

HALC Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.HALCAudioLevelAdjustementProperties

kantarSnapWatermarkEnabled

Enable Kantar Snap watermarking for this channel

false

boolean

labels

Labels identifier of audio

false

string array

leveling

Enable audio LevelMagic leveling

false

boolean

loudnessTarget

Loudness setting in LKFS when LevelMagic leveling is enabled, Dialnorm will be overridden

false

integer (int32)

mpeg1L2ProfileProperties

Mpeg1 Layer2 Profile Properties

false

com.harmonicinc.vos.labwizard.rest.model.Mpeg1L2ProfileProperties

nielsenWatermarkProperties

Nielsen Watermarking Configurations

false

com.harmonicinc.vos.labwizard.rest.model.NielsenWatermarkProperties

outputBasePid

(Deprecrated) Output base PID of the audio

false

integer (int32)

processing

Convert or pass-through audio

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

sampleRate

Audio sampling rate in Hz

false

enum (e_16, e_32, e_44, e_48)

sourceChannel

Audio M1L2 source channel used for converting

false

enum (e_LEFT, e_RIGHT)

sourceDolbyEProgramNumber

(Deprecrated) Source DolbyE program number

false

integer (int32)

speechToTextProperties

Speech to Text Properties

false

com.harmonicinc.vos.labwizard.rest.model.SpeechToTextProperties

streamDescriptors

Stream descriptor of audio

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenData

Name Description Required Schema Default

dataMaxBitrate

false

integer (int32)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

dpiProcessingProperties

properties for SCTE35 processing options

false

com.harmonicinc.vos.labwizard.rest.model.DpiProcessingProperties

enableDvbSubtitleBurnIn

Enable DVB Subtitle BurnIn

false

boolean

enableTtmlToDvbConversion

Enable TTML to DVB Subtitle conversion

false

boolean

maxBitRate

Max Bitrate of the data

false

integer (int32)

outputBasePid

(Deprecrated) Output base PID of the data

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 582 (or higher) if not defined in source grooming (non-TS source for example). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

scte27ToDvbSubtitleConversionProperties

properties related to SCTE27 to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.Scte27ToDvbSubtitleConversionProperties

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

sourceLabels

List of label of the source stream to be processed

false

string array

streamDescriptors

Stream descriptor of data

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

teletextToDvbSubtitleConversionProperties

properties related to teletext to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.TeletextToDvbSubtitleConversionProperties

teletextToTtmlConversionProperties

properties related to teletext to ttml conversion

false

com.harmonicinc.vos.labwizard.rest.model.TeletextToTtmlConversionProperties

ttmlToDvbSubtitleConversionProperties

properties related to ttml to DVB subtitle conversion

false

com.harmonicinc.vos.labwizard.rest.model.TtmlToDvbSubtitleConversionProperties

videoKeyList

Video key list to match the selected videos

false

string array

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenStreamBasedAudio

Name Description Required Schema Default

aacProfileProperties

AAC profile properties - AAC meta data

false

com.harmonicinc.vos.labwizard.rest.model.AACProfileProperties

audioAUPerPES

Number of audio AU per PES

false

enum (e_Auto, e_1AU_per_PES, e_5AU_per_PES, e_6AU_per_PES)

audioKey

Audio key to establish output profile starting with this audio stream.

false

string

audioLevelAdjustmentProperties

General Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.AudioLevelAdjustmentProperties

audioMixingProperties

Settings for audio mixing

false

com.harmonicinc.vos.labwizard.rest.model.AudioMixingProperties

audioUpmixerConfig

Configuration for audio upmixer

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixerConfig

audioUpmixingProperties

Settings for audio upmixing

false

com.harmonicinc.vos.labwizard.rest.model.AudioUpmixingProperties

bitrate

Audio bitrate in bps

false

enum (e_AUTO_SELECT, e_12, e_16, e_18, e_20, e_24, e_28, e_30, e_32, e_38, e_40, e_48, e_56, e_64, e_72, e_80, e_88, e_96, e_104, e_112, e_120, e_128, e_144, e_160, e_176, e_192, e_196, e_200, e_208, e_216, e_224, e_232, e_240, e_248, e_256, e_264, e_272, e_288, e_304, e_320, e_336, e_352, e_368, e_384, e_388, e_400, e_416, e_448, e_480, e_512, e_528, e_544, e_576, e_640, e_704, e_720, e_768, e_800, e_832, e_896, e_960, e_1024)

channels

Audio channel setting for converting

false

enum (e_PASSTHROUGH, e_STEREO, e_MONO, e_DOLBY_5_1, e_DUAL_MONO, e_5_1_4)

codec

Audio codec used for converting

false

enum (e_AC_4, e_E_AC_3, e_AC_3, e_HE_AAC_v2, e_HE_AAC_v1, e_AAC_LC, e_MPEG1_L2, e_MPEGH)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

dialnorm

(Deprecrated) Audio dialogue normalization (average loudness) in dB, applied for AC-4, AC-3, E-AC3 codec

false

integer (int32)

dolbyAC4AdvanceProperties

Dolby AC4 Advanced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyAC4AdvanceProperties

dolbyPlusAdvanceProperties

Dolby Plus Adavnced Properties

false

com.harmonicinc.vos.labwizard.rest.model.DolbyPlusAdvanceProperties

fallbackOnSilenceDetection

Fallback on silence detection

false

boolean

gain

Audio gain in dB when LevelMagic leveling is disabled, Dialnorm will be set as default value

false

integer (int32)

halcAudioLevelAdjustementProperties

HALC Audio Level Adjustement Properties

false

com.harmonicinc.vos.labwizard.rest.model.HALCAudioLevelAdjustementProperties

kantarSnapWatermarkEnabled

Enable Kantar Snap watermarking for this channel

false

boolean

labels

Labels identifier of audio

false

string array

leveling

Enable audio LevelMagic leveling

false

boolean

loudnessTarget

Loudness setting in LKFS when LevelMagic leveling is enabled, Dialnorm will be overridden

false

integer (int32)

mpeg1L2ProfileProperties

Mpeg1 Layer2 Profile Properties

false

com.harmonicinc.vos.labwizard.rest.model.Mpeg1L2ProfileProperties

nielsenWatermarkProperties

Nielsen Watermarking Configurations

false

com.harmonicinc.vos.labwizard.rest.model.NielsenWatermarkProperties

outputBasePid

(Deprecrated) Output base PID of the audio

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 482 (or higher) if not defined in source grooming (non-TS source for example). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

processing

Convert or pass-through audio

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

profileIndex

When not null, profides ordering among output profiles, with value starting from 1. When null, order in the JSON is used.

false

integer (int32)

sampleRate

Audio sampling rate in Hz

false

enum (e_16, e_32, e_44, e_48)

secondSourceLabels

List of label of the second source stream to be processed

false

string array

sourceAudioProcessingMode

Audio Stream Processing Mode

false

enum (e_SWITCH, e_MIX, e_UPMIX)

sourceChannel

Audio M1L2 source channel used for converting

false

enum (e_LEFT, e_RIGHT)

sourceDolbyEProgramNumber

(Deprecrated) Source DolbyE program number

false

integer (int32)

sourceLabel

(Deprecrated) Label of the source stream to be processed

false

string

sourceLabels

List of label of the source stream to be processed

false

string array

speechToTextProperties

Speech to Text Properties

false

com.harmonicinc.vos.labwizard.rest.model.SpeechToTextProperties

streamDescriptors

Stream descriptor of audio

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

thirdSourceLabels

List of label of the third source stream to be processed

false

string array

videoKeyList

Join with output profiles by listing EITHER "videoKey" or "audioKey". If null, default algorithm is used to match only with all video profiles.

false

string array

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideo

Name Description Required Schema Default

aspectRatio

Output Aspect ratio of video

false

enum (e_16_9, e_4_3, e_PASSTHROUGH)

bitrateMax

Maximum bitrate of video in bps, for auto calculation the best video and audio parameter setting

false

integer (int32)

bitrateMin

Minimum bitrate of video in bps, for auto calculation the best video and audio parameter setting

false

integer (int32)

closedCaption

Closed captions passthrough setting

false

enum (e_AUTO, e_ATSC, e_NONE)

dolbyVisionConfigFile

Dolby-Vision Configuration file path

false

string

dynamicFrameRateMode

Enable Dynamic Frame Rate mode per service

false

enum (e_OFF, e_AUTO)

enableOutputAfd

Obsolete

false

boolean

eyeQ

Enable EyeQ

false

boolean

eyeQQualityLevel

EyeQ Quality Level

false

enum (e_HIGH_FIDELITY, e_BALANCED, e_HIGH_COMPRESSION)

framerateConversion

Convert frame rate of video between 50Hz and 59.94Hz system or force output frame rate on VOS

false

enum (e_PASSTHROUGH, e_PASSTHROUGH_ROUND_UP, e_50_DOMAIN, e_59_94_DOMAIN, e_FR_25, e_FR_29_97, e_FR_30, e_FR_50, e_FR_59_94, e_FR_60)

hdrMetadataMode

Select HDR10 metadata generation method : manual, auto

false

enum (e_MANUAL, e_AUTO)

hdrMetadataPreset

Choose HDR10 preset from selection

false

enum (e_BT_2020, e_DCI_P3_THEATER, e_DCI_P3_DISPLAY)

irisVQBoost

Select to improve the VQ by adjusting the on/off/setting of each video filter, based on input frames

false

enum (e_DISABLED, e_ENABLED)

keepGfxColorSpace

Disable GFX color-space conversion

false

boolean

latencyOption

Set latency mode: low, reduced, default

false

enum (e_2_5, e_3_5, e_5_5, e_VERY_SHORT, e_LOW, e_REDUCED, e_DEFAULT)

lookAheadBuffer

Obsolete, decide by latencyOption, Look ahead buffer size in milliseconds

false

enum (e_500, e_1000)

lutHlgBt2020ToSdrBt709

LUT file configuraton for BT.2020 HLG to BT.709 SDR conversion

false

string

lutPqBt2020ToSdrBt709

LUT file configuraton for BT.2020 PQ to BT.709 SDR conversion

false

string

lutSdrBt709ToHlgBt2020

LUT file configuraton for BT.709 SDR to BT.2020 HLG conversion

false

string

lutSdrBt709ToPqBt2020

LUT file configuraton for BT.709 SDR to BT.2020 PQ conversion

false

string

maxCll

Configure maximum content light level for HDR10 metadata

false

integer (int32)

maxFall

Configure maximum average frame level for HDR10 metadata

false

integer (int32)

maxLuminance

Configure maximum luminance for HDR10 metadata

false

integer (int32)

minLuminance

Configure minimum luminance for HDR10 metadata

false

integer (int32)

muteOutputAfd

Mute output AFD, default : false

false

boolean

pictureEnhancement

Picture color enhancement control

false

enum (e_DISABLE, e_WEAK, e_VERY_WEAK, e_VIVID, e_TONE_EXPANSION, e_TONE_EXPANSION_PRO)

processing

Convert or pass-through video

false

enum (e_PASSTHROUGH, e_CONVERT, e_DISABLE)

profiles

Video output qualities setting

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideoProfile array

ptsSpacingOption

PTS Spacing Option

false

enum (e_COMPLIANT, e_UNCONSTRAINED)

slHdr1ConfigFile

AHDR SL-HDR1 Configuration file path

false

string

stressBias

Controls the stress on the encoded content at various bit rates

false

enum (e_CLEAN, e_BALANCED, e_SHARP)

vbvDelay

Obsolete, decide by latencyOption, Video buffering verifier buffer time in miliseconds, and value under 10 represents time in seconds

false

integer (int32)

videoFixedImageConversion

Obsolete

false

enum (e_NONE, e_FORCE_CENTER_CUT, e_CONVERT_14_9_PILLARBOX_TO_LETTERBOX, e_SQUEEZE_TO_ANAMORPHIC, e_FORCE_PILLAR, e_FORCE_LETTER, e_REMOVE_LETTER, e_CONVERT_LETTER_TO_PILLAR_14_9, e_ANAMORPHIC)

vqMode

Video quality mode, preference between density and quality

false

enum (e_AUTOMATIC, e_HIGH_VQ, e_OBJECTIVE, e_HIGH_DENSITY, e_ELITE_VQ)

watermark

Watermark parameters

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideoWatermark

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideoProfile

Name Description Required Schema Default

aspectRatio

Obsolete

false

enum (e_16_9, e_4_3, e_PASSTHROUGH)

bitrate

Bitrate of video in bps

false

integer (int32)

codec

Video codec used for converting

false

enum (e_HEVC, e_AVC, e_VVC)

descriptorMode

Reserved

false

enum (e_LEGACY, e_MANUAL, e_DYNAMIC_PASSTHROUGH)

enableOutputAfd

Obsolete

false

boolean

enableVMAFEstimation

Alpha Feature: Enable/Disable VMAF estimation. When enabled, the VMAF estimation will be shown in Kibana for AVC 1080P/1080I.

false

boolean

enableVitcOutput

Enable VITC output

false

boolean

encodingLevel

Encoding level for video

false

enum (e_H264_AUTO, e_H264_1, e_H264_1_1, e_H264_1_2, e_H264_1_3, e_H264_2, e_H264_2_1, e_H264_2_2, e_H264_3, e_H264_3_1, e_H264_3_2, e_H264_4, e_H264_4_1, e_H264_4_2, e_H264_5, e_H264_5_1, e_H265_AUTO, e_H265_1, e_H265_2, e_H265_2_1, e_H265_3, e_H265_3_1, e_H265_4, e_H265_4_1, e_H265_5, e_H265_5_1, e_H264_5_2, e_H265_5_2, e_H265_6, e_H265_6_1, e_H265_6_2, e_H266_AUTO)

encodingProfile

Encoding profile for video

false

enum (e_H264_HIGH, e_H264_MAIN, e_H264_BASELINE, e_H265_MAIN, e_H265_MAIN_10_BIT, e_H266_MAIN10_10_BIT)

framerate

Frame rate of video

false

enum (e_1, e_FOLLOW_SOURCE, e_HALF, e_QUARTER, e_24, e_25, e_29_97, e_50, e_59_94)

gopLenM

GOP Len M

false

enum (e_AUTO, e_IP, e_IBP, e_IBBP, e_IBBBP, e_IBBBBBBBP, e_IDR)

gopLenN

GOP Len N

false

integer (int32)

gopOption

GOP option

false

enum (e_OPEN_FIXED, e_OPEN_VARIABLE, e_OPEN_CAPPED, e_CLOSED_FIXED, e_CLOSED_VARIABLE, e_OPEN_FIXED_M, e_CLOSED_FIXED_M)

hResolution

Resolution of horizontal video

false

integer (int32)

hdrDynamicMetadataPassthrough

Enable the Dolby-Vision 8.1 or AHDR SL-HDR1 metadata passthrough. If the input is HEVC with metadata, the metadata will be passthrough, otherwise they are generated. False by default.

false

boolean

hdrSignaling

HDR Signaling, work with HEVC codec and H265 Main10 encoding Profile

false

enum (e_NONE, e_PASSTHROUGH, e_BT_709_HLG, e_BT_709_SDR, e_BT_2020, e_BT_2020_HLG, e_BT_2020_HLG_14, e_BT_2020_HDR10, e_BT_2020_DoVi_5, e_BT_2020_DoVi_8_1, e_BT_2020_DoVi_8_1_ST2094_40, e_BT_2020_DoVi_8_4, e_BT_2020_DoVi_8_4_14, e_BT_2020_ST2094_10, e_BT_2020_ST2094_40, e_BT_2020_ST2094_10_40, e_BT_709_SL_HDR1, e_BT_2020_DR_PASSTHROUGH, e_BT_709_DR_PASSTHROUGH)

idrPeriod

IDR frame period of video in second

false

integer (int32)

idrPeriodMs

IDR frame period of video in millisecond

false

integer (int32)

interlace

Interlace Output

false

boolean

labels

Labels identifier of video

false

string array

lcevcParam

false

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$LcevcParam

logoSlateGroupLabel

Logo and Slate Group label for per profile insertion

false

string

mmsGroup

MmsGroup ID

false

integer (int32)

outputBasePid

(Deprecrated) Output base PID of the video

false

integer (int32)

outputPid

Output PID, normal range is 32..8190. If -1 is set, source grooming value (as set during discover process) will be used, or 481 if not defined in source grooming (non-TS source for example). Any other value is not recommended and will behave as -1 in current version.

false

integer (int32)

profileIndex

When not null, profides ordering among output profiles, with value starting from 1. When null, order in the JSON is used.

false

integer (int32)

rateControl

Rate Control

false

enum (e_ABR, e_EYEQ, e_CBR)

streamDescriptors

Stream descriptor of video

false

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor array

vResolution

Resolution of vertical video

false

integer (int32)

vbvDelay

(Deprecrated) Video buffering verifier buffer time in miliseconds, and value under 10 represents time in seconds

false

integer (int32)

videoKey

Video key to match the audio or data list. If null, default algorithm is used

false

string

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$MultiscreenVideoWatermark

Name Description Required Schema Default

irdetoProperties

Multiscreen Irdeto watermark properties

false

com.harmonicinc.vos.labwizard.rest.model.IrdetoWatermarkProperties

nagraNglmProperties

Multiscreen Nagra Nexguard watermark properties

false

com.harmonicinc.vos.labwizard.rest.model.NagraNglmWatermarkProperties

type

Multiscreen video watermark type

false

enum (e_NONE, e_NAGRA_NGLM, e_IRDETO)

com.harmonicinc.vos.labwizard.rest.model.MultiscreenProfileProperties$Scheduling

Name Description Required Schema Default

blackoutScheduling

Enable blackout scheduling

false

boolean

com.harmonicinc.vos.labwizard.rest.model.NagraNglmWatermarkProperties

Name Description Required Schema Default

customerId

Nagra NexGuard watermark customer ID (64-bit hexadecimal string)

false

string

preset

Nagra NexGuard watermark preset

false

enum (e_OTT_1, e_OTT_2)

strength

Nagra NexGuard watermark strength

false

enum (e_LIGHTEST, e_LIGHTER, e_DEFAULT, e_STRONGER, e_STRONGEST)

com.harmonicinc.vos.labwizard.rest.model.NielsenWatermarkProperties

Name Description Required Schema Default

cbetCheckDigits

CBET CheckDigits

false

string

cbetSid

CBET Sid

false

integer (int32)

checkDigits

Check Digits

false

string

insertionMode

Insertion Mode

false

enum (e_OVERWRITE, e_REFRAIN)

sid

Sid

false

integer (int32)

sourceType

Source Type

false

enum (e_PROGRAM, e_COMMERCIAL, e_VOD_BREAKOUT)

stepAside

CBET StepAside

false

boolean

watermarkType

Watermark Type

false

enum (e_NAES_II, e_NAES_VI, e_NAES_II_AND_NAES_VI, e_NAES_CBET, e_NAES_VI_AND_CBET, e_NAES_II_VI_AND_CBET)

watermarkingLevel

Watermark Level

false

enum (e_PC, e_FD)

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties

Name Description Required Schema Default

dashOutputPreference

Configure custom Dash Output Preference of the stream

false

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$DashOutputPreference

hlsOutputPreference

Configure custom Hls Output Preference of the stream

false

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$HlsOutputPreference

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$DashOutputPreference

Name Description Required Schema Default

disableSuggestedPresentationDelay

Suggested Presentation Delay for Dash live output

false

boolean

forcePresentationTimeOffsetZero

[Warning! Not conform to specification] Force Presentation Time Offset Zero in DASH CatchUp & LLCU manifest

false

boolean

playtimeZerobaseMappingMode

Playtime Zero-base Mapping Mode in DASH StartOver / CatchUp / VOD / LLCU

false

enum (e_DISABLED, e_ENABLED)

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$HlsOutputPreference

Name Description Required Schema Default

indexPlaylistCustomization

Index Playlist customization settings

false

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$IndexPlaylistCustomization

masterPlaylistCustomization

Master Playlist customization settings

false

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$MasterPlaylistCustomization

pmtDescriptorOutputMode

PMT descriptor generation mode for hls ts segments

"e_LEGACY":Pass-through the last descriptor from the source, stream type id refer to "Stream Type Id Table",

"e_PASSTHROUGH":Pass-through all descriptors from the source, pass-through stream type id from source,

"e_DVB":Pass-through all descriptors from the source, override ATSC descriptor by generating DVB descriptor, stream type id refer to DVB scheme

Specific Customization for GPT set-top boxes, and later other similar cases

"e_NONE": no specific settings

"e_ProMedia": For Promedia-specific STBs (ID3 subtitles in Video segments, lower-case language code, "imagetype" in ID3 syntax)

false

enum (e_LEGACY, e_PASSTHROUGH, e_DVB)

specificCustomization

false

enum (e_NONE, e_ProMedia)

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$IndexPlaylistCustomization

Name Description Required Schema Default

drmKeyUriParametersPattern

DRM Key URI parameters pattern: Possible values:
%r
%t
%p
Empty by default.
Example: '%r%t%p'

false

string

com.harmonicinc.vos.labwizard.rest.model.OttStbProfileProperties$MasterPlaylistCustomization

Name Description Required Schema Default

customExtXStreamInfTagPattern

EXT-X-STREAM-INF tag pattern. Possible values:
%BANDWIDTH
%AVERAGE-BANDWIDTH
%CODECS
%PROGRAM-ID
%RESOLUTION
%FRAME-RATE
%HDCP-LEVEL
%AUDIO
%VIDEO
%SUBTITLES
%CLOSED-CAPTIONS
%SUPPLEMENTAL-CODECS
%URI
%VIDEO-RANGE
Empty by default.
Separator-','

false

string

enableExtXIndependentSegmentsTag

Insert EXT-X-INDEPENDENT-SEGMENTS tag to the playlist

false

boolean

com.harmonicinc.vos.labwizard.rest.model.PackagingProfileProperties

Name Description Required Schema Default

cmafPackagingProperties

The Properties of CMAF packaging.

false

com.harmonicinc.vos.labwizard.rest.model.CmafPackagingProperties

dashPackagingProperties

The Properties of Dash packaging.

false

com.harmonicinc.vos.labwizard.rest.model.DashPackagingProperties

hlsPackagingProperties

The Properties of HLS packaging.

false

com.harmonicinc.vos.labwizard.rest.model.HlsPackagingProperties

inputStreamSelectionProfileId

Specify the id of stream selection profile.

false

string

internalPackagingProperties

The settings for internal packaging.

false

com.harmonicinc.vos.labwizard.rest.model.InternalPackagingProperties

manipulationProfileIds

The List of manipulation profile Ids.

false

string array

name

The unique name of packaging profile. it is used to differentiate packaging profile

true

string

ottSetTopBoxProfileId

Specify the id of packaging destination specific ott set top box profile.

false

string

packagingProfileType

The type of packaging profile.

true

enum (e_DASH, e_HLS, e_SS, e_INTERNAL, e_RAW_TS, e_RTMP, e_CMAF, e_THUMBNAIL)

rawTsPackagingProperties

The settings for Raw TS packaging.

false

com.harmonicinc.vos.labwizard.rest.model.RawTsPackagingProperties

rtmpPackagingProperties

The settings for RTMP packaging.

false

com.harmonicinc.vos.labwizard.rest.model.RtmpPackagingProperties

ssPackagingProperties

The Properties of Smooth Streaming packaging.

false

com.harmonicinc.vos.labwizard.rest.model.SsPackagingProperties

thumbnailPackagingProperties

The Properties of thumbnail packaging.

false

com.harmonicinc.vos.labwizard.rest.model.ThumbnailPackagingProperties

com.harmonicinc.vos.labwizard.rest.model.PidScheme

Name Description Required Schema Default

audioPid

audio pids scheme

true

com.harmonicinc.vos.labwizard.rest.model.VideoBasedScheme

dataPid

other pids scheme

true

com.harmonicinc.vos.labwizard.rest.model.VideoBasedScheme

keepInputPids

keep input PID numbers

true

boolean

pmtPid

PMT pid scheme

true

com.harmonicinc.vos.labwizard.rest.model.PnBasedScheme

scte35Pid

DPI pids scheme

true

com.harmonicinc.vos.labwizard.rest.model.VideoBasedScheme

videoPid

video pid scheme

true

com.harmonicinc.vos.labwizard.rest.model.PnBasedScheme

com.harmonicinc.vos.labwizard.rest.model.PnBasedScheme

Name Description Required Schema Default

addend

addend

true

integer (int32)

pnFactor

Program Number factor

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ProcessingRequirementProperties

Name Description Required Schema Default

cpuLimit

The CPU limit (maximum number of cores) on handle this profile.

false

number (double)

cpuRequirement

The CPU requirement (number of core) on handle this profile.

true

number (double)

gpuRequirement

The GPU requirement (number of core) on handle this profile

true

number (double)

memoryRequirement

The Memory requirement (in MB) on handle this profile

true

number (double)

readyForProvision

Ready for provision

false

boolean

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties

Name Description Required Schema Default

dashPackagingProperties

The Properties of DASH packaging.

false

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties$DashPackagingProperties

hlsPackagingProperties

The Properties of HLS packaging.

false

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties$HlsPackagingProperties

packagingProfileType

The packaging profile type of pure OTT playout channel.

true

enum (e_DASH, e_HLS)

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties$DashPackagingProperties

Name Description Required Schema Default

dvrWindowSize

Control of the availability of media segment files most recently added to the Media Presentation Description (MPD) file (expressed in seconds).

true

integer (int32)

mpdFileName

The name of Media Presentation Description (MPD) file which is used to describe a Media Presentation.

true

string

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutDestinationProfileProperties$HlsPackagingProperties

Name Description Required Schema Default

dvrWindowSize

Control the availability of media segment files most recently added to the index file (in seconds).

true

integer (int32)

scte35Signaling

The way of handling SCTE35 messages. 'NONE' means ignoring the messages; 'BASE64' means writing the SCTE35 data to playlist in base64 format.; 'STANDARD' means writing the SCTE35 data to playlist in SCTE35 Standard format; 'GOOGLE DOUBLE CLICK' means writing the SCTE35 data to playlist in Google Double Click format; 'UK 1 means writing the SCTE35 data to playlist in UK 1 format; Default is 'NONE'

false

enum (e_NONE, e_STANDARD)

variantPlaylistFileName

The variant playlist lists the URLs of each variant stream to allow clients to switch between encodings dynamically. This setting specifies the file name of the variant playlist excluding file extension (i.e. .m3u8). For example, if this value is set to 'master' (excluding ''), the actual file name will be 'master.m3u8'.

true

string

com.harmonicinc.vos.labwizard.rest.model.PureOttPlayoutProfileProperties

Name Description Required Schema Default

dashManifest

A serialized DASH manifest which defines desired video, audio, subtitle adaptation set. Will be used only if the packagingProfileType equals "e_DASH".

false

string

hlsVariantPlaylist

A serialized HLS variant playlist which defines desired video, audio, subtitle streams. Will be used only if the packagingProfileType equals "e_HLS".

false

string

packagingProfileType

The packaging profile type of pure OTT playout channel.

true

enum (e_DASH, e_HLS)

com.harmonicinc.vos.labwizard.rest.model.RawTsPackagingProperties

Name Description Required Schema Default

segmentLength

The duration of the media segment files (in seconds).

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.RtmpPackagingProperties

Name Description Required Schema Default

lbaMode

Activate Late Binding Audio

false

boolean

psvpAudioLanguage

Audio Language to select audio stream

false

string

psvpAudioMaxBitrate

Audio Max Bit Rate to select audio stream

false

integer (int32)

psvpVideoMaxBitrate

Video Max Bit Rate to select video profile

false

integer (int32)

publishSingleVideoProfile

Activate Publish Single Video Profile

false

boolean

reconnInterval

The reconnection interval (expressed in milli seconds).

false

integer (int32)

userAgent

User agent (i.e. flash version)

false

string

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties

Name Description Required Schema Default

bitrateMode

Bitrate mode of stream, e.g. constant bitrate or ouput for evolved Multimedia Broadcast Multicast Services

false

enum (e_CBR, e_eMBMS, e_ABR, e_HVQ)

cc608TO708

Specifiy the conversion of CEA-608 captions to CEA-708 captions

false

enum (e_AUTOSENSE, e_ALWAYS, e_NEVER)

cc608To708

false

enum (e_AUTOSENSE, e_ALWAYS, e_NEVER)

closedCaption

Packetize the closed captioning data if it’s present in the input stream

false

enum (e_ATSC, e_SCTE_20, e_DIVICOM, e_NADBS, e_DTVLACC, e_608FROM708, e_SCTE_20_ATSC, e_SCTE_20_MOT_DVS_157, e_CHINA_CC, e_NONE)

descriptors

Define the stream descriptors

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Descriptor array

disableAc3DescGeneration

disable AC3/EAC3 descriptor generation

false

boolean

dpi

Configure DPI of stream if SCTE 35 messages are carried in input source, e.g. filter mode or should handle stream conditioning or splicing

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$DPI

mappingType

false

enum (e_PID_BASED, e_PROGRAM_NUMBER_BASED)

pidBaseMap

Remap the output pid based on base and offset value, outputPid=basePid+pidOffset(++)

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$PidBaseMap

profileType

false

enum (e_IPTV, e_MULTISCREEN)

programNumberMap

Remap the output pid based on program number, multiplier and offset value, outputPid=(programNumber*multiplier)pidOffset(+)

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$ProgramNumberMap

restrictions

Define the special rules to process this particular STB profile

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Restriction array

subtitling

Configure Subtitling of the stream, e.g. input selection of DVB or EBU or any, specify the expected output format

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Subtitling

teletext

Configure Teletext of the stream, e.g. input selection of DVB or VBI or any, specify the expected output format

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Teletext

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$DPI

Name Description Required Schema Default

filterMode

Filter Mode of DPI, pass all or drop all

false

enum (e_PASS_ALL, e_DROP_ALL)

handleSplicing

Should the transcoder handle splicing

false

boolean

handleStreamConditioning

Should the transcoder handle stream conditioning at splice point to prepare for destination device

false

boolean

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Descriptor

Name Description Required Schema Default

content

Content of the descriptor based 64 encoded

false

string

descriptorTag

descriptorTag of the descriptor

false

integer (int32)

locator

Location of the descriptor

false

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Locator

name

Name of the descriptor

false

string

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Locator

Name Description Required Schema Default

esType

Type of ES

false

integer (int32)

language

ISO 639 language

false

string

streamIdentification

pid

true

string

table

descriptor table location

false

enum (e_PMT, e_PMT_LOOP, e_TRANSPORT, e_TRANSPORT_LOOP, e_SDT, e_SDT_LOOP)

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$PidBaseMap

Name Description Required Schema Default

audioPidOffset

Offset value for audio pid remapping, auto increment for multiple audio streams

true

integer (int32)

basePid

Base value for pid remapping, outputPid will be basePid plus offset

true

integer (int32)

otherPidOffset

Offset value for data stream pid remapping, auto increment for multiple data streams

true

integer (int32)

videoPidOffset

Offset value for video pid remapping

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$ProgramNumberMap

Name Description Required Schema Default

audioPidOffset

Offset value for audio pid remapping, auto increment for multiple audio streams

true

integer (int32)

multiplier

Value used for multiplying input program number for pid remapping

true

integer (int32)

otherPidOffset

Offset value for data stream pid remapping, auto increment for multiple data streams

true

integer (int32)

videoPidOffset

Offset value for video pid remapping

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Restriction

Name Description Required Schema Default

description

Description of the restriction

false

string

name

Name of the restriction

false

string

options

Options of Restriction

false

string

restrictionType

Type of the restriction

false

enum (e_VIDEO_ENCODING, e_AUDIO_ENDCODING, e_GENERAL)

script

Restriction express in java script

false

string

type

Restriction to which data format

false

enum (e_NUMBER, e_STRING, e_ENUM)

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Subtitling

Name Description Required Schema Default

subtitlingInputSelection

Configure Subtitling Input Selection, e.g. DVB or EBU or any

false

enum (e_ANY_SUBTITLING, e_DVB_SUBTITLING_ONLY, e_EBU_SUBTITLING_ONLY)

subtitlingOutputFormat

Configure the output format of Subtitling, e.g. follow the input

false

enum (e_FOLLOW_THE_INPUT)

com.harmonicinc.vos.labwizard.rest.model.STBProfileProperties$Teletext

Name Description Required Schema Default

teletextInputSelection

Configure Teletext Input Selection, e.g. DVB or VBI or any

false

enum (e_ANY_TELETEXT, e_DVB_TELETEXT_ONLY, e_VBI_TELETEXT_ONLY)

teletextOutputFormat

Configure the output format of Teletext, e.g. none or follow the input

false

enum (e_NONE, e_FOLLOW_THE_INPUT)

com.harmonicinc.vos.labwizard.rest.model.Scte27ToDvbSubtitleConversionProperties

Name Description Required Schema Default

forceDdsOn

Force DDS On, default: false

false

boolean

language

Output DVB Subtitle Language. default:ENG

false

enum (ENG, DEU, SWE, FIN, HUN, ITA, FRA, POR, SPA, CES, SLK, POL, TUR, SRP, HRV, SLV, RON, EST, LAV, LIT, RUS, BUL, UKR, ELL, ARA, HEB)

pageId

Page Id, default: 1, range: 0-255

false

integer (int32)

subtitleType

Output DVB subtitle descriptor type. default:e_NORMAL_0x10

false

enum (e_NORMAL_0x10, e_NORMAL_4_3_0x11, e_NORMAL_16_9_0x12, e_NORMAL_2_21_1_0x13, e_NORMAL_HD_0x14, e_HEARING_0x20, e_HEARING_4_3_0x21, e_HEARING_16_9_0x22, e_HEARING_2_21_1_0x23, e_HEARING_HD_0x24)

com.harmonicinc.vos.labwizard.rest.model.Scte35GenericProperties

Name Description Required Schema Default

periodTimingSpecification

Period Timing Specification for VOD (generic signalling mode)

false

enum (e_BY_START_ATTRIBUTE, e_BY_DURATION_ATTRIBUTE) array

scte35Carriage

SCTE-35 carriage (generic signalling mode)

false

enum (e_INBAND_SEGMENT_BINARY, e_IN_MPD_BASE64) array

com.harmonicinc.vos.labwizard.rest.model.SignalingTable

Name Description Required Schema Default

buildingMode

Defines where the table is built

false

enum (e_NONE, e_LOCAL)

tableName

The configured table

false

enum (e_SDT_ACTUAL, e_PAT, e_PMT, e_CAT)

com.harmonicinc.vos.labwizard.rest.model.SignalingTables

Name Description Required Schema Default

tables

Signaling Tables

false

com.harmonicinc.vos.labwizard.rest.model.SignalingTable array

com.harmonicinc.vos.labwizard.rest.model.SpeechToTextProperties

Name Description Required Schema Default

defaultSubtitle

Set the subtitle stream to be default subtitle stream in packaging output

false

boolean

outputPid

Output pid for the text stream

false

integer (int32)

streamName

Stream name for the subtitle stream in packaging output

false

string

subtitlePurpose

Subtitle purpose, default is 0 (same-lang-dialogue)

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.SsPackagingProperties

Name Description Required Schema Default

audioSegmentLength

The duration of the audio segment files (expressed in seconds).

true

integer (int32)

audioSegmentLengthInMillisecond

The duration of the audio segment files (expressed in milliseconds).

false

integer (int32)

dvrWindowSize

Control of the availability of media segment files most recently added to the Media Presentation Description (MPD) file (expressed in seconds).

true

integer (int32)

enableCommonSegmentUrlDelivery

Enable common segment URL delivery.

false

boolean

enableEAC3

Enable support of packaging EAC3 codec. Default value is true.

false

boolean

enableHEVCCodec

Enable support of packaging HEVC codec. Default value is true.

false

boolean

enableKeyRotation

Enable key rotation.

true

boolean

enablePackageBasedKeyRotation

Override the DRM global setting and enable customized per Package output key rotation setting

true

boolean

encryptionMethod

Specify which encryption method should be used when integrate with DRM.

true

enum (e_PLAYREADY, e_CLEAR)

epoch

Enum to control whether to use default epoch (1-Mar-2011) or unix epoch.

false

enum (e_UNIX, e_VOS)

keyChangePeriod

The key change period for key rotation (expressed in seconds).

true

integer (int32)

languageCodeLetterCase

The letter case of subtitle language.
Options:e_ALL_CAPITALS,e_ALL_SMALL
Default is ALL_CAPITALS

true

enum (e_ALL_CAPITALS, e_ALL_SMALL)

qpcTrackSubtype

The QPC Track Subtype.
Options:CAPT,DATA
Default is CAPT

false

enum (CAPT, DATA)

scte35Signaling

The way of handling SCTE35 messages. 'NONE' means ignoring the messages; 'AZURE' means writing SCTE35 data to sparse text track according to Azure ingest format specification, 'USP' means writing SCTE35 data to sparse track according to Unified Streaming ingest format specification. Default is 'NONE'

false

enum (e_NONE, e_AZURE, e_USP)

segmentRetentionPeriod

The duration that the media segment files actually retain in the publishing server (expressed in minutes).

true

integer (int32)

showReadySegmentsOnly

Wait for all bitrates to be ready and skip to add chunk into manifest for those not ready segments. Default is true.

false

boolean

subtitleFourCC

Define FourCC for subtitle. This field should be s string containing 4 characters.

false

string

subtitleNamePattern

The subtitle name pattern.

Supported escape pattern:
%lang Subtitle language code in lowercase
%index Subtitle track index

Sample configuration: sub_%lang or sub_%index or sub_%lang_%index (for language: ita)
Resultant subtitle name: sub_ita or sub_1 or sub_ita_1

true

string

ttmlTemplate

The TTML template. String in XML that allows to control how output TTML looks like.

false

string

useRepeatAttribute

A boolean option of using repeat attribute in manifest generation to represent segment entries with same duration in continuous series. Default is true.

false

boolean

videoSegmentLength

The duration of the video segment files (expressed in seconds).

true

integer (int32)

videoSegmentLengthInMillisecond

The duration of the video segment files (expressed in milliseconds).

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.StreamDescriptor

Name Description Required Schema Default

captionServiceDescriptor

Caption Service Descriptor

true

com.harmonicinc.vos.labwizard.rest.model.CaptionServiceDescriptor

customDescriptor

Custom descriptor

true

com.harmonicinc.vos.labwizard.rest.model.CustomDescriptor

descriptorType

Type of descriptor

true

enum (ISO639, DVB_SUBTITLING, CAPTION_SERVICE, TELETEXT, CUSTOM)

dvbSubtitlingDescriptor

Dvb descriptor

true

com.harmonicinc.vos.labwizard.rest.model.DvbSubtitlingDescriptor

iso639Descriptor

ISO639 descriptor

true

com.harmonicinc.vos.labwizard.rest.model.ISO639Descriptor

teletextDescriptor

Teletext descriptor

true

com.harmonicinc.vos.labwizard.rest.model.TeletextDescriptor

com.harmonicinc.vos.labwizard.rest.model.TeletextDescriptor

Name Description Required Schema Default

teletextDescriptorData

Data of Teletext Descriptor

true

com.harmonicinc.vos.labwizard.rest.model.TeletextDescriptorData array

com.harmonicinc.vos.labwizard.rest.model.TeletextDescriptorData

Name Description Required Schema Default

language

Language code of data stream

true

string

teletextHexPageNum

Verbatim hexadecimal page number of teletext stream - should be used if not null

false

string

teletextMagazineNumber

Magazine number of teletext stream

true

integer (int32)

teletextPageNumber

Obsolete decimal page number of teletext stream - does not support pages in the range [A-F]

true

integer (int32)

teletextType

Type of teletext

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.TeletextToDvbSubtitleConversionProperties

Name Description Required Schema Default

ancillaryPageId

Obsolete. Ancillary Page Id, default: 0, range: 0-255

false

integer (int32)

bkgTransparency

Background transparency, default: 100, range 0-100

false

integer (int32)

dvbPageTimeout

Specifies the DVB PageTimeOut value (in sec) encoded into the page segment. Value should be multiple of 0.5. Default: 0

false

number (double)

font

Font name, default: dejavu

false

string

fontDensity

Horizontal font density. A value of 1.0 equals 1em of the font mapped to the teletext cell size. 2.0 will map 2em into the one cell.
For fixed sized fonts a value of 1 is recommended, but for true type a value of 1.4 looks much better. Default: 1.4

false

number (double)

frameSize

Dvb subtitle frame size. Default: e_FOLLOW_OUTPUT. Note: value e_768x576 means SD 720x576

false

enum (e_1920x1080, e_1280x720, e_768x576, e_FOLLOW_OUTPUT)

language

Teletext language. default:ENG

false

enum (ENG, DEU, SWE, FIN, HUN, ITA, FRA, POR, SPA, CES, SLK, POL, TUR, SRP, HRV, SLV, RON, EST, LAV, LIT, RUS, BUL, UKR, ELL, ARA, HEB)

pageId

Page Id, default: 0, range: 0-255

false

integer (int32)

subtitleType

Output DVB subtitle descriptor type. default:e_NORMAL_0x10

false

enum (e_NORMAL_0x10, e_NORMAL_4_3_0x11, e_NORMAL_16_9_0x12, e_NORMAL_2_21_1_0x13, e_NORMAL_HD_0x14, e_HEARING_0x20, e_HEARING_4_3_0x21, e_HEARING_16_9_0x22, e_HEARING_2_21_1_0x23, e_HEARING_HD_0x24)

teletextType

Teletext type. Initial Teletext page, Teletext Subtitle Page, Additional Information Page, Hearing Impaired, Program Schdule Page

false

integer (int32)

txtOutlineWidth

Outline width in pixel, default: 0, range: 0.0-10.0

false

number (double)

com.harmonicinc.vos.labwizard.rest.model.TeletextToTtmlConversionProperties

Name Description Required Schema Default

enable

Enable teletext to ttml conversion

true

boolean

language

ISO 639 language code

true

string

subtitlePurpose

Subtitle purpose

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.ThumbnailPackagingProperties

Name Description Required Schema Default

dvrWindowSize

Control the availability of thumbnail segment files most recently added to the thumbnail index file (in seconds).

true

integer (int32)

imageFormat

The thumbnail format.

false

enum (e_PNG, e_JPG, e_GIF)

imageSpriteInColumn

The image sprite per column for POTF.

true

integer (int32)

imageSpriteInRow

The image sprite per row for POTF.

true

integer (int32)

playlistFileName

The playlist file name.

false

string

segmentRetentionPeriod

The duration that the thumbnail segment files actually retain in the publishing server (in minutes).

true

integer (int32)

thumbnailFileNamePattern

The thumbnail file name pattern.

false

string

thumbnailHeight

The thumbnail height (expressed in pixels).

true

integer (int32)

thumbnailInterval

The thumbnail fragment duration (expressed in milliseconds).

true

integer (int32)

webvttFileNamePattern

The webvtt file name pattern.

false

string

com.harmonicinc.vos.labwizard.rest.model.TtmlToDvbSubtitleConversionProperties

Name Description Required Schema Default

bkgColor

Returns the RGBA background color to overwrite all background colors with. Default value is taken from the subtitle

false

string

dvbPageTimeout

Returns the DVB PageTimeOut value (in sec) encoded into the page segment. Default: 10

false

integer (int32)

font

Returns the File name of the font to use. Default value is 'dejavu'

false

string

fontDensity

Returns the horizontal font density. A value of 1.0 corresponds to 40 columns in the display. Default: 1.0

false

number (float)

txtOutlineWidth

Returns Outline width in pixel. If not specified or 0 outlines are not rendered. Default: 0

false

number (float)

com.harmonicinc.vos.labwizard.rest.model.VideoBasedScheme

Name Description Required Schema Default

interval

PID to PID interval

true

integer (int32)

videoPidAddend

video PID addend

true

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.hlsCustomization.IndexPlaylistCustomization

Name Description Required Schema Default

extXVersionTagValue

EXT-X-VERSION tag value:
-1: default, will set automatic
0: do not insert EXT-X-VERSION tag to the playlist
2 and more - version number

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.hlsCustomization.MasterPlaylistCustomization

Name Description Required Schema Default

extXVersionTagValue

EXT-X-VERSION tag value:
-1: default, will set automatic
0: do not insert EXT-X-VERSION tag to the playlist
2 and more - version number

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.StreamSelectionGroup

Name Description Required Schema Default

audioStreamSelections

audioStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.audio.AudioStreamSelectionItem array

videoStreamSelections

videoStreamSelections

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.VideoStreamSelectionItem array

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.audio.AudioBitrateRange

Name Description Required Schema Default

maxBitrateInbps

Max bitrate in bps

false

integer (int32)

minBitrateInbps

Min bitrate in bps

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.audio.AudioStreamSelectionItem

Name Description Required Schema Default

audioCodecSelection

audioCodecSelection

false

enum (AAC_LC, HE_AAC_V1, HE_AAC_V2, AC_3, E_AC_3, ALL)

audioLanguageSelections

audioLanguageSelections

false

string array

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.audio.AudioBitrateRange

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.FrameRateRange

Name Description Required Schema Default

maxFrameRate

false

integer (int32)

minFrameRate

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.HorizontalResolutionRange

Name Description Required Schema Default

maxHorizontalResolution

false

integer (int32)

minHorizontalResolution

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.VerticalResolutionRange

Name Description Required Schema Default

maxVerticalResolution

false

integer (int32)

minVerticalResolution

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.VideoStreamSelectionItem

Name Description Required Schema Default

bitrateRange

bitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.BitrateRange

frameRateRange

frameRateRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.FrameRateRange

horizontalResolutionRange

horizontalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.HorizontalResolutionRange

verticalResolutionRange

verticalResolutionRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.VerticalResolutionRange

videoCodecSelection

videoCodecSelection

false

enum (H_265, H_264, ALL)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.BitrateRange

Name Description Required Schema Default

esBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.EsBitrateRange

exclude

false

boolean

tsBitrateRange

false

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.TsBitrateRange

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.EsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

Max bitrate in bps

false

integer (int32)

minBitrateInbps

Min bitrate in bps

false

integer (int32)

com.harmonicinc.vos.labwizard.rest.model.streamFiltering.video.bitrate.TsBitrateRange

Name Description Required Schema Default

maxBitrateInbps

Max bitrate in bps

false

integer (int32)

minBitrateInbps

Min bitrate in bps

false

integer (int32)

com.harmonicinc.vos.mux.model.common.Descriptor

Name Description Required Schema Default

hexaValue

the buffer content of the descriptor in hexa value

true

string

com.harmonicinc.vos.mux.model.common.MuxFullService

Name Description Required Schema Default

controlState

false

enum (ON_AIR, OFF_AIR)

destination

true

com.harmonicinc.vos.app.configure.model.destination.Destination

muxSourcesToAdd

true

string array

outputProgramParameters

true

com.harmonicinc.vos.mux.model.programlevel.OutputProgramParameters

service

true

com.harmonicinc.vos.app.configure.model.service.Service

sources

true

com.harmonicinc.vos.app.configure.model.source.Source array

com.harmonicinc.vos.mux.model.common.MuxService

Name Description Required Schema Default

destinations

false

com.harmonicinc.vos.app.configure.model.destination.Destination array

pools

false

com.harmonicinc.vos.app.configure.model.pool.Pool array

service

false

com.harmonicinc.vos.app.configure.model.service.Service

com.harmonicinc.vos.mux.model.common.Network

Name Description Required Schema Default

id

Unique identifier of a network in UUID format

false

string

networkDescriptors

network descriptors in hex TLV format

false

com.harmonicinc.vos.mux.model.common.Descriptor array

networkId

Mpeg Network ID (0-65535)

true

integer (int32)

networkName

Network Name (0-255 characters). Network name descriptor (0x64) will be created when name is not empty

false

string

transports

network transports

false

com.harmonicinc.vos.mux.model.common.Transport array

com.harmonicinc.vos.mux.model.common.TableGenerator

Name Description Required Schema Default

connectionType

Type of connection to ATSC PMCP table provider. FTP mode accepts only FTP connection and FTPS_EXPLICIT mode accepts only FTPS connection in explicit mode. (default value is FTP)

false

enum (FTP, FTPS_EXPLICIT)

ftpUrl

Url of ATSC PMCP table provider

false

string

id

Unique identifier of a table generator in UUID format

false

string

ipAddress

IP address of table generator

false

string

ipNetworkAddress

IP Network address

false

string

login

Login to ATSC PMCP table provider

false

string

name

Display name of a table generator

false

string

password

Password to ATSC PMCP table provider

false

string

type

Table generator type (PSIP_GENRATOR or ATSC_PMCP)

false

enum (PSIP_GENERATOR, ATSC_PMCP)

com.harmonicinc.vos.mux.model.common.Transport

Name Description Required Schema Default

originalNetworkId

MPEG Original Network ID (0-65535)

true

integer (int32)

tsDescriptors

transport descriptors in hex TLV format

false

com.harmonicinc.vos.mux.model.common.Descriptor array

tsMpegId

MPEG TS ID (0-65535)

true

integer (int32)

com.harmonicinc.vos.mux.model.componentlevel.ComponentInputIdentifier

Name Description Required Schema Default

inputObjectId

The serviceId of the service for a transcoded service or sourceId for a passthrough service

true

string

inputPid

Input PID

true

integer (int32)

inputProgramNumber

Input Program number for a pass through service, MUST be null for a transcoded service

false

integer (int32)

inputType

Input Type : ENCODING_SERVICE, TS_SOURCE

true

enum (ENCODING_SERVICE, TS_SOURCE)

com.harmonicinc.vos.mux.model.componentlevel.OutputComponent

Name Description Required Schema Default

id

false

string

inputIdentifier

false

com.harmonicinc.vos.mux.model.componentlevel.ComponentInputIdentifier

outputComponentParameters

false

com.harmonicinc.vos.mux.model.componentlevel.OutputComponentParameters

com.harmonicinc.vos.mux.model.componentlevel.OutputComponentParameters

Name Description Required Schema Default

addedPmtDescriptors

added PMT Descriptors

false

com.harmonicinc.vos.mux.model.common.Descriptor array

cmpTag

output component tag

false

integer (int32)

controlState

Default is ON_AIR. When controlState is OFF_AIR, the component is not present in the output, and the PMT does not refer to it.

false

enum (ON_AIR, OFF_AIR)

delayAdjustment

adjust the delay of a PID coming from a different source, like subtitles or teletext, in ms (values between -5000 to 5000)

false

integer (int32)

filteredPmtDescriptors

When a descriptor tag (in hexa) is present in this list, there will be no PMT descriptor with this tag in the output, unless added using addedPmtDescriptors.

false

string array

pid

output PID

false

integer (int32)

scramblingParameters

scrambling parameters

false

com.harmonicinc.vos.mux.model.componentlevel.OutputComponentScramblingParameters

streamType

stream type

false

integer (int32)

com.harmonicinc.vos.mux.model.componentlevel.OutputComponentScramblingParameters

Name Description Required Schema Default

scramblingGroup

scrambling group

true

string

com.harmonicinc.vos.mux.model.programlevel.InputIdentifier

Name Description Required Schema Default

inputObjectId

The serviceId of the service for a transcoded service, sourceId for a passthrough service or the id of a primary program for a virtual program

true

string

inputProgramNumber

Input Program number for a pass through service, MUST be null for a transcoded service and a virtual program

false

integer (int32)

inputType

Input Type : ENCODING_SERVICE, TS_SOURCE, VIRTUAL_PROGRAM

true

enum (ENCODING_SERVICE, TS_SOURCE, VIRTUAL_PROGRAM, LOCAL_PROGRAM)

com.harmonicinc.vos.mux.model.programlevel.OutputProgram

Name Description Required Schema Default

components

components

false

com.harmonicinc.vos.mux.model.componentlevel.OutputComponent array

controlState

control state : ON_AIR, OFF_AIR

false

enum (ON_AIR, OFF_AIR)

id

Unique identifier of a program in UUID format

false

string

inputIdentifier

input identifier

false

com.harmonicinc.vos.mux.model.programlevel.InputIdentifier

outputProgramParameters

output program parameters

true

com.harmonicinc.vos.mux.model.programlevel.OutputProgramParameters

com.harmonicinc.vos.mux.model.programlevel.OutputProgramEitEttRemultiplexing

Name Description Required Schema Default

enable

Enable EIT/ETT remulitplexing

true

boolean

inputObjectId

Uuid of the source

true

string

majorChannelNumber

Atsc major channel number

true

integer (int32)

minorChannelNumber

Atsc minor channel number

true

integer (int32)

com.harmonicinc.vos.mux.model.programlevel.OutputProgramParameters

Name Description Required Schema Default

addedPmtDescriptors

added PMT Descriptors

false

com.harmonicinc.vos.mux.model.common.Descriptor array

addedSdtDescriptors

added SDT Descriptors

false

com.harmonicinc.vos.mux.model.common.Descriptor array

atscSourceId

atsc source id

false

integer (int32)

atscType

atsc type

false

enum (DIGITAL_TELEVISION, AUDIO, DATA_ONLY)

dvbType

SDT service type, range 0..255. When null, deprecated parameter 'type' is used.
When both parameters are null, the service type from input SDT is used (pass-through mode).
If not defined in input stream, value 0 is used

false

integer (int32)

easParameters

eas parameters

false

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasParameters

eitettRemultiplexing

EIT/ETT remultiplexing (ATSC)

false

com.harmonicinc.vos.mux.model.programlevel.OutputProgramEitEttRemultiplexing

excludePidList

List of PIDs to be excluded (UUID).

false

string array

filteredPmtDescriptors

When a descriptor tag (in hexa) is present in this list, there will be no PMT descriptor with this tag in the output, unless added using addedPmtDescriptors.

false

string array

isDynamic

dynamic program

false

boolean

majorChannelNumber

atsc major channel number

false

integer (int32)

minorChannelNumber

atsc minor channel number

false

integer (int32)

name

program name

false

string

nameCodingTable

The parameter is applicable when SDT is generated, and the parameter name is set in mux configuration. default is "00" (Latin)

false

string

number

program number

false

integer (int32)

pmtParameters

pmt parameters

false

com.harmonicinc.vos.mux.model.programlevel.PmtParameters

pmtPid

pmt pid

false

integer (int32)

provider

provider name

false

string

providerCodingTable

The parameter is applicable when SDT is generated, and the parameter provider is set in mux configuration. default is "00" (Latin)

false

string

scramblingParameters

scrambling parameters

false

com.harmonicinc.vos.mux.model.programlevel.OutputProgramScramblingParameters

separatePcrPid

pcr not on elementary stream pid

false

integer (int32)

type

Deprecated. Use dvbType instead

false

enum (DIGITAL_TELEVISION, DIGITAL_RADIO_SOUND, TELETEXT, MOSAIC)

com.harmonicinc.vos.mux.model.programlevel.OutputProgramScramblingParameters

Name Description Required Schema Default

enable

enable

true

boolean

scramblingGroup

scrambling group

true

string

com.harmonicinc.vos.mux.model.programlevel.PmtParameters

Name Description Required Schema Default

inputObjectId

input object id

false

string

inputPid

input pid

false

integer (int32)

pmtMode

pmt mode

false

enum (NONE, GENERATE, PASSTHROUGH)

com.harmonicinc.vos.mux.model.programlevel.eas.EasChannelInputIdentifier

Name Description Required Schema Default

inputObjectId

The sourceId for the eas channel

true

string

inputProgramNumber

Input program number for the eas channel

true

integer (int32)

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasChannel

Name Description Required Schema Default

cbrBitrate

Cbr bitrate

true

integer (int32)

inputIdentifier

Eas input identifier

false

com.harmonicinc.vos.mux.model.programlevel.eas.EasChannelInputIdentifier

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasLocation

Name Description Required Schema Default

county

County code

true

integer (int32)

state

State code

true

integer (int32)

subdivision

Subdivision code

true

integer (int32)

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasParameters

Name Description Required Schema Default

easChannel

Eas channel

false

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasChannel

enable

Enable eas

true

boolean

groupId

Group Id

false

integer (int32)

locations

Eas locations

false

com.harmonicinc.vos.mux.model.programlevel.eas.OutputProgramEasLocation array

com.harmonicinc.vos.mux.model.ts.OutputTS

Name Description Required Schema Default

globalSettings

Global Settings

true

com.harmonicinc.vos.mux.model.tslevel.GlobalSettings

guiSpecific

Gui specific section

false

com.harmonicinc.vos.mux.model.tslevel.GuiSpecific

muxServiceId

mux service ID

true

string

muxServiceName

mux service name

false

string

programs

Programs

true

com.harmonicinc.vos.mux.model.programlevel.OutputProgram array

unreferencedPids

Unreferenced Pids

false

com.harmonicinc.vos.mux.model.unreferencedpidlevel.OutputUnreferencedPid array

com.harmonicinc.vos.mux.model.tslevel.AtscSettings

Name Description Required Schema Default

eit1RepetitionPeriod

repetition period of EIT-1. Range : [1000ms,3000ms], Default : 3000ms

false

integer (int32)

eit2RepetitionPeriod

repetition period of EIT-2. Range : [2000ms,60000ms], Default : 60000ms

false

integer (int32)

eit3RepetitionPeriod

repetition period of EIT-3. Range : [3000ms,60000ms], Default : 60000ms

false

integer (int32)

eitDepth

Number of 3-hours segment of EIT. Range 4..16, default is 4 (12 hours)

false

integer (int32)

eitFirstPid

first EIT PID, this pid and the followings ones (defined by eitDepth) will be used for the EIT

false

integer (int32)

ett0RepetitionPeriod

repetition period of ETT-0. Range : [1000ms,60000ms], Default : 60000ms

false

integer (int32)

ettDepth

Number of 3-hours segment of ETT. Range 0..16, default is 4 (12 hours). It cannot exceed EIT depth

false

integer (int32)

ettFirstPid

first ETT PID, this pid and the followings ones (defined by ettDepth) will be used for the ETT

false

integer (int32)

vctType

type of Virtual Channel Table

true

enum (TVCT, CVCT)

com.harmonicinc.vos.mux.model.tslevel.DvbSettings

Name Description Required Schema Default

nitParameters

nit parameters

false

com.harmonicinc.vos.mux.model.tslevel.NitParameters

originalNetworkId

original network ID

false

integer (int32)

tdtParameters

tdt parameters

false

com.harmonicinc.vos.mux.model.tslevel.TdtParameters

totParameters

tot parameters

false

com.harmonicinc.vos.mux.model.tslevel.TotParameters

com.harmonicinc.vos.mux.model.tslevel.DvbSisDsaSecondaryInput

Name Description Required Schema Default

inputId

uuid of the input secondary signal

true

string

sisProgramNumber

sis service program number

true

integer (int32)

com.harmonicinc.vos.mux.model.tslevel.DvbSisDsaSettings

Name Description Required Schema Default

dsaGroupId

dsa group id

true

integer (int32)

inputId

uuid of the input parent signal

true

string

sisProgramNumber

sis service program number

true

integer (int32)

sisSecondaries

list of the input secondary signals

false

com.harmonicinc.vos.mux.model.tslevel.DvbSisDsaSecondaryInput array

com.harmonicinc.vos.mux.model.tslevel.EmmStream

Name Description Required Schema Default

bisscaStreamId

Uuid of the BISS-CA EMM stream. Ignored when mode is not BISS_CA

false

string

caDescPrivateData

Private Data to be added to CA Desc (in hexa, for e.g. "AAE1BC3D")

false

string

caSystemId

CA System ID of EMM stream in the CA_descriptor (in hexa, for e.g. "ABCD"). Mandatory when mode is PASSTHROUGH, optional when mode is SIMULCRYPT (use data from Scrambling app by default). Ignored when mode is BISS_CA

false

string

dataStreamId

data_id of the EMM stream. Ignored when mode is not SIMULCRYPT

true

integer (int32)

emmChannelUuid

Uuid of the EMM channel to be used for the EMM stream. Ignored when mode is not SIMULCRYPT

true

string

id

Unique identifier of a EMM stream in UUID format

false

string

inputObjectId

input object id. Ignored when mode is not PASSTHROUGH

false

string

inputPid

input PID. Ignored when mode is not PASSTHROUGH

false

integer (int32)

mode

EMM mode. Default is SIMULCRYPT

false

enum (SIMULCRYPT, PASSTHROUGH, BISS_CA)

pid

The EMM pid value

true

integer (int32)

com.harmonicinc.vos.mux.model.tslevel.ExternalTableGenerators

Name Description Required Schema Default

backupGeneratorId

Backup client unique identifier

false

string

ipPort

TCP port used to receive input (from 7800 to 7899)

true

integer (int32)

mainGeneratorId

Primary client unique identifier

true

string

com.harmonicinc.vos.mux.model.tslevel.GlobalSettings

Name Description Required Schema Default

atscSettings

ATSC settings

false

com.harmonicinc.vos.mux.model.tslevel.AtscSettings

dvbSettings

DVB Settings

false

com.harmonicinc.vos.mux.model.tslevel.DvbSettings

dvbSisDsaSettings

DVB SIS DSA settings

false

com.harmonicinc.vos.mux.model.tslevel.DvbSisDsaSettings

emmStreams

EMM streams

false

com.harmonicinc.vos.mux.model.tslevel.EmmStream array

externalTableGenerators

External Table Generators

false

com.harmonicinc.vos.mux.model.tslevel.ExternalTableGenerators

timezoneId

Timezone Id

false

string

tsId

TS ID

true

integer (int32)

com.harmonicinc.vos.mux.model.tslevel.GuiSpecific

Name Description Required Schema Default

unreferencedPidsGuiEnable

Reserved for GUI use, no impact on Mux behavior

false

boolean

com.harmonicinc.vos.mux.model.tslevel.LocalTimeOffsetDes

Name Description Required Schema Default

countryCode

Identifies a country using the 3-character code

false

string

countryRegionId

A zone in the country which is indicated by country code Range 0..63, default 0

false

integer (int32)

timezone

Timezone Id

false

string

com.harmonicinc.vos.mux.model.tslevel.NitParameters

Name Description Required Schema Default

inputObjectId

input object id. Ignored when nitMode is not PASSTHROUGH

false

string

inputPid

input PID. Ignored when nitMode is not PASSTHROUGH

false

integer (int32)

interval

Table interval (1000-10000 milliseconds). Relevant for GENERATE

false

integer (int32)

networkId

Network Object Id. Relevant for GENERATE

false

string

nitMode

NIT mode

false

enum (NONE, PASSTHROUGH, GENERATE)

com.harmonicinc.vos.mux.model.tslevel.TdtParameters

Name Description Required Schema Default

inputObjectId

Input object id (UUID). Relevant for PASSTHROUGH

false

string

inputPid

Input PID number. Relevant for PASSTHROUGH

false

integer (int32)

interval

Table interval (1000 - 30000 milliseconds). Relevant for GENERATE

false

integer (int32)

tdtMode

TDT Mode

false

enum (GENERATE, NONE, PASSTHROUGH)

com.harmonicinc.vos.mux.model.tslevel.TotParameters

Name Description Required Schema Default

interval

Table interval (1000- 30000 milliseconds). Relevant for GENERATE

false

integer (int32)

localTimeOffsetDescriptor

Local time offset descriptor list

false

com.harmonicinc.vos.mux.model.tslevel.LocalTimeOffsetDes array

totMode

TOT Mode. Will be ignored when tdtMode is PASSTHROUGH.

false

enum (GENERATE, NONE)

com.harmonicinc.vos.mux.model.unreferencedpidlevel.OutputUnreferencedPid

Name Description Required Schema Default

id

false

string

inputIdentifier

false

com.harmonicinc.vos.mux.model.unreferencedpidlevel.UnreferencedPidInputIdentifier

outputUnreferencedPidParameters

false

com.harmonicinc.vos.mux.model.unreferencedpidlevel.OutputUnreferencedPidParameters

com.harmonicinc.vos.mux.model.unreferencedpidlevel.OutputUnreferencedPidParameters

Name Description Required Schema Default

pid

output PID

false

integer (int32)

com.harmonicinc.vos.mux.model.unreferencedpidlevel.UnreferencedPidInputIdentifier

Name Description Required Schema Default

inputObjectId

The serviceId of the service for a transcoded service or sourceId for a passthrough service

true

string

inputPid

Input PID

true

integer (int32)

inputType

Input Type : ENCODING_SERVICE, TS_SOURCE

true

enum (ENCODING_SERVICE, TS_SOURCE)

com.harmonicinc.vos.mux.monitor.model.blackout.BlackoutOutputProgramState

Name Description Required Schema Default

outputProgramId

UUID of the output program

true

string

state

blackout state

true

enum (e_ON, e_OFF)

com.harmonicinc.vos.mux.monitor.model.eas.EasOutputProgramState

Name Description Required Schema Default

outputProgramId

UUID of the output program where the eas is enabled

true

string

state

Eas state

true

enum (e_ORIGINAL, e_EAS_CHANNEL)

com.harmonicinc.vos.mux.monitor.model.eas.EasSwitchRequestCommand

Name Description Required Schema Default

easOutputProgramsState

Send manual Eas switch command to one or several programs

false

com.harmonicinc.vos.mux.monitor.model.eas.EasOutputProgramState array

com.harmonicinc.vos.mux.monitor.model.sdi.FrameRate

Name Description Required Schema Default

denominator

true

integer (int32)

numerator

true

integer (int32)

com.harmonicinc.vos.mux.monitor.model.sdi.MonitorSdiPort

Name Description Required Schema Default

cardNumber

SDI card number

true

integer (int32)

clockReference

The Genlock reference used to pace the SDI output

true

enum (INVALID, INTERNAL_REF, EXTERNAL_GENLOCK)

genlockVideoStandard

The external Genlock video standard detected on the genlock port (SDI output)

true

string

portNumber

SDI port number

true

integer (int32)

portUsage

The current port usage. ASIin, ASIout are not supported yet. Unused replaces them for now.

true

enum (SDI_IN, SDI_OUT, ASI_IN, ASI_OUT, UNUSED)

sourceFormat

The source format, including resolution, framerate and framemode

false

com.harmonicinc.vos.mux.monitor.model.sdi.SourceFormat

syncStatus

The Sync status for SDI input and output

true

enum (LOCKED, UNLOCKED)

com.harmonicinc.vos.mux.monitor.model.sdi.Resolution

Name Description Required Schema Default

height

true

integer (int32)

width

true

integer (int32)

com.harmonicinc.vos.mux.monitor.model.sdi.SourceFormat

Name Description Required Schema Default

frameMode

The frame-mode of the source

true

enum (PROGRESSIVE, INTERLACED)

frameRate

The frame-rate of the source

true

com.harmonicinc.vos.mux.monitor.model.sdi.FrameRate

resolution

The resolution of the source

true

com.harmonicinc.vos.mux.monitor.model.sdi.Resolution

com.harmonicinc.vos.mux.monitor.model.triveni.Section

Name Description Required Schema Default

data

false

string

com.harmonicinc.vos.mux.monitor.model.triveni.TriveniTable

Name Description Required Schema Default

maximumInterval

false

integer (int32)

nextVersionFlag

false

boolean

pid

false

integer (int32)

receptionDate

false

string

sections

false

com.harmonicinc.vos.mux.monitor.model.triveni.Section array

tid

false

integer (int32)

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorAsiSource

Name Description Required Schema Default

asiCard

ASI card used to receive the input (value 0 for card 1, and so on).

true

integer (int32)

asiPort

ASI port used to receive the input (value 0 for port 1, and so on).

true

integer (int32)

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorHspSource

Name Description Required Schema Default

hspEndpoint

Live ingest endpoint of the source

true

string

ipNetworkAddress

Network interface for downling the source. Applicable for XOS and VOS CNS only

false

string

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputComponent

Name Description Required Schema Default

extStreamType

false

integer (int32)

iso_639_code

false

string

pid

false

integer (int32)

scrambled

false

boolean

streamType

false

integer (int32)

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputProgram

Name Description Required Schema Default

inputComponents

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputComponent array

majorChannelNumber

Applicable only for ATSC

false

integer (int32)

minorChannelNumber

Applicable only for ATSC

false

integer (int32)

name

Name from the SDT (DVB), or Short Name from the VCT (ATSC)

false

string

number

false

integer (int32)

pcrPid

false

integer (int32)

pmtPid

false

integer (int32)

provider

false

string

type

false

integer (int32)

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputTS

Name Description Required Schema Default

asiSource

Asi Source parameters

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorAsiSource

hspSource

Hsp Source parameters

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorHspSource

inputObjectId

The serviceId for an ENCODING_SERVICE, or sourceId for a TS_SOURCE

true

string

inputObjectName

The input object name, the input source name for a TS_SOURCE and the service name for a ENCODING_SERVICE

true

string

inputPrograms

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorInputProgram array

inputType

Input Type : ENCODING_SERVICE, TS_SOURCE

true

enum (ENCODING_SERVICE, TS_SOURCE)

ipSource

Ip Source parameters

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorIpSource

isCamMissing

CAM missing status, true if a CAM is intended to be used but is missing, false else

true

boolean

muxServiceId

mux/demux service ID

true

string

muxServiceName

mux/demux service name

true

string

originalNetworkId

Label identifying the network_id of the originating delivery system ( null if not SDT in the TS INPUT TBD)

true

integer (int32)

rfSource

Rf Source parameters

false

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorRfSource

sourceStatus

Source status

false

enum (e_OFFAIR, e_ONAIR)

sourceType

Source type : e_IP, e_RF, e_ASI, e_SRT, e_HSP - available for demux only

false

enum (e_IP, e_RF, e_ASI, e_SRT, e_HSP)

syncLost

Synchro lost status, true if the TS INPUT is in synchro Lost, false else

true

boolean

tsId

Transport stream id of the input TS

true

integer (int32)

type

Service type

true

enum (e_MUX, e_DEMUX)

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorIpSource

Name Description Required Schema Default

ipAddress

IP address used to receive input. IPv4 is supported

true

string

ipNetworkAddress

IP network address

false

string

ipPort

UDP port used to receive input

true

integer (int32)

ssmIpAddresses

Source-specific multicast IP addresses

false

string array

com.harmonicinc.vos.mux.monitor.model.tsinput.MonitorRfSource

Name Description Required Schema Default

adapter

Adapter, from 0 to 7, corresponds to tuners 1 to 8 (adapter 0 is tuner 1)

false

integer (int32)

frontend

Frontend : 0 corresponds to the first card

false

integer (int32)

com.harmonicinc.vos.notification.rest.model.NotificationScheduleFixParam

Name Description Required Schema Default

acknowledgedBy

Username of the user who responsible for the schedule fix

true

string

scheduleFixInstruction

Schedule fix remark

true

string

scheduleFixTime

Time of the schedule fix

true

string (date-time)

com.harmonicinc.vos.notification.rest.model.NotificationTypeSeverityUpdateItem

Name Description Required Schema Default

defaultSeverity

The default severity value of notificatons defined by applicatoin

true

enum (CRITICAL, WARNING, IMPORTANT, MUTE)

id

ID

true

string

severity

The severity value of any new notifications created with this notification type

true

enum (CRITICAL, WARNING, IMPORTANT, MUTE)

title

The title of any new notifications created with this notification type

true

string

com.harmonicinc.vos.playout.zookeeper.access.instancestatus.Graphic

Name Description Required Schema Default

eventId

Secondary event id (UUID)

false

string

layer

Layer used for the logo/graphics, 1 to 8

false

integer (int32)

name

Graphics file name

false

string

startTime

Graphics start time, milliseconds since January 1, 1970

false

integer (int64)

com.harmonicinc.vos.playout.zookeeper.event.TemplateField

Name Description Required Schema Default

boxNumber

The number of the template box to be written

false

integer (int32)

value

The text to be written to the template box

false

string

com.harmonicinc.vos.spi.operation.ServiceOutputUnmuteStartEndTime

Name Description Required Schema Default

endTime

false

string

startTime

false

string

java.net.URL

Name Description Required Schema Default

authority

false

string

content

false

object

defaultPort

false

integer (int32)

file

false

string

host

false

string

path

false

string

port

false

integer (int32)

protocol

false

string

query

false

string

ref

false

string

userInfo

false

string

java.time.LocalDateTime

Name Description Required Schema Default

chronology

false

java.time.chrono.Chronology

dayOfMonth

false

integer (int32)

dayOfWeek

false

enum (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)

dayOfYear

false

integer (int32)

hour

false

integer (int32)

minute

false

integer (int32)

month

false

enum (JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER)

monthValue

false

integer (int32)

nano

false

integer (int32)

second

false

integer (int32)

year

false

integer (int32)

java.time.chrono.Chronology

Name Description Required Schema Default

calendarType

false

string

id

false

string

java.util.HashMapOfstringAndcom.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix$SegmentDeliveryPrefix

java.util.MapOfstringAndjava.util.ListOfcom.harmonicinc.vos.app.monitor.model.AudioProfileStatus

java.util.MapOfstringAndjava.util.ListOfcom.harmonicinc.vos.app.monitor.model.DataProfileStatus

java.util.MapOfstringAndjava.util.ListOfstring

java.util.MapOfstringAndstring