User interface¶

Main areas¶

The Capturebox user interface consists of the following main areas:

Figure: Capturebox user interface main areas

(1) - Menu/toolbar

(2) - Media overview

(3) - Ingest channel 1

(4) - Ingest channel 2

(5) - Messages

(6) - File preview

(7) - Status bar

Menu bar¶

The menu bar of the main window contains the following sections:

• Start
  

• View
  

• Help
  

The areas of the menu bar provide access to the following functions:

Media overview¶

The Media overview lists all files recorded with Capturebox (all files from monitored source directories).

If the Media overview window is not yet displayed, it can be enabled in the toolbar via View > Media. Afterwards the corresponding icon is highlighted in blue:

Figure: Media overview window enabled

Here you can see an exemplary general view of the Media overview:

Figure: Media overview

For more information about the Media overview, see chapter Media management.

Ingest channel¶

To manage ingest jobs, a separate window is available for each configured ingest channel.

If the window of an ingest channel is not yet displayed, it can be enabled in the toolbar via View > [Name of ingest channel]. Afterwards the corresponding icon is highlighted in blue:

Figure: Ingest channel windows enabled

Here you can see an exemplary representation of an Ingest channel window:

Figure: Ingest channel window

The ingest channel window consists of the following elements:

Ingest job settings (quick menu)¶

This area is used to quickly create ingest jobs without having to open a separate menu. For this purpose, only basic settings of the ingest job must be specified.

Figure: Ingest job settings (quick menu)

The area includes the following elements:

Ingest job control¶

The ingest job control allows you to manually control ingest jobs.

Figure: Ingest job control

It provides the following functions:

Ingest job¶

In the ingest job list, the type of each ingest job can be recognized by a corresponding symbol. The following symbols are used here:

Crash recording

Scheduled recording

The current job status can be recognized by the colored marker.

After an ingest job has been created and the recording is ready to be started, it is highlighted in green:

Figure: Crash recording (status: ready/green)

Figure: Scheduled recording (status: ready/green)

A started ingest job is highlighted in red:

Figure: Crash recording (status: started/red)

Figure: Scheduled recording (status: started/red)

After an ingest job is completed, it is highlighted in gray and the recorded file is listed in the specified directory in the Media overview:

Figure: Crash recording (status: completed/gray)

Figure: Scheduled recording (status: completed/gray)

Ingest job list editing¶

Via the ingest job list editing toolbar you can edit the list of ingest jobs.

Figure: Ingest job list editing toolbar

It provides the following functions:

No.	Symbol	Function
1		Move selected job up to the top of the list
2		Move selected job one position up
3		Remove selected job from list
4		Create new job (open advanced ingest job settings)
5		Move selected job one position down
6		Move selected job down to the end of the list
7		Synchronize job list manually with the associated IngestServer
8		Sort job list in ascending order by job title
9		Sort job list in descending order by job title

Ingest job settings (advanced menu)¶

In addition to the ingest job settings quick menu, you can also create ingest jobs using the advanced ingest job settings. This menu provides additional settings and you can use it to create ingest jobs for both crash and scheduled recordings.

To open the advanced ingest job settings, click the Create new job icon in the ingest job list editing toolbar.

The Ingest job properties window is displayed.

Figure: Ingest job properties window

The advanced ingest job settings enable you to set the following properties:

No.	Area	Property	Description
1	-	Job type	The job type to be used for recording. Available job types are Crash and Schedule.
2	Common	Master channel (not editable)	The primary ingest channel to be used for recording.
		Master profile (not editable)	The recording profile to be used for recording via the primary ingest channel.
		Backup channel (not editable)	The secondary ingest channel to be used for recording (without function).
		Backup profile (not editable)	The recording profile to be used for recording via the secondary ingest channel (without function).
3	Timecode	Type (not editable)	The type (source) of the timecode to be used.
		Start TC (not editable)	This field displays the type of timecode that is stored as the start timecode ("timecode of first frame") in the metadata of the file to be recorded. The default option is "Actual time", i.e. the current system time is used as timecode.
