Settings for auto-saving and path substitutions.

General project settings, and settings for color management.

Settings for caching, hardware, localization, and threads/processes.

Settings for start up, file handling, export options, scripting, node behaviors, and more.

Set the number of seconds after which to automatically save your project. Disable this by setting it to zero.

Allows you to remap file paths in order to easily share projects across different operating systems. When the application encounters a file path, any text in the Mac/Linux column is replaced with the text in the Windows column, or vice versa.

For example, if you enter /Volumes/networkmount in the Mac/Linux column and Z: in the Windows column:

• On Mac and Linux, any file paths that start with Z: are converted to start with /Volumes/networkmount.

• On Windows, any file paths that start with /Volumes/networkmount are converted to start with Z:.

To be able to enter text in either column, you need to click on the + button below to add a row to the table.

Note:  Path substitution is invaluable for Sync Review sessions if you're using local source files rather than files from a central server. See Sync Review for more information.

Adds a row under path substitutions.

Deletes the selected row(s) under path substitutions.

Sets the default color management system to use in new projects.

Sets the OpenColorIO configuration to use, if you don’t intend to use the nuke-default settings.

If you select custom from the dropdown, enter the file path of the configuration file or click Choose to use the browser.

Note:   also includes an environment variable method for setting a config file. See Environment Variables in the Nuke Online Help for more information.

Sets the colorspace files should be converted to, on import, and from, during render - it's the colorspace used by Hiero under the hood.

Sets the default LUT applied to Viewers.

Sets the default LUT applied to thumbnails when ever they are generated.

Sets the default LUT applied to external monitors.

Sets the default LUT applied to the specified ingested file type.

When enabled, OCIO roles are available in all colorspace controls.

When enabled, OCIO roles are created in the main menu of cascading dropdowns, with Colorspaces in a sub-menu. When disabled, roles are demoted to a sub-menu called Roles.

You can also control this preference using an environment variable. See Hiero Environment Variables for more information.

When enabled, running under macOS with a screen capable of displaying values greater than 1 allows you to display HDR images in the Display P3 colorspace correctly.

Sets the project directory used by new projects. You can change the project directory for the current project in the Project Settings.

Click to set the project directory to the location of the .hrox file using the [python {nuke.script_directory()}] expression.

Sets the directory used by timeline exports:

• Use Project Directory - use the directory specified by the project directory preference.

• Use Custom Directory - use the directory specified by the custom export directory control.

Sets the export directory used by new projects when the export directory control is set to Use Custom Directory.

Use this to set the output resolution in the Timeline environment for new projects. By default, clips in the sequence are not reformatted to fit this format, they retain the source clip resolution. You can adjust the reformatting for new clips added to a sequence using the Clip settings below or by selecting clips in the timeline and adjusting the settings in the Properties tab.

Select the frame rate for new projects in the Timeline environment.

Use this to define the start timecode for new projects. For shots, this overrides the timecode defined in the media.

You can use this to select the display format for times. You can select either Timecode or Frames.

Use this to choose whether timecodes from this sequence are displayed in drop frame times or not.

Drop Frame is a timecode display option that leaves out two frames from the 30 fps timecode sequence every minute (except every 10th minute) so that long running NTSC sequences are accurate to a real-time clock (NTSC frame rate is 3000/1001, or approximately 0.01% slower than 30fps).

Note:  Enabling Drop Frame is a Timecode display feature only - the source media remains a continuous stream of frames.

Sets how new clips added to a sequence are formatted. The default, None, displays shots at the source clip resolution, whereas To Sequence Resolution reformats the shot to the output resolution using the resize type control.

When clip reformat is To Sequence Resolution, determines how the shot is resized to fit the output resolution. This control is disabled when clip reformat is set to None.

When clip reformat is To Sequence Resolution, disabling center places the clip at the bottom-left of the output resolution, rather than the center.

When enabled, selecting a new version for a clip in a bin or a shot on the timeline updates all instances of that media.

When disabled, you can version clips and shots independently, even if they reference the same media.

Sets a preset poster frame for all new source clips or select Custom to select a relative frame offset as the poster frame:

• First - new source clips display the first frame of the file on disk as the poster frame.

• Middle - new source clips display the middle frame of the file(s) on disk as the poster frame.

• Last - new source clips display the last frame of the file(s) on disk as the poster frame.

