1. Introduction

ICE can be used as a system command by providing parameters via the Command Line Interface (CLI).

The CLI syntax can be used to start the ICE process, create a project or composition, import media, QC reports and more.

Only one instance of ICE can run at the same time. Any attempt to start another instance will redirect the command and parameters to the existing instance.

2. CLI Syntax

ICE can either be started via the CLI with specific parameters, or be sent commands via the CLI if the process is already running.

The CLI syntax always takes one of the two following forms:

2.1. ICE is not running

ice.exe	{context} <parameter> [value] (option)

2.2. ICE is already running

ice.exe <parameter> [value] (option)

3. Operational Context

The {context} argument can be one of the following defined keywords:

3.1. Autostart Context

The {autostart} context will launch the ICE process and bypass the project creation user interface.

  • A project name is required, provided via the parameter -p.

  • An optional composition (playlist) name can be provided via the parameter -c.

Request example #1:
ice.exe autostart -p "mysession"
Result

ICE is started and a project called "mysession" is created and the process switches to the main player interface.

if the project already exists, it will be loaded.
Request example #2:
ice.exe autostart -p "mysession" -c "myplaylist"
Result

This example is similar to #1 but will also load or create the composition (playlist) "myplaylist" and set it as the current playlist for playback

4. Importing Media

Media can be imported in ICE via the -i parameter followed by the absolute path for the media file name or package directory (DCP, IMF). For file sequences the full path of the files with the frame digits replaced by # must be provided e.g. E:\MEDIA\SEQUENCE\test_sequence_.dpx.

Request example #1:
ice.exe -i "E:\MEDIA\test.mov"
Result

ICE is already started and will import the file "E:\MEDIA\test.mov".
In addition the file is loaded ready for playback.
Request example #2:
ice.exe autostart -p "mysession" -i "E:\MEDIA\test.mov"
Result

Similar to example #1 but ICE is started and the project "mysession" is created before importing the media file "E:\MEDIA\test.mov"
Request example #3:
ice.exe autostart -p "mysession" -i "E:\MEDIA\SEQUENCE\test_sequence_######.dpx"
Result

ICE is started and will import the DPX image sequence "E:\MEDIA\SEQUENCE\test_sequence_.dpx" and loads it ready for playback.
Request example #4:
ice.exe autostart -p "mysession" -i "E:\MEDIA\IMF\IMF_PACKAGE"
Result

ICE is started and will import the IMF package "E:\MEDIA\IMF\IMF_PACKAGE" and loads it ready for playback.

5. Importing a QC Report

ICE can import a QC Report via the -qcreport parameter.

Request example #1:
ice.exe -i "E:\MEDIA\test.mov" -qcreport "F:\REPORTS\xml\qcreport.xml"
Result

ICE is already started and will import the file "E:\MEDIA\test.mov", the "F:\REPORTS\xml\qcreport.xml" is also loaded.
In addition the media file is loaded ready for playback with the QC Report markers/locators loaded.

6. Setting the playhead postion

The playhead’s position can be provided via the -playhead parameter.

The value of the parameter can be a frame number or a timecode:

Request example #1:
ice.exe -i "E:\MEDIA\test.mov" -playhead 3677
Result

ICE will import the "E:\MEDIA\test.mov" media file, load it for playback and set the playhead position at the composition’s frame 3677.
Request example #2:
ice.exe -i "E:\MEDIA\test.mov" -playhead "09:58:30:00"
Result

ICE will import the "E:\MEDIA\test.mov" media file, load it for playback and set the playhead position at the composition’s timecode 09:58:30:00.

In both examples the provided values are absolute and do not depend on the media’s start point. ICE always loads the media at the start time existing in the files header information but the provided position is absolute to the composition’s duration.

7. Setting a mark-in mark-out range

The mark-in position can be provided via the -markin parameter and the mark-out via the -markout one.

The value of the parameters can be a frame number or a timecode:

Request example #1:
ice.exe -i "E:\MEDIA\test.mov" -markin 1000 -markout 1200
Result

ICE will import the "E:\MEDIA\test.mov" media file, load it for playback and set a playback range starting at the composition’s frame 100 and ending at frame 1200.

Request example #2:
ice.exe -i "E:\MEDIA\test.mov" -markin "01:02:30:00" -markout "01:03:10:00"
Result

ICE will import the "E:\MEDIA\test.mov" media file, load it for playback and set a playback range starting at the composition’s timecode 01:02:30:00 and ending at timecode 01:03:10:00.

Once the ICE started and the media loaded the playback range defined by the markin and markout parameters can be playdback by pressing ALT + SPACEBAR or ALT + play button

In both examples the provided values are absolute and do not depend on the media’s start point. ICE always loads the media at the start time existing in the files header information but the provided position is absolute to the composition’s duration.

8. Starting playback automatically

To start playing back the media automatically can be done by providing the -autoplay parameter.

Request example #1:
ice.exe autostart -p "default" -autoplay -i "E:\MEDIA\test.mov"
Result

ICE is started and the project "default" is created, the media file "E:\MEDIA\test.mov" is imported and the playback is started automatically.
Request example #2:
ice.exe -i "E:\MEDIA\test.mov" -markin "01:02:30:00" -markout "01:03:10:00" -autoplay
Result

ICE will import the "E:\MEDIA\test.mov" media file, load it for playback, set a playback range starting at the composition’s timecode 01:02:30:00 and ending at timecode 01:03:10:00 then starts playing back the defined range.

In the second example the provided values are absolute and do not depend on the media’s start point. ICE always loads the media at the start time existing in the files header information but the provided position is absolute to the composition’s duration.

9. Accessing ICE via a web browser or web application

Installing ICE will register custom URI schemes depending on the application’s version. They can be accessed via a web browser by calling ice://<command-parameters> for ICE and ice-v://<command-parameters> or ice-v-plus://<command-parameters> for ICE-V or ICE-V+.

Request example #1:
ice-v://autostart -p "mysession" -i "E:\MEDIA\test.mov"
Result

Accessing the URL via a web browser will start ICE-V then create the project "mysession" before importing the media file "E:\MEDIA\test.mov"