User Guides
Start typing to search…

Slicer Configuration Settings


SettingDescriptionExample
allow_inlineDirectory Monitoring
Determines whether the source media's file name may contain configuration settings. Learn more.

Valid values are:
  • 1 | true: Indicates that the file name may contain configuration settings.
  • 0 | false: Indicates that settings defined within the file name will be ignored.
Default value: 1		allow_inline = 0
apikey (Required)Authorization
Sets the secret API key through which Slicebot authenticates to the CMS.

Note: Bypass this requirement by setting the SLICER_USER and SLICER_APIKEY environment variables.

This API key should correspond to the user defined by the username setting.

Find API keys via Settings > Integration Keys > API Keys on the Integration Keys page.

Syntax: apikey = APIKey		apikey = abcdefg...
auto_replaceAsset Replacement (Library)
Determines whether asset(s) with the same external ID will be automatically replaced.

Valid values are:
  • 1 | true: Ensures that the external ID assigned to an asset starts with _replace. This will cause it to replace existing assets with the same external ID.
  • 0 | false: Indicates that the external ID assigned to an asset will not be modified.
auto_replace = 1
autoexpireAsset Retention (Library)
Marks an asset for deletion once the specified number of hours have elapsed.

The sample configuration will delete assets 48 hours after they have been encoded.		autoexpire = 48
breaksBreaks (Asset)
Inserts ad breaks or boundary breaks at specified time ranges.

Syntax: -break <start>[-<stop>][,...]
  • Times are in decimal seconds
  • Multiple breaks separated by commas
  • Unlabeled breaks are ad breaks (original content removed)
  • Labeled breaks (label:<start>-<stop>) are boundary breaks (content preserved)
breaks=10.1-30.58,105-151.332 - Two ad breaks with content removed.
breaks=ad1:10.1-20,30.3-40,promo:60-70 - Two boundary breaks (ad1, promo) and one ad break (30.3-40).
bugAsset
Overlays an image on the video at the specified start time for the given duration.

Key information:
  • Only RGBA PNG images may be overlaid onto video.
  • The overlay respects the PNG's transparency.
  • The PNG image should match the source video's resolution.
  • Start time and duration are specified in milliseconds.
  • Use a negative start time to count from the end of the asset (e.g., -5000 starts 5 seconds before the end).
  • Specify multiple overlays by using three commas as a delimiter.
  • If multiple images overlap, Z-order is determined by their listed order (later entries are on top).
Syntax: bug = PNGFile,StartTime,Duration

The sample adds overlay1.png at the start for 5s and overlay2.png five seconds before the end; overlapping favors overlay2.png on top.		bug = overlay1.png,0,5000,,,overlay2.png,-5000,5000
descriptionAsset (Library)
Assigns a name to the asset generated from the source media. Typically used in file-specific configurations. By default, assets are named after the source media's file name.		description = Marketing Event 2016
done_directoryPost-Processing
Defines the directory to which the source media will be moved after it has been successfully processed.

Key information:
  • If the specified directory does not exist, it will be created.
  • After successful processing, the source media will be deleted if either:
    • This setting has not been defined, or
    • This setting is set to none.
Syntax: done_directory = none		done_directory = ~/media/success
done_emailsNotifications
Comma-separated list of email addresses to notify when a file is successfully processed. Requires mail_host.		done_emails = [email protected], [email protected]
done_urlNotifications
Defines the URL to which an HTTP POST request is submitted when a file is successfully processed. Learn more.		done_url = http://myserver.net/myservice
enc_waitSlicebot
Determines whether Slicebot waits for cloud encoding to finish before processing the next file.

Valid values are:
  • 1: Wait until encoding completes.
  • 0: Move on after slicing completes.
Default value: 0		enc_wait = 1
external_idAsset (Library)
Assigns an external ID to the generated asset. By default, duplicate external IDs are allowed. Prefix an ID with _replace: to replace existing assets with the same ID.		external_id = ep20115e_12
external_id = _replace:ep20115e_12
fadeAsset
Fades audio and/or video in/out from the specified start time.

Key information:
  • Method: in or out
  • MediaType: audio, video, or both
  • Start time and duration are in milliseconds.
  • Negative start times are from the end (e.g., -5000).
  • Specify multiple fades using three commas as a delimiter.
