Lock Library

locked

locks the library config and prevents ingesting and editing of elements.

This can be helpful if you want to access the library from a different facility and avoid that any changes are made on the main library.

Library Name

name

display name of the library in the application

Library Root

root

Set the root location for the library data. Set individual paths for each operating system. This is the location were your actual files will be stored.

If you move your library data to another location, you only have to update this value and everything should be linked correctly

Database

database

database that contains a data for this library
For SQLite you can set individual paths for each operating system

Template mappings

template_mappings

link the transcoding templates to the specific template types

main: main template for the library element (required)
thumbnail: preview of the element (required) - output is a JPEG
filmstrip: quick preview for movie/sequence files (recommended for movie/sequences) - output is a JPEG

extra: additional transcoding tasks to run during ingest time or re-rendering for elements

Values

values

Patterns

patterns

path patterns that you want to add/overwrite

Transcoding templates

templates

templates for different tasks (transcoding, copy …)

NoOp

no operation, do nothing
This can be useful if you already created all your proxy files, but you still want to register the file paths in the database.

Copy File

Copies from the source path to the output path

Filmstrip

Creates a filmstrip with a certain amount of frames for a sequence. This task will only run for movie files and a sequence of images

frames: define how many frames the filmstrip contains (default: 24)
height: height in pixels (default: 270)

The width of the filmstrip is calculated based on the given parameters. Every frame has a fixed pixel aspect ratio of 16:9

Thumbnail

Create a thumbnail (JPEG file)

width: width in pixels (default: 480)
height: height in pixels (default: 270)

To define which frame to use as the thumbnail frame: Settings → Global → Thumbnail Frame of Sequence

FFmpeg

use FFmpeg to transcode the source file(s)
There are several predefined FFmpeg presets

More comprehensive documentation will follow.

Custom Command

Run your custom command

For example:

exec C:/python.exe
params C:/my_script.py <source.path>

<path>

path of the new output
/my/library/file/path/fire-00001.%04d.exr

<path_source>
<source.path>

path to the source file
/some/path/to/my_file_sequence.%04d.exr

<source.name>

name of file with frame padding
my_file_sequence.%04d.exr

<source.basename>

base name of the file without extension and frame padding
my_file_sequence

<source.extension>

source path file extension
exr

<element.colorspace>

colorspace value defined in the ingest view
(only for reference - does not change the actual colorspace of the element)