• Custom - the poster frame number is derived from the number of frames in the clip starting at 0. Use the frame offset control to set the relative offset.

For example, a .dpx sequence myClip.####.dpx 1001-1500 can have a custom poster frame between 0 and 499.

Default Appearance

Sets the name and color you want to display on participant sessions. Click the color swatch to open the color picker.

Default Behavior

When enabled, automatically open the Sync Session panel when a session is started.

Project Saving

Click to add and remove views from the views list.

Click to move views up and down the views list. Moving a view changes the position of the corresponding Viewer button.

Lists the views in the script or project and the color associated with the view when Use color in UI is enabled.

Sets the principal view selected on script or project load.

Click to automatically add left and right views to scripts or projects.

The directory where all .exr files from timeline disk caching are stored by default. The caching directory should be on a local disk, preferably with the fastest access time available. It’s also important to leave enough space for the maximum disk cache size (defined below).

This allows you to set the maximum amount of space (in GB) to use for the timeline disk cache. Set to zero for unlimited size. Values lower than zero, leave that amount of space free. The currently in use and currently free fields display how much free cache remains from the total specified.

If this limit is reached during caching, a dialog displays options to free up disk space.

Sets the type of compression applied when writing files to the disk cache:

• DWAB

• Zip (1 scanline)

Note:  DWAB compression produces smaller cache files more quickly, but can be lossy compared to Zip compression.

Clear All removes all cached files from the root directory specified in the directory path control. A dialog displays a list of files for confirmation before the files are deleted.

The comp disk cache saves all recent images displayed in the Viewer for fast playback. Using this control, you can specify where you want Hiero to save these images. Select a local disk (for example, C:/temp), preferably with the fastest access time available. It’s also important to leave enough space for the maximum disk cache size (defined below).

Memory Caching

Specifies the percentage of system RAM used for the timeline Viewer playback cache. The entire amount is allocated, even if you've only got a few frames in the Viewer.

Recently used frames are retained in the memory to avoid relying on the disk buffering system. The cache is freed when you switch to the compositing Viewer and reallocated when you switch back to the timeline Viewer.

Tip:  On low-end machines, minimizing this may improve application responsiveness at the expense of smooth playback.

When enabled, any frames cached to RAM (the white bar in the timeline Viewer) are discarded when you switch to the Node Graph within Nuke Studio, freeing the RAM for use in Hiero.

Note:  When you switch back to the timeline, the cached files are re-cached, which can be time consuming.

Sets the amount of memory available for storing timeline audio waveforms.

When enabled, pause timeline Viewer caching when the application is in the background.

When enabled, the timeline Viewer cache is cleared when the application goes into the background.

Note:  This preference is only available when pause timeline Viewer when the application goes to the background is enabled.

Allows you to set the amount of RAM, in MB, to use for the undo history. If this limit is exceeded, older items are discarded.

The audio device control allows you to select an existing audio device for playout from a list of automatically detected devices. You can disable playout on a device by selecting Disabled.

You can select the use red rocket checkbox to speed up decoding RED media. If you’re using R3D Rocket graphics card, note that using it is likely to only be considerably faster when you’re reading in at full resolution. If you’re reading in at half resolution, for instance, using without the R3D Rocket card enabled may be faster. This is because the R3D Rocket graphics card is designed to be fast when reading in multiple frames at the same time. This is not how it works internally, and therefore reads with the R3D Rocket card disabled may sometimes be faster when working in lower resolutions (< 4K widths). Also, note that the R3D Rocket card always produces better results than when downsampling. Also, the R3D Rocket card can only be used by one application at a time, so if you are viewing multiple scripts at once, you may only be able to use the R3D Rocket card in one.

You can use this to expand images cached for playback from 3 to 4 color channels per pixel. Some graphics hardware performs better at loading images to video memory with 4 channels per pixel, than it does with 3. Enabling this option improves playback performance on such hardware, at the expense of reducing the number of frames that it's possible to cache.

If you are seeing poor playback performance, enabling this option may help. However, if you are seeing acceptable playback performance with this option disabled, then leaving it disabled increases the number of frames that may be cached for smooth playback.

Note:  You must restart Hiero for this option to take effect.

Sets the overall localization mode:

• on - checks for updates to source clips and Read nodes with localization policy set to On or From auto-localize path and localizes those files automatically.

• manual - checks for updates to source clips and Read nodes with localization policy set to On Demand and prompts you to update them manually.