Syntax: fade = Method,MediaType,StartTime,Duration		fade = in,both,0,5000,,,out,both,-5000,5000
fail_directoryPost-Processing
Directory to move source media to when processing fails.

Key information:
  • If the directory does not exist, it will be created.
  • After all attempts fail, the source media will be deleted if either:
    • This setting has not been defined, or
    • This setting is set to none.
Syntax: fail_directory = none		fail_directory = ~/media/failure
fail_emailsNotifications
Comma-separated emails to notify when a file is unsuccessfully processed. Requires mail_host.		fail_emails = [email protected]
fail_urlNotifications
URL to which an HTTP POST is submitted when a file is unsuccessfully processed. Learn more.		fail_url = http://myserver.net/myservice2?status=fail
force_aspect_ratioAsset
Forces the video to the specified aspect ratio.

Syntax: force_aspect_ratio = WidthRatio:HeightRatio		force_aspect_ratio = 16:9
halt_on_errorSource Media Processing
Determines whether processing stops when an issue occurs. Only valid in the main configuration file.

Valid values are:
  • 1 | true: Stop when a job fails due to a source media or configuration issue.
  • 0 | false: Always continue to the next job.
Default value: 0		halt_on_error = 1
helper_noextDirectory Monitoring
Determines whether supporting files must exclude the source media's file extension.

Valid values are:
  • 1 | true: Supporting file name excludes the source media's extension.
  • 0 | false: Supporting file name includes the source media's extension.
Example (when 1 | true):
  • Source: marketing.mp4
  • Config: marketing.cfg
Example (when 0 | false):
  • Source: marketing.mp4
  • Config: marketing.mp4.cfg
helper_noext = 1
ignoreConfiguration File
Determines whether a directory will be monitored for new files. Define only under a directory-specific section in the main configuration file.

Valid values are:
  • 1 | true: Do not monitor this directory.
  • 0 | false: Monitor this directory.
ignore = 1
ignoreNameDirectory Monitoring
Ignore files in a monitored directory with the specified file name(s).

Key information:
  • File names are case-insensitive.
  • Specify multiple files with commas.
ignoreName = thumbs.db,.DS_Store
ignoreSuffixDirectory Monitoring
Ignore files in a monitored directory with the specified file extension(s).

Key information:
  • Extensions are case-insensitive.
  • Specify multiple extensions with commas.
ignoreSuffix = db,txt,jpg
librariesAsset (Library)
Adds an asset to one or more shared libraries.

Key information:
  • A library may be specified by name or GUID.
  • Library names must be an exact, case-sensitive match.
  • Add multiple libraries using commas.
Add by name: libraries = LibraryName
Add by GUID: libraries = LibraryGUID
Add multiple: libraries = Library1,Library2,LibraryN		libraries = 357...,8b0...
mail_fromNotifications
Sender email address for notifications.		mail_from = [email protected]
mail_hostNotifications
Hostname for the mail server used to send notifications. A port may be appended.
  • 25: Standard email
  • 587: Secure email
If the server requires auth, define mail_username and mail_password.

Syntax: mail_host = Hostname:Port		mail_host = smtp.company.com:587
mail_passwordNotifications
Password for the user defined by mail_username. Required only if the mail server requires auth.		mail_password = G183hIU39331f
mail_usernameNotifications
User account on the mail server used to send notifications. Required only if the mail server requires auth.		mail_username = [email protected]
max_slicesSlicing
Limits the number of temporal slices generated from the source media.

Key information:
  • By default, the entire file is sliced (no limit).
  • Useful for troubleshooting or slicing short segments.
  • This is an approximate limit; the Slicer may produce a few additional slices.
max_slices = 20
metaAsset (Library)
Adds metadata to the asset.

Key information:
  • Field names must be unique; use lowercase letters, digits, and underscores.
  • Enclose values containing spaces in quotes.
  • Assign multiple fields using three commas as a delimiter.
Syntax: meta = Field=Value

Alternatively, assign metadata via a JSON file. Learn more.		meta = rating=TV-13
meta = rating=TV-13,,,air_date=20160105
meta_intAsset (Library)
Adds integer metadata to the asset.

