Avail Configuration
availSettings
Ad avail settings.Type: AvailSettings (p. 71) Required: False
AvailSettings
Avail Settings
scte35TimeSignalApos
Type: Scte35TimeSignalApos (p. 192) Required: False
scte35SpliceInsert
Type: Scte35SpliceInsert (p. 191)
Required: False
BadGatewayException
message
Type: string Required: FalseBlackoutSlate
Blackout Slate
state
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
Type: BlackoutSlateState (p. 73) Required: False
blackoutSlateImage
Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
Type: InputLocation (p. 149) Required: False
networkEndBlackout
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.
The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The
Network End and Network Start descriptors must contain a network ID that matches the value entered in
"Network ID".
Type: BlackoutSlateNetworkEndBlackout (p. 73) Required: False
networkId
Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
Type: string Required: False MinLength: 34 MaxLength: 34
networkEndBlackoutImage
Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
Type: InputLocation (p. 149) Required: False
BlackoutSlateNetworkEndBlackout
Blackout Slate Network End Blackout DISABLED
ENABLED
BlackoutSlateState
Blackout Slate State DISABLED ENABLED
BurnInAlignment
Burn In Alignment CENTERED LEFT SMART
BurnInBackgroundColor
Burn In Background Color BLACK
NONE WHITE
BurnInDestinationSettings
Burn In Destination Settings
font
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
Type: InputLocation (p. 149) Required: False
fontSize
When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
Type: string Required: False
fontResolution
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 96 Maximum: 600
alignment
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-left-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
Type: BurnInAlignment (p. 73) Required: False
xPosition
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0
yPosition
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0
teletextGridControl
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
Type: BurnInTeletextGridControl (p. 77) Required: False
fontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
Type: BurnInFontColor (p. 76) Required: False
fontOpacity
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0 Maximum: 255
backgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
Type: BurnInBackgroundColor (p. 73) Required: False
backgroundOpacity
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this
parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0 Maximum: 255
outlineSize
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/
embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0 Maximum: 10
outlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
Type: BurnInOutlineColor (p. 76) Required: False
shadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
Type: BurnInShadowColor (p. 77) Required: False
shadowOpacity
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Type: integer Required: False Minimum: 0 Maximum: 255