4	Metadata	Object ID	The ObjectId is stored as a metadata element of the file to be recorded (see Sidecar XML file). Notice If you leave the field empty, Capturebox generates the value automatically according to the current configuration. A default value can be defined for this in the Capturebox system settings.
		Object title	The job title is stored as a metadata element of the file to be recorded (see Sidecar XML file). Notice If you leave the field empty, Capturebox generates the value automatically according to the current configuration. A default value can be defined for this in the Capturebox system settings.
		Keywords	Keywords can contain, for example, descriptive information about a recording and can be used by downstream systems. They are stored as a metadata element of the file to be recorded (see Sidecar XML file).
		Notes	Notes can contain, for example, descriptive information about a recording and can be used by downstream systems. They are stored as a metadata element of the file to be recorded (see Sidecar XML file).
5	Destination	Path (Master)	The target directory to be used for recording via the primary ingest channel.
		Path (Backup)	The target directory to be used for recording via the secondary ingest channel (without function).
		Filename	The file name to be used for the recording. Variables are also supported here to automatically generate the file name or to extend it. Notice If you leave the field empty, Capturebox generates the value automatically according to the current configuration. A default value can be defined for this in the Capturebox system settings.
6	Schedule	Start time	Date and time for the start of the recording. Notice This area is only available for scheduled jobs, i.e. when "Schedule" is selected as the type under (1).
		End time	Date and time for the end of the recording.
		Duration	Duration of the recording. As an alternative to a manual entry in the End Time field, you can enter the duration of the job to be created in days (left field) as well as hours, minutes, and seconds (right field). The values displayed under End time will adjust according to your entries. Tip You can reset the time data to the default values via the button.
7	-	Add	Create the ingest job using the selected properties.
8	-	Close	Close the Job Properties window.

Variables¶

To automatically generate filenames of recorded files according to your specifications, you can use variables in the filename field. This is possible both in the ingest job settings quick menu and in the advanced ingest job settings. When creating an ingest job, the used variables are replaced by actual values.

The following variables are available for this purpose:

Messages¶

The Messages window contains status messages that are marked with corresponding icons and colors depending on their type and meaning. If the Messages window is not yet displayed, it can be enabled in the menu bar via View > Messages. Afterwards the corresponding icon is highlighted in blue:

Figure: Messages window enabled

Figure: Messages window

File preview¶

Overview¶

The File preview enables frame-accurate preview playback of recorded files. Files to be previewed can be selected via the Media window.

If the File Preview window is not yet displayed, it can be enabled in the menu bar via View > Preview. Afterwards the corresponding icon is highlighted in blue:

Figure: File preview window enabled

Figure: File preview window

The File Preview window consists of the following elements:

Toolbar¶

The File preview toolbar provides access to the following functions:

Figure: File preview toolbar

No.	Symbol	Function
1		Jump to mark in
2		Set mark in
3		Previous frame
4		Stop
5		Play/Pause
6		Next frame
7		Set mark out
8		Jump to mark out
9		Save mark in and mark out points (without function)
10		Update the length/duration of the file being played Notice This function is only available if the currently playing file is a growing file (e.g. a file that is currently still being recorded).

Customizing the user interface¶

Capturebox provides the possibility to customize the arrangement of the user interface windows. The main areas can be placed almost arbitrarily.

Changing the arrangement of windows¶

To change the arrangement of a window, proceed as follows:

1. Click the title bar of the window you want to move.

2. Hold down the left mouse button and move the window to the desired position.

Figure: Move windows of the user interface

To dock a window at a suggested position, proceed as follows:

1. Click the title bar of the window with the left mouse button.

2. Drag the window to the desired position while holding down the left mouse button.

The corresponding position is highlighted in blue as a preview.

Figure: Dock window at new position

To undock a docked window, proceed as follows:

• Double-click the title bar of the respective window.

  The window is no longer docked and is displayed separately.

Combining multiple windows¶

Multiple windows can be combined in one window and displayed via a tab bar. To do this, at least one window must already be open.

Proceed as follows to create a tab bar in a window:

1. Open another window via the toolbar.

2. Drag it to the center of the already opened window.

   The position selection for docking windows (see below) appears.

3. Select the position in the center.

Figure: Dock window centrally

Both windows (in the example the "File Preview" and "Media Overview" windows) are displayed in the tab bar at the bottom and can be selected via this.

Figure: Window docked and added to tab bar