Live Slicer Configuration File Settings
Reference for every setting available in the Live Slicer configuration file, including hashtags.
Configuration File Settings
A brief description is provided below for each setting that may be defined in a Live Slicer's configuration file (i.e., /etc/uplynk.conf).
By default, the value assigned to a setting cannot contain a hashtag. Learn how to override this behavior.
| Setting | Description |
|---|---|
ancillary_lines | SDI (Blackmagic) Only. Defines the ancillary lines that will be scanned (0 to 31). Ignored with ancillary_scan set to on or input set to UDP/RTMP. Syntax ancillary_lines: #, #, ...Example ancillary_lines: 9, 13 |
ancillary_scan | SDI (Blackmagic) Only. Determines whether all ancillary lines will be scanned. Valid values on (scan all) off (scan only defined lines) Syntax ancillary_scan: on/offExample ancillary_scan: off |
api_port | API Defines the port for API calls. Omit IP to bind to any adapter. Default 127.0.0.1:65009Syntax IP Address:Port or Port.Example api_port: 127.0.0.1:65009 |
apikey | Required. Defines the secret API key for authentication. Syntax apikey: API KeyExample apikey: abcDEFghiJKLmnoPQRtuvWXYz123ABCdefGHIJKL |
audio_custom_layout_Track | SDI (Blackmagic) Only. Defines a custom audio channel layout for the {Track} variable.This custom audio channel layout allows audio to be downmixed to mono or stereo. This configuration setting is incompatible with audio_layout. Remove audio_layout from the Live Slicer configuration file prior to including this setting. This parameter does not apply to AC-3 audio or audio transmitted via UDP or RTMP. Although we support up to 31 audio tracks, your SDI capture card can only detect up to 16 audio tracks. Syntax (downmix audio to mono) audio_custom_layout_{Track}: mono|X=SDI Input Channel@LevelSyntax (downmix audio to stereo) audio_custom_layout_Track: stereo|L=SDI Input Channel@Level,R=SDI Input Channel@LevelSyntax (downmix audio to 5.1) audio_custom_layout_{Track}: 5.1|C=SDI Input Channel@Level,L=SDI Input Channel@Level,R=SDI Input Channel@Level,LR=SDI Input Channel@Level,RR=SDI Input Channel@Level,LFE=SDI Input Channel@LevelExample audio_custom_layout_0: stereo|L=0@707&2@800,R=4 |
audio_desc_# | Assigns a description to an audio track. Identify the source audio track by specifying its SDI channel or PID within this setting's name. By default, audio tracks are assigned a description of unspecified.Syntax audio_desc_#: Audio Track DescriptionExample audio_desc_12: My Track |
audio_dolby_# | Set to 1 to encode audio as Dolby Digital Plus (DD+). Identify the source audio track by specifying its SDI channel or PID within this setting's name. Syntax audio_dolby_#: 1Example audio_dolby_12: 1 |
audio_lang_PID | UDP and RTMP Only. Assigns a language to the audio track with the PID. Syntax audio_lang_PID: LanguageExample audio_lang_12: en |
audio_layout | SDI (Blackmagic) Only. Defines a standard audio channel layout. This parameter does not apply to AC-3 audio or audio transmitted via UDP. Alternatively, each audio track may be assigned a custom audio layout to downmix audio to mono or stereo. Valid values stereo #, 5.1, CEA, 7.1. Syntax audio_layout: Audio Channel LayoutExample audio_layout: 5.1 |
authenticated_api_port | Advanced. Exposes the authenticated API on a specific port. Syntax (IP address and port) authenticated_api_port: IP Address:Port or PortExample authenticated_api_port: 88 |
autoexpire_age | Determines asset retention time. Valid values 0 (no deletion) or # hours (number of hours that assets will be retained before being deleted). Syntax autoexpire_age: 0/HoursExample autoexpire_age: 24 |
backup | Advanced. Determines whether to store content on alternate cloud storage. Valid values true (The Live Slicer will upload content to an alternate path on an alternate origin storage) or false (The Live Slicer will upload content to the default origin storage.). Syntax backup: true/falseExample backup: false |
blankVideoSampleDelay | Advanced - UDP and RTMP Only. Defines the delay before blank video is inserted. Set this with care. Setting it too low adds unnecessary blank audio/video frames to your stream, while setting it too high impacts time-behind-live performance and slice creation. Default value 9600Valid values 48000 (1 second) or 96000 (2 seconds, recommended). Syntax blankVideoSampleDelay: 48000/96000Example blankVideoSampleDelay: 96000 |
captions_DID | SDI (Blackmagic) Only. Identifies the DID for closed captions. Syntax captions_DID: DIDExample captions_DID: 0x61 |
captions_SDID | SDI (Blackmagic) Only. Identifies the SDID for closed captions. Syntax captions_SDID: SDIDExample captions_SDID: 0x01 |
capture_delay | Determines the delay in seconds for timecode matching. Syntax capture_delay: SecondsExample capture_delay: 5 |
capture_mode | SDI (Blackmagic) Only. Determines the capture mode for Blackmagic DeckLink SDI card. Run the following command to view valid values for this setting: $ uplynk_liveslicer -card CardNumber -listThe recommended value for this setting is auto. This allows the Live Slicer to autodetect the video mode for BlackMagic cards that support signal detection. Syntax capture_mode: ModeExample capture_mode: auto |
card | SDI (Blackmagic) Only. Identifies the card number(s) for Blackmagic DeckLink SDI card(s). Syntax card: Card NumberExample card: 1 |
cc#_desc | Advanced. Defines a description for the closed captioning channel. Syntax cc#_desc: CC Channel DescriptionExample cc1_desc: English |
cc#_lang | Advanced. Identifies the language for the closed captioning channel. Specify a language by its code (e.g., en). Syntax cc#_lang: CC Channel LanguageExample cc1_lang: en |
cc_filter | Advanced. Determines whether closed captions will be filtered. Valid values on (Disables filtering CEA-608/708 captions on all channels with the exception of channel 1) or off (Filters CEA-608/708 captions on all channels) Syntax cc_filter: on/offExample cc_filter: on |
debugoverlay | Advanced. Set to 1 to overlay debug information on the video. Do not use this setting for production traffic. The type of debug information overlaid may vary by Live Slicer version. Example debugoverlay: 1 |
description | Required. Defines a description for new assets. Syntax description: Asset DescriptionExample description: My Live Event |
disable_slicer_config_upload | Determines whether to automatically upload configuration files. The Live Slicer excludes sensitive data when uploading your configuration file. Specifically, the uploaded configuration file will exclude the username and apikey settings. Valid values yes (The Live Slicer will not upload your configuration file) or no (Default. Allows the Live Slicer to automatically upload your configuration file to our service) Example disable_slicer_config_upload: yes |
drm_mode | Determines the security level for CMS assets. Once Studio DRM is activated on your account, Studio DRM encryption is automatically applied to all new assets. This setting does not alter this behavior. It determines whether Studio DRM will be enforced and whether playback URLs must be signed. Syntax -drm_mode ModeValid values none, regular (signed playback URL), studio (signed playback URL and Studio DRM) Example -drm_mode: studio |
drop_expired_breaks | Determines how expired API requests are handled. Valid values on (ignore) or off (perform action defined within an API request once it has been retained for the duration defined within the future_break_expiration_minutes setting, regardless of whether the specified timecode has elapsed). Example drop_expired_breaks: on |
enable_dyn_gain | Enables dynamic gain adjustment of output audio with a less CPU-intensive, but less precise algorithm than using enable_loudnorm.Syntax enable_dyn_gain: 1Example enable_dyn_gain: 1 |
enable_loudnorm | Enables loudness normalization per EBU R 128 and takes precedence over enable_dyn_gain if both enabled.Syntax enable_loudnorm: 1Example enable_loudnorm: 1 |
enable_remote_config | Set to 1 to allow reporting health status according to the criteria defined within a failover group. This setting may override settings that precede it in the configuration file. Define this setting after the failover_id setting.Valid values 0 or 1 Example enable_remote_config: 1 |
enable_rtmp_pull | RTMP Only. Determines if RTMP feed can be pulled. Valid values yes (Allows the Live Slicer to pull the RTMP feed) or no (Live Slicer will not pull RTMP feeds. Your encoder must push the RTMP feed to the Live Slicer) Example enable_rtmp_pull: yes |
expect_audio_input | Requires version 250516.01.01 or higher. This is used to reserve audio channels in a streaming manifest in case the Slicer is started and these audio channels are not present at the time of the stream start. There can be multiples of these in a Slicer configuration file. expect_audio_input is intended to replace the audio_lang<pid>, audio_desc<pid>, audio_dolby<pid>, and audio_ac3_pass_through<pid> options.expect_audio_input also makes the pids: option unnecessary - both are supported but should not be used together.This parameter takes a JSON as its input: {"lang": <string>, "desc": <string>, "dolby": <bool>, "ac3_pass_through": <bool>, "pid": <int>}with schema members: - lang: Override for language similar to audio_lang_<pid> usage- desc: Override for description similar to audio_desc_<pid> usage- dolby: Override for Dolby encoding similar to audio_dolby_<pid> usage- ac3_pass_through: Override for AC-3 passthrough similar to audio_ac3_pass_through_<pid>- pid: Tie this input to a particular Audio PIDAll members are optional with the default values being empty string, false, and -1 for pid.Example expect_audio_input: {"lang": "en", "desc": "no-such-track"} # second audio PID != 52, output as AAC, with specified language and description |
expect_audio_inputs | Requires version 250516.01.01 or higher. This is expected to replace multiple expect_audio_input configuration parameters as a single-line.When expect_audio_inputs is used, it is a comma-separated list of expect_audio_input objects with the list being contained in square brackets.Example expect_audio_inputs:[{"lang": "en", "dolby": true}, {"lang": "es"}] |
failover_id | Assigns a failover group to the Live Slicer. Live Slicer failover also requires that you add this Live Slicer to the failover group identified by this setting. Syntax failover_id: IDExample failover_id: 1232b8646dea4cd0a48f5e0ffaa4f8c7 |
future_break_expiration_minutes | Determines the number of minutes that the Live Slicer will retain an API request for a scheduled break before flagging it as eligible for expiration. The drop_expired_breaks setting determines how the Live Slicer handles expired API requests. Syntax future_break_expiration_minutes: {Minutes}Example future_break_expiration_minutes: 50 |
future_timecodes | Determines whether timecodes up to 12 hours in the future can be resolved. Valid values on (Allows timecodes up to 12 hours in the future) or off (Default. Requires the Live Slicer to resolve timecodes within the capture delay buffer) Example future_timecodes: on |
gain | Adjusts audio gain in decibels. Positive values increase gain, negative decrease. Syntax gain: GainExample gain: 5.0 |
handle_pmt_changes | Requires version 250516.01.01 or higher. Set to yes with progID specified to automatically adapt to audio channels using the PMT. When progID is used, this is enabled by default.Since HLS audio tracks cannot be added after stream start, if audio tracks are expected to appear after stream start, the expect_audio_input or expect_audio_inputs parameters should be used in conjunction with this one. When set to no, restores the previous Slicer behavior where it would shutdown if it lost audio or video input due to a PID change in the PMT.Example use_all_audio_tracks: yes |
hwdec | Set to 1 to use hardware accelerated decoder (GPU), if available, to decode the incoming video signal. |
hwenc | Set to 1 to use hardware accelerated encoder (GPU), if available. This overrides the encoding profile's "GPU Encoding" setting for only the live slicer. |
input | Determines the signal's input source. Valid values blackmagic (Indicates that the source is a Blackmagic DeckLink SDI card), rtmp (Indicates that the source is the RTMP stream identified by the rtmp_url parameter. The RTMP source is incompatible with SCTE, ad breaks, or Action Message Format (AMF).), srt (Indicates that the source is a SRT MPEG2 transport stream. This stream must originate from the IP address defined within the input_addr setting.), tcp (Indicates that the source is a TCP MPEG2 transport stream. This stream must originate from the IP address defined within the input_addr setting.), udp (Indicates that the source is a UDP unicast or multicast MPEG2 transport stream).Syntax input: blackmagic/rtmp/srt/tcp/udp.Example input: udp |
input_addr | SRT and TCP. Defines the IP address for feed ingestion. Syntax input_addr: IP Address.Example input_addr: 192.0.2.1 |
livepreview_max_viewers | Determines max simultaneous viewers for Live Events Dashboard's Slicer Live Preview. Each instance of a live preview consumes resources on the computer hosting the Live Slicer. This setting prevents performance issues by capping the number of simultaneous connections. Default value 10Example livepreview_max_viewers: 10 |
livepreview_with_audio | Enables audio for Live Events Dashboard's Slicer Live Preview. Valid values on or off Example livepreview_with_audio: on |
meta | Defines metadata for assets. Add this setting for each desired metadata field. Each instance of this setting should be specified on a separate line. Syntax meta: Field=ValueExample meta: My Field A=Value Ameta: My Field B=Value B |
multicast | UDP Only. Defines the IP address of the computer generating the UDP multicast stream. This setting must be defined when the signal's input source is a UDP multicast MPEG2 transport stream. Syntax multicast: IP AddressExample multicast: 100.100.55.22 |
nielsen | Advanced. Set to 1 to scan for Nielsen audio watermarks. DASH Streaming Only: Also set the nielsen customization parameter within the playback URL.Example nielsen: 1 |
nielsen_ad_mode | Advanced. Defines Nielsen breakout code. Default value 00Syntax nielsen_ad_mode: 00/03/07/09Example nielsen_ad_mode: 00 |
nielsen_distributor | Advanced. Defines Nielsen distributor for watermarks and ID3 tags. Default value www.uplynk.comSyntax nielsen_distributor: Distributor IDExample nielsen_distributor: www.example.com |
no_signal_image | Advanced - UDP and RTMP Only. Identifies an image to display when the signal is lost and black video is streamed. The no_signal_pad setting determines whether black or green video is streamed when the signal is lost.Syntax no_signal_image: FilenameExample no_signal_image: lostsignal.png |
no_signal_pad | Advanced - UDP Only. Defines time in seconds for solid black video when the signal is lost. Syntax no_signal_pad: SecondsExample no_signal_pad: 30 |
no_signal_shutdown_time | Advanced - UDP Only. Determines time in seconds before the Live Slicer shuts down after signal loss. Syntax no_signal_shutdown_time: Seconds |
parse_XDS | Advanced. By default, uses XDS data to update asset's title and rating information. Disable with parse_XDS: no. |
pids | UDP and RTMP Only. Identifies the set of audio/video tracks that will be consumed by the Live Slicer. Configure this setting to a comma-separated list of PIDs that correspond to the desired audio/video tracks. All other audio/video tracks will be ignored. By default, the Live Slicer will consume the first audio/video track when a progID and PIDs have not been specified. Syntax pids: PID 1, PID 2, PID nExample pids: 12, 14, 16 |
port | Required for UDP. Identifies the UDP port. Syntax port: PortExample port: 1234 |
preview | Determines if the Live Events Dashboard's Slicer Live Preview will display a video preview. If the livepreview_with_audio setting is not enabled, then this preview will only consist of video. Valid values are on or off. |
progID | UDP Only. Identifies the program in a multi-program transport stream. Configure this setting to the ID of the desired program. If the pids setting has not been defined, then all audio tracks in the program will be consumed. By default, the Live Slicer will consume the first audio/video track when a progID and PIDs have not been specified.Syntax progID: Program IDExample progID: 128 |
render_608 | Converts CEA-608/708 channels to WebVTT. Example render_608: cc1,cc2,cc3,cc4 |
render_608_buffer | Determines the maximum buffer duration, in seconds, for rendering captions to video. Raw video frames will be buffered for the specified duration and is therefore memory intensive. We strongly discourage a buffer size greater than 5 seconds. This buffer is only relevant for pop-on captions. Roll-up and paint-on captions are rendered immediately and do not require a buffer. Syntax render_608_buffer: {Seconds}Example render_608_buffer: 2 |
render_teletext | Converts DVB teletext pages to WebVTT. Use this parameter to assign a language track to a DVB teletext page number. Use a comma to delimit multiple DVB teletext configurations. Syntax render_teletext {Page Number 1}:{Language 1},{Page Number 2}:{Language 2},{Page Number n}:{Language n}Example Converts English DVB teletext from page 888, Italian DVB teletext from page 887, and Russian DVB teletext from page 886: render_teletext 888:eng,887:it,886:ru |
rgb_lut | Customizes color representation conversion. Syntax (Simple) rgb_lut from {Color Standard},{Range} to {Color Standard},{Range} /{Absolute Path}/{Cube File Name}Syntax (Extended) rgb_lut from colorspace:{Color Space},primaries:{RGB Primaries},trc:{Transformation Characteristics},range:{Range} to colorspace:{Color Space},primaries:{RGB Primaries},trc:{Transformation Characteristics},range:{Range} /{Absolute Path}/{Cube File Name}Example (simple) rgb_lut from hlg to hdr10,full /path/mylut.cube |
rtmp_url | RTMP Only. Identifies the RTMP stream URL. The enable_rtmp_pull setting determines whether the Live Slicer may pull the RTMP stream instead of monitoring this URL for a stream pushed by your encoder.Example rtmp://example.com:1935/live/mystream |
rtp_backlog_dur | RTP Only. Determines the seconds for packet history preservation. Syntax rtp_backlog_dur: {Seconds}.{Deciseconds}Recommended Configuration rtp_backlog_dur: 1.4 |
rtp_headers | Determines RTP usage when streaming over UDP. Valid values are 0 (off) and 1 (on).Example rtp_headers: 1 |
rtp_readahead_dur | RTP Only. Balance stream latency with tolerance to disordered packets and forward error correction (FEC) latency when configuring this setting. Set it higher than the average value reported by the skew_sec statistic reported by the Status endpoint of the Live Slicer API.Syntax rtp_readahead_dur: {Seconds}.{Deciseconds}Default Configuration rtp_readahead_dur: 2.0 |
rtp_redundant_feed | RTP Only. Identifies the URL to a backup SMPTE 2022-compliant RTP feed through which the original stream will be reconstructed. Packets missing from one feed will be taken from the other feed. A redundant RTP feed requires the source computer to have two network routes (e.g., 2-port network card). Syntax rtp_redundant_feed: rtp://{hostname}:{port}Example rtp_redundant_feed: rtp://stream.example.com:1234 |
scte_module | Identifies the SCTE plugin for SCTE 35/104 signal processing. This parameter requires scte_type to be set to python. You may omit the absolute path to the desired Python file and its file name extension when it resides in the "plugins" subfolder of your Live Slicer's installation directory. Valid values are scte_baseline or Python file path.Python Syntax (default path) scte_module: {File Name without Extension}Example scte_module: my_scte_pluginSyntax (custom path) scte_module: /{Absolute Path}/{File Name}Example /Users/joe/plugins/my_scte_plugin.pyLearn more. |
scte_python_version | Determines the Python version. Valid values are 2.7, 3.6, 3.6m.Default Configuration scte_python_version: 2.7 |
scte_type | Determines how SCTE 35/104 signals are processed. Valid values are none (Disables SCTE 35/104 signal processing) or python (Allows SCTE 35/104 signal processing. The scte_module parameter determines the SCTE plugin that will process your SCTE 35/104 signal). |
SCTE104_DID | SDI (Blackmagic) Only. Defines the DID for SCTE104 triggers. Syntax SCTE104_DID: DIDExample SCTE104_DID: 0x41 |
SCTE104_SDID | SDI (Blackmagic) Only. Defines the SDID for SCTE104 triggers. Syntax SCTE104_SDID: SDIDExample SCTE104_SDID: 0x07 |
slicerID | Required. Assigns a unique ID to a Live Slicer. Use this ID to identify this Live Slicer when setting up a live channel or a live event. Syntax slicerID: Live Slicer IDExample slicerID: SportsFeed1 |
ssl_port | Exposes the authenticated API over SSL/TLS. Use this parameter to allow the Live Slicer to communicate with the Live Events Dashboard without causing mixed content blocking. Syntax ssl_port: IP Address:Port or ssl_port: Port.Example ssl_port: 443 |
start_blackout | Advanced. Determines if the Live Slicer will start in blackout mode. Valid values are yes (Indicates that the Live Slicer will start in blackout mode) or sticky (Indicates that the Live Slicer will resume its previous mode upon being started. For example, if a Live Slicer was stopped in blackout mode, then it will resume blackout mode the next time that it is started.).Syntax start_blackout: yes/stickyExample start_blackout: sticky |
target_loudness | Target loudness when enable_loudnorm or enable_dyn_gain is enabled. Ads are encoded in real-time at the same loudness as the content.Syntax target_loudness: <LUFS>Example target_loudness: -24 |
thumbnail | Adds a thumbnail with specified dimensions. A default thumbnail will be created regardless of whether this option is passed. The upper-bound for a thumbnail's dimensions is determined by the specified width and height. The thumbnail will fit within the specified dimensions while maintaining the source video's aspect ratio. A thumbnail's maximum size cannot exceed any of the following dimensions: your source video's resolution, your encoding profile's maximum resolution, or 1280x720 / 720x1280. Add this setting for each desired thumbnail size. Each instance should be specified on a separate line. Generating additional thumbnails may incur additional storage costs. Syntax thumbnail: Prefix=WidthxHeightExample thumbnail: tiny=150x150thumbnail: small=200x200 |
timecard | Advanced - SDI (Blackmagic) Only. Determines whether the Live Slicer will load a dynamic library (i.e., libuplynk_timecode.so) that facilitates the integration of an external timecode generator. Enable this capability by configuring this setting to true.Example timecard: true |
timecode | Advanced. Adds an ID3 tag that defines the time for pic_timing data. Syntax timecode: hh:mm:ss:ffExample timecode: 11:22:11:03 |
unicast | UDP Only. Defines the IP address for UDP unicast stream. This setting must be defined when the signal's input source is a UDP unicast MPEG2 transport stream. Syntax unicast: IP AddressExample unicast: 100.100.55.22 |
upscale | Set to yes to upscale video feed to the highest quality. Your content's frame rate is independent of resolution, so upscaling will not affect frame rate. Ads are always upscaled regardless of this setting.Example upscale: yes |
use_all_audio_tracks | Requires version 240825.02.01 or higher. Set to yes with progID specified to automatically include all audio tracks sorted by PID. When progID is used, this is enabled by default.Example use_all_audio_tracks: yes |
username | Required. Identifier used for authentication. You may specify either: A workspace ID (formerly known as owner ID) - preferred, or A user name (typically the email address associated with your account) Using a workspace ID is recommended because it is immutable, whereas user names and email addresses may change over time. Example (workspace ID - preferred) username: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6Example (email) username: [email protected] |
useSystemClockAsTimecode | UDP (including RTP) and RTMP: Set to 1 to enable start_timecode parameter support. |
verbosity | Sets log data verbosity level. Valid values are 1 (default. Logs error conditions and informational messages) or 3 (Logs error conditions, informational messages, and debug messages).Positive Values: The video will be forced ahead of the audio by the specified amount of time. Negative Values: The video will be forced behind the audio. Syntax verbosity: LevelExample verbosity: 3 |
video_sync_ms | Advanced - SDI (Blackmagic) Only. Sets audio/video sync offset in milliseconds. Syntax video_sync_ms: MillisecondsExample video_sync_ms: 55 |
wallclock | Advanced. Adds an ID3 tag based on timestamp to each slice. This setting relies on the system time of the computer hosting the Live Slicer. Example wallclock: true |
Hashtags
By default, the hashtag symbol (i.e., #) indicates the start of a comment in a configuration file. Override this behavior by renaming the desired setting as indicated below.
verbatim_Setting
Please remove comments from settings to which the above workaround has been applied.
Most settings only support predefined values or integers. Do not apply this override procedure to those settings.
Example
In this example, the description setting is set to Live Capture and a brief description of this setting appears directly to the right of the hashtag symbol.
description: Live Capture # A description that will be assigned to new assets.
...In order to set the description setting to a value that contains a hashtag, modify its name to include the prefix verbatim_ and remove the comment from that line.
verbatim_description: #1 Videos by Genre
...The above configuration sets the verbatim_description setting to #1 Videos by Genre.
Updated about 1 hour ago