• off - no source clips or Read nodes are localized, regardless of the their localization policy.

Note:  The current localization mode is displayed in the status bar at the bottom-right of the interface.

When enabled, source clips and Read nodes referencing out of date localized files automatically revert to reading the entire sequence from the original source files. Source files are read in the following circumstances:

• With Localization mode set to on:

• A localized source clip or Read node with localization policy set to on demand is detected to be out of date.

• A localized source clip or Read node with localization policy set to on or from auto-localize path is detected to be out of date and it is queuing to be automatically localized.

• With Localization mode set to manual:

• A localized source clip or Read node with localization policy set to on, on demand, or from auto-localize path is detected to be out of date.

When disabled, the out of date localized files are read until you update them manually.

When read source files when localized files are out of date is enabled, you can enable this control to hide the progress/status bar on Read nodes that are reading from the original source files.

When enabled, localization does not start automatically when you open a script or project. Enabling this option can help to open scripts and projects more quickly.

Sets the localization policy for all new source clips and Read nodes:

• on - always localize source clips and Read nodes with this policy automatically.

• from auto-localize path - localize these source clips and Read nodes automatically if they reside in the auto-localize from directory.

• on demand - only localize these source clips and Read nodes when you manually update them.

• off - never localize these source clips or Read nodes.

Enter the location of the files you need automatically localized, unless otherwise specified in the Read node’s cache locally control or in the bin right-click, Localization Policy menu. Commonly this would be your remote working folder. If you leave this field blank, automatic local file caching doesn’t take place.

Enter the file path where all the localized files are automatically stored. Localizing files allows for faster reloading for files that are stored in a location that is slow to access (such as a network drive).

On Windows, files saved to the localize to directory replace \\ (double back slashes) and : (colon drive signifiers) with underscores so that the file path works as expected between operating systems. For example:

\\windowspath\to\my\network\file.dpx is saved as __windowspath\to\my\network\file.dpx
t:\my\network\path\file.dpx is saved as t_\my\network\path\file.dpx

This allows you to set the maximum amount of space (in GB) to use for localized files. Set to zero for unlimited size. Values lower than zero, leave that amount of space free. The currently in use and currently free fields display how much free storage remains from the total specified.

If this limit is reached during localization, a dialog displays options to free up storage space.

When files are localized, specifies the time interval (in minutes) before Hiero checks for updated versions of the files.

Sets the number of threads to use per reader. If your source files are located on high performance local drives, increasing the number threads can significantly improve read times.

CPU intensive operations, such as .jpg decoding, can also be improved by increasing the number of threads per reader.

Allows you to override the default number of decode threads used, dependent on file format.

Use the plus button to add an entry to the table and then select the file format using the dropdown menu. Double click the Number of threads column to set the required number of decode threads for that format.

Sets the number of helper threads to use for OpenEXR only. The default, zero, automatically sets the number of helper threads used.

Sets the number of helper threads to use for ARRI only. The default, zero, automatically sets the number of helper threads used.

Note:  The OpenEXR and ARRI helper thread preferences are independent of the threads per reader and override table per format settings.

Sets the number of background processes available to handle QuickTime file I/O. You must restart the application for this preference change to take effect.

Note:  Using too many decoders can affect performance, depending on the available hardware.

Note:  You must restart Hiero for this setting to take effect.

Allows you to increase the number of minutes a render process can stay unresponsive before ending. If you're experiencing Render application timed out messages with process-heavy scripts, you can try increasing this value.

When enabled, rendering using the Frame Server automatically opens the Background Renders panel, or if it is already open, shifts focus to the panel.

Set the number of worker Hiero processes to run for the frame server.

Note:  You must restart Hiero for this setting to take effect.

You can select from several render options:

• limit renderer (more responsive ui) – Select this option to make the user interface more responsive during transcodes. It tells Hiero to use 2 threads to transcode and to use 25% of RAM to cache. Using this option is likely to result in slower transcodes.

• no renderer limits (fastest transcoding) – Select this option to ensure that transcodes happen as quickly as possible. This option may result in a less responsive user interface during transcodes.

• customize render limits – Select this option to manually configure the number of threads used and cache memory available when transcoding files.

Note:  You must restart Hiero for this setting to take effect.

Sets the number of threads that Hiero uses when transcoding. Lower numbers allow the Timeline environment's interface to be more responsive. Higher numbers allow faster transcodes. This setting is passed to Hiero using the -m option.