Key information:
  • Field names must be unique (case-insensitive).
  • Non-integer values are coerced to 0.
  • Assign multiple fields using three commas as a delimiter.
Syntax: meta_int = Field=Integer		meta_int = is_ad=1
meta_int = is_ad=1,,,year=2013
mix_atracksAsset
Mixes multiple audio tracks into a single track (e.g., when left/right are on separate tracks).

Key information:
  • Track index is zero-based (0 is the first audio track).
  • Channels: L, R, C, RL, RR, SL, SR, LFE.
  • Use commas between track mappings.
Syntax: mix_atracks = Track1=Channel1,Track2=Channel2,...		mix_atracks = 0=L,1=R,2=C,3=RL,4=RR,5=LFE
multibotDirectory Monitoring
Indicates whether multiple Slicebot instances monitor the same directory.

Valid values are:
  • 0: Only a single instance monitors any given directory.
  • 1: More than one instance monitors the directory.
All Slicebot instances consuming from the same folder must enable multibot mode. Each instance should run on a separate computer.

Default value: 1		multibot = 1
notify_retriesNotifications
Maximum attempts to send an HTTP notification before proceeding to the next file. Applies to start_url, done_url, and fail_url.

Default value: 3		notify_retries = 10
notify_retry_waitNotifications
Seconds to wait after a failed notification before retrying.

Default value: 10		notify_retry_wait = 30
posterAsset
Generates a poster image from the frame at the specified time. Must be used with poster_size. Ignored when poster_file is defined.

Syntax: poster = Time		poster = 5000
poster_fileAsset
Sets the asset's poster image to the specified file.

Syntax: poster_file = FullPath		poster_file = /images/poster.png
poster_sizeAsset
Sets the size of the poster image.

Key information:
  • Must be used with the poster time parameter.
  • Ignored when poster_file is defined.
  • If neither poster nor poster_file is defined, a thumbnail of on-demand content is used.
  • No upscaling beyond source resolution.
  • Poster images are scaled down preserving aspect ratio.
Syntax: poster_size = WidthxHeight		poster_size = 512x512
require_captionsProcessing Prerequisite
Determines whether a closed captioning file is required. Learn more.

Valid values are:
  • 1 | true: Do not process unless corresponding captions are found.
  • 0 | false: Process regardless of captions.
require_captions = 1
require_configProcessing Prerequisite
Determines whether a file-specific configuration file is required. (Invalid inside file-specific configuration files.)

Valid values are:
  • 1 | true: Require a corresponding file-specific configuration file.
  • 0 | false: Process regardless of a file-specific configuration file.
require_config = 1
skip_drmAsset
Determines whether the asset's playback URLs must be signed.

Valid values are:
  • 1: Encrypt the asset but allow unsigned playback URLs (useful for ads that require independent playback).
  • 0: Playback requires a signed playback URL.
skip_drm = 1
start_urlURL to which an HTTP POST request is submitted whenever slicing is initiated. Learn more.start_url = http://myserver.net/myservice
thumbnailsAsset
Adds one or more thumbnails.

Key information:
  • A default thumbnail is created even if not specified.
  • The file name for each thumbnail is prefixed as specified.
  • Each thumbnail is bounded by the specified width and height, preserving aspect ratio.
  • Additional thumbnails may add cost and impact processing speed.
  • Add multiple thumbnails using commas.
Syntax: thumbnails = Prefix:WidthxHeight,Prefix2:Width2xHeight2,...		thumbnails = tiny:50x50,med:400x400
timedmetaAsset
Adds timed metadata at the specified time.

Single Field Syntax: timedmeta = Time:Field=Value
Multiple Fields Syntax: timedmeta = Time1:Field1=Value1,Time2:Field2=Value2,...		timedmeta = 0:TIT2=MyTitle,2000:TCOM=Myself
trimAsset
Trims content prior to the specified start time; optionally trims by duration.

Specify StartTime and Duration in milliseconds. Some file types may affect frame accuracy by a few milliseconds.

Start only: trim = StartTime
Start and duration: trim = StartTime,Duration		trim = 3000,52500
username (Required)Authorization
User name for the account to which the asset will be uploaded. You can bypass by setting SLICER_USER and SLICER_APIKEY environment variables.		username = [email protected]

Updated about 1 hour ago