Playout (Actions)

The information is relevant for version 2.9.34 and later.

Description of Playout Actions.

Set video stream

Switches the signal source or file source to the module input. Parameters

Param1 - input stream type.

FILE - file source.

LIVE - signal from the software module.

URL - external source signal, for example, IP stream.

Param2 - file name, software module name, or stream URL.

Param3 - additional parameter, STILL flag. Enables output of the first frame of the sent signal (the frame will be deinterlaced). To set the flag, specify ON, YES, TRUE or 1. Provides file preview for the PVW output.

Set format conversion

Sets the video conversion mode upon a mismatch of the input signal Aspect Ratio and the module settings. Parameters

Param1 - conversion mode. Possible values: scale, crop, box, letter.

Param2 - AFD use flag. Possible values: true or false.

Set format

Sets the module output signal Aspect Ratio. Parameters

Param1 - Aspect Ratio. Possible values: 4:3 or 16:9.

Set Output AFD

Sets the AFD output value override. Parameters

Param1 - output value code:

FF,

4x3B,

16x9B,

14×9,

4x3SP14x9,

16x9SP14x9,

16x9SP4x3,

NONE or empty value for Auto

Set Audio Language

Parameters

Param1 - language code identifier in the ISO-639-2 or “und” formats to set the default value.

Param2 - additional parameter. Language track ID.

Set audio gain

Sets the level of audio gain for the output signal. 2.0 = +6dB, 0.5 = -6dB. Parameters

Param1 - gain level. Possible values: 2.0 = +6dB, 0.5 = -6dB.

Set Subtitle Language

Sets the subtitle track language. Parameters

Param1 - define the language. Possible values:

LCID - language code identifier in the ISO-639-2 format.

NONE - language not set.

empty value - leave the current value unchanged.

Param2 - additional parameter. Subtitle track ID.

Param3 - additional parameter. Subtitle track protocol. Possible values:

open

closed

dvb

Play Subtitle

Command to play the subtitle file. Parameters

Param1 - subtitle file name.

Param2 - additional parameter. Subtitle stream id.

Param3 - additional parameter. Defines the subtitle language. Possible values:

LCID - language code identifier in the ISO-639-2 format.

NONE - language not set.

empty value - leave the current value unchanged.

Param4 - Additional parameter, IN point. Possible values: time code in the hh:mm:ss[:ff] format, or the number of frames.

Param5 - Additional parameter. Offset from the IN point. Possible values: time code in the hh:mm:ss[:ff] format, or the number of frames.

Param6 - Additional parameters. Subtitle track protocol. Possible values:

open

closed

dvb

Set Open Captions Stream

Sets the current caption stream to be displayed. Parameters

Param1 - caption stream number or 0 to disable caption output.

Enable Caption Formatting Override

Deletes caption formatting and uses default values. Parameters No parameters.

Disable Caption Formatting Override

Saves caption formatting and uses it, if present. Parameters No parameters.

Graphics action

Allows executing graphics API commands for graphic compositions played by the module. For example, hide or show elements inside the graphic composition. Parameters

Param1 - graphics API command. For example, object_show.

Param2 - name of the object inside the graphic composition. For example, TextObject1.

Param3 - Graphics API Param1 parameter for the Param1 command (if needed). For example, object_show takes 3 additional parameters.

Param4 - Graphics API Param2 parameter for the Param1 command (if needed).

Param5 - Graphics API Param3 parameter for the Param1 command (if needed).

Param6 - Graphics API Param4 parameter for the Param1 command (if needed).

Param7 - Graphics API Param5 parameter for the Param1 command (if needed).

Param8 - Graphics API Param6 parameter for the Param1 command (if needed).

Param9 - Graphics API Param7 parameter for the Param1 command (if needed).

Param10 - Graphics API Param8 parameter for the Param1 command (if needed).

Enable DRC

Enables Audio DR (Dynamic Range Compression) to normalize the output audio signal level. DRC settings are configured in the module’s settings in the control panel. Parameters No parameters.

Disable DRC

Disables Audio DRC. Parameters No parameters.

Enable EBU-R128 Loudness

Enables EBU-R128 Loudness to normalize the output audio signal level. EBU-R128 parameters are configured in the module’s settings in the control panel. Parameters No parameters.

Disable EBU-R128 Loudness

Disables EBU-R128 Loudness. Parameters No parameters.

EBU-R128 Loudness Preset

Allows you to install a preset with EBU-R128 Loudness settings. Switching happens in real time with no reboots or flash frames. Preset parameters are specified in the module’s settings in the control panel. This may be used, for instance, when live broadcasts require settings different from those for broadcasting from files. Parameters

Param1 - installed preset number from 1 to 4

Connect hardware

Sends the command to connect to the I/O board. Parameters No parameters.

Disconnect hardware

Sends the command to disconnect from the I/O board. Parameters No parameters.

Set Sync Mode

Controls the mode of inter-module frame synchronization. Parameters

Param1 - selecting the synchronization mode:

Master - only one “Source→Playout” mapping can operate in this mode. If several Playout modules need to be connected to the same source, the remaining modules need to be set to other synchronization modes: Slave or FreeRun.

Slave

FreeRun

Add Action Handler

Registers a new handler for Internal Actions in the system. Parameters Takes five parameters.

Delete Action Handler

Deletes the Internal Actions handler. Parameters

Param1 - name of the deleted handler.

Enable WSS

Enables output of the WSS signal to the output signal. Added in 2.2.8. Parameters No parameters.

Disable WSS

Disables output of the WSS signal. Added in 2.2.8. Parameters No parameters.

Show logo

Enables displaying the graphic layer with the logo. Parameters No parameters.

Hide logo

Disables displaying the graphic layer with the logo. Parameters No parameters.

Set logo

Sets the playback source in the logo layer. Parameters

Param1 - source type

FILE

LIVE

URL

PRESET

NONE

Param2 - source (file, preset, module) name.

Preset logo

Controls whether to set or reset presets for the logo layer. Parameters

Param1 - preset’s name.

Param2 - preset’s source URL

Param3 - the parameter controls changing the active preset. If the preset is in use:

0, false or no - do not apply changes.

1, true or yes - apply changes.

Set Source

Assigns a signal source for the service. Parameters

Param1 - string with a new signal source. The string is specified in the ‘’shm_pal://SERVICE’’ format. For example, ‘’shm_pal://Capture_1’’

Set Encoder Bitrate

Sets the encoding speed. Parameters

Param1 - new bitrate in kbps.

Param2 - new VBV-buffer size in kbps.

Set Transrate

With Dynamic Bitrate and Transrate enabled, the output stream will be a result of two-pass encoding. This is used for statistical multiplexing in Encoder groups in Ezmuxer. Parameters

Param1 - controls option activation:

0, false or no - disables transrating.

1, true or yes - enables transrating.

Live CC On

Enables the closed captioning mode of the output stream live (Live CC). The interface for manual subtitling opens from the Status tab of the control panel. Using Actions for text output is possible. Parameters

Param1 - selecting the CC output stream: 1 or 2.

Live CC Off

Disables closed captioning of the output stream live. Parameters

Param1 - selecting the CC output stream: 1 or 2.

Live CC Set Params

Sets parameters for closed captioning of the output stream live. Parameters

Param1 - selecting the CC output stream: 1 or 2.

Param2 - the number of strings: 2, 3 or 4.

Param3 - base line: from 1 to 15.

Param4 - identation: 0, 4, 8, 12, 16, 20, 24 or 28.

Live CC Append

Adds text to the Live CC output stream. Parameters

Param1 - selecting the CC output stream: 1 or 2.

Param2 - text to output

SCTE-104 Splice Request

Inserts the SCTE-104 Splice Request command into the output stream. Parameters

Param1 - AS_Index - possible value: 0-255. 0 - AS_Index is not required.

Param2 - DPI_PID_index - possible value: 0-65535. 0 - DPI_PID_Index is not required.

Param3 - splice_insert_type

0 - reserved,

1 - spliceStart_normal,

2 - spliceStart_immediate,

3 - spliceEnd_normal,

4 - spliceEnd_immediate,

5 - splice_cacel

Param4 - splice_event_id - 32bit Integer value. Leave blank for auto generation.

Param5 - unique_program_id - possible value: 0-65535.

Param6 - pre_roll_time - value in milliseconds.

Param7 - break_duration - value in tenths of a second. Leave blank if unknown or not required.

Param8 - avail_num - possible value: 0-255. Identifies the ad slot within the program. Leave 0, if not used.

Param9 - avails_expected - possible value: 0-255. The number of expected free slots within the current viewing event. Leave 0, if avail_num is not used.

Param10 - auto_return_flag - Auto-return flag:

0 - no auto-return is required,

1 - auto-return is required, if the break_duration field is filled.