Use this to set the number of gigabytes of RAM that Hiero uses for its cache settings. Lower numbers may improve the Timeline environment's interface responsiveness, while higher numbers may improve the speed of the transcodes. This setting is passed to Hiero with the -c option.

Sets the help source for the Properties ? button:

• local – use Hiero's built-in HTML help server. Hiero's local help server also searches the NUKE_PATH, .nuke, and .nuke/Documentation directories for HTML files with the same name as the requested node, such as Blur.html.

• foundry – This uses Foundry's Online Help, the most up-to-date version of the documentation.

• custom – Select this to point to your own help server.

When enabled, assign a free port automatically.

Specify a local documentation server port manually. This is usually >= 1024. You can also set this to 0 to automatically assign the port.

When enabled, identify and import the file range of media that is dropped into the bin. When disabled, no range is detected and only a single frame is ingested. (This does not affect container formats, such .mov and .r3d.)

When enabled, incrementing a source clip or shot’s version past the end of the previously discovered versions list, forces a rescan to update the versions list. See Using Versions for more information.

Sets the sequence display mode to be used in the file browser.

When enabled, assume frames have a fixed width number. With this selected, frame numbers need to be padded with zeros to a fixed length, otherwise frame numbers without preceding zeros are assumed to belong to sequences with no padding. This is important as the sequence identifier specifies a unique file name for each and every frame. For example:

Sets which workspace to display on startup. You can choose from Compositing, Conforming, Editing, Finishing, Reviewing, and Timeline. You can also choose to save a customized workspace, which would also be available from this list.

When enabled, display the splash screen on startup.

When enabled, display the dialog on startup.

When enabled, restore the selected saved workspace when opening projects.

Analytics

Sets the source timecode for RED files. You can choose from Default From File, Absolute Timecode, or Edge Timecode.

Sets the timecode source for file-per-frame media (such as .dpx). You can choose from File Header or Frame Number. If File Header is selected and a timecode exists, then the timecode is used. Otherwise it defaults back to using the frame number from the file name.

Sets the maximum image header timebase above which the value is clamped.

Image files are often created with application specific timebase values in the header description. This can lead to reading in spuriously high frame rates and the clamp aims to prevent this from happening.

If your clips do have extremely high frame rates, increase this value as necessary to avoid clamping.

Note:  You must restart the application to apply changes to UI Scaling preferences.

Sets the scaling mode for the UI on Windows and Linux. macOS handles UI scaling automatically.

• off - no scaling is applied to the UI, regardless of screen resolution.

• auto - the UI attempts to scale appropriately dependent on screen resolution.

• all - enables the Scale All dropdown, which allows you to scale all screens by the selected factor.

• per display - enables the Per Display table, which allows you to set the scaling applied per screen.

Change the type, weight, angle, and size of the font used on Hiero’s user interface.

Change the background color of most user interface elements (menus, toolbars, panes, properties panels, Viewers, and pop-up dialogs).

Change the color of input fields, the input pane of the Script Editor, and the left side of the Curve Editor.

Change the color of the highlighting that appears when you hover the cursor over a control, select a file or folder in the File Browser, or scrub to a new frame on the timeline.

Change the color of any highlighted text (for example, text you select in node properties).

Change the color of labels and text on the application interface. Note that this does not set the color of the labels on nodes in the Node Graph.

Change the color of buttons and dropdown menus.

Change the color that indicates a control has been animated.

Change the color that indicates a keyframe has been set.

Change the color of the disk cached frames on the Viewer timeline.

Change the color of the RAM cached frames on the Viewer timeline.

Change the color of the frame marker on the Viewer timeline.

Change the color of the in and out frame markers on the Viewer timeline.

Sets the maximum number of curves visible in the Curve Editor.

Change the background color of the Dope Sheet tab.

Change the color used for an unselected key on the Dope Sheet.

Change the color used for a part-selected key on the Dope Sheet.

Change the color used for a selected key on the Dope Sheet.

Change the color used for the timeline on the Dope Sheet.

Change the color used for the control text on the Dope Sheet. These indicate the frame number of a key when you select one.

Change the color used for the shadow of the control text on the Dope Sheet.

Change the color used for the time labels on the Dope Sheet. These indicate frame numbers.

Change the color used for the current frame on the Dope Sheet. This is a vertical line that indicates the current frame on the timeline.

Use this to set the maximum number of panels that can be open in the Properties pane.

When this is enabled, double-clicking a node that has been open before, places the panel in the same place as a new panel. If this is disabled, the panel appears in its previous position.

If this is enabled, the node selection in the Node Graph determines which control panels are expanded (all unselected nodes automatically have their panels collapsed). This does not apply to floating control panels.

Deselect this checkbox to ignore individual soft effect color settings and, instead always use the All Others color.

The soft effects listed here have been given a default color. You can change this by clicking the assigned color to open the color menu, and selecting a new one.

When enabled, additional shading is applied to source clips and shots in the Project bin and timeline.

Click to change the color of labels in the Project and timeline panels. A color wheel displays allowing you to select the required color.

When enabled, label colors are automatically adjusted if a potential color-clash is detected.

Click the buttons to change the color of shots and comps in the timeline panel. A color wheel displays allowing you to select the required color.

When enabled, the specified item colors, or defaults, are displayed in the Project panel.

When enabled, the specified item colors, or defaults, are displayed in the timeline panel.

When enabled, the specified item colors applied to rows in the spreadsheet.

Click the buttons to change the color of items in the Project and timeline panels. A color wheel displays allowing you to select the required color.

Use the slider or the entry box to select the black point value.

Use the slider or the entry box to select the white point value.

Use this to select the video standard to use when converting from RGB to luma and chroma for scope display.

Select this checkbox to include applied Viewer color transforms (gain, gamma, and LUT) in scope data. If this checkbox is disabled, all Viewer transforms are ignored.

Note:  If disabled, rendering may become slow as image calculation may be needed.

Use this to select the font to use in the Script Editor.

Note:  This control also changes the font in the BlinkScript Kernel Source field.

You can use this control to set the indent value to use when scripting.

Disable this checkbox if you prefer that the contents of the Script Editor is not saved and restored between sessions of Hiero.

When enabled, an extra line is drawn on the timeline to the right of the playhead, indicating the end of the current frame.

When enabled, the timeline scrolls with the playhead, constantly updating the view. When disabled, the playhead is allowed to move off screen.

When enabled, automatically limit monitor out to the legal range when swapping between the Timeline environment and Compositing environment.

When enabled, Hiero's internal floating monitor out window always remains on top of other open application windows.

When enabled, VR headsets such as the Oculus Rift and HTC Vive are added to the Monitor Out > Device dropdown. Choose the required headset from the dropdown to pass the monitor out to the selected device.

Sets the default flipbook mode, Hiero's Flipbook Viewer or HeiroPlayer.

• Flipbook Viewer opens a new Viewer inside Hiero containing the flipbooked content.

• HieroPlayer launches an instance of the application containing the flipbooked content, but requires either a Nuke Studio or HieroPlayer license.

Use this to set the Viewer playback mode:

• Play All Frames - the default setting, plays all frames in real-time (dependent on hardware).

• Skip Frames - plays frames in real-time skipping where necessary to maintain the frame rate.

• Play All Frames, Buffering - plays all frames by buffering and playing frames back as they become available.

You can use this to choose to show overlays in the image area. You can choose from:

• Title Safe – Indicates where text should be entered to be visible.

• Action Safe – Indicates the area in which to place actions so that they are visible.

• Format – Displays the size of the format over the Viewer.

Use this to select which display to use for fullscreen mode. This setting takes effect the next time fullscreen mode is entered.

Select this checkbox to see through missing media in the timeline, displaying the first displayable media in the underlying tracks.

Use this to select the Viewer background. You can select black, or gray (using the slider to determine the grayscale), or checkerboard (using the slider to determine the brightness).

Use this to set the default number of frames skipped by the Viewer skip controls, and the timeline Nudge More commands.

Use this to determine the filtering used during rendering in the Timeline environment. You can select Auto, Nearest neighbour, or Linear.

Auto uses ths same automatic selection as in the Compositing environment. This does not affect exports or rendering in the Compositing environment.

Use this to adjust the default timing offset (in milliseconds) between audio and video to apply to new Viewers. Positive values make audio play earlier relative to video; negative values make audio play later. To convert from video frames to ms, divide 1000 ms by the video frame rate. For example:

• at 25fps, a video frame is 1000/25 = 40ms, or

• a 1.5 video frame delay = 1.5 * 40ms = 60ms.