Select SDK

Archived

Schemas

Segment JSON schema

scripts.json

The definition of CueVoice for launching or stopping the segment.
The script.json is required if the segment can be launched as the type of Full. It is not required if the segment is only launched as the type of Simple. 
{
  "segmentStart": scripts (required),
  "segmentEnd": scripts (required)
}

Example

Properties

"segmentStart"

Specifies the name of the sound file that contains the CueVoice or the string for generating a TTS cueVoice when the launch type is Full.
To have random variation for the cueVoice, you can have several sound files with the same name but different numbers amended to the name, like @{CUEVOICE-<NUMBER>}
Similarly, you can also specify a string that is defined in string.json for generating TTS. Sound file reference is expected by default. If there is not sound file existing, strings for TTS will be used instead. If the value of the string is null, nothing is played and spoken.

"segmentEnd"

Specifies the name of the sound file that contains the CueVoice or the string for generating a TTS when the Segment is stopped and the launch type is Full. The format specification is same as segmentStart.

Sub Schemas

The schema defines the following additional types:

scripts (object)

Reference to the sound file of CueVoice. 
{
  "common": string (required),
  ANY: string
}

Properties

"common"

The sub key which is mandatory. It is used as default if the cueVoice is not specified in the LaunchRule.json file when a segment is started by a worker or a launch rule.

ANY

The custom CueVoice. A developer can add any sub keys other than 'common' for CueVoice which can be used in a launch request from LaunchRules.json