The application Viz Send, included in Viz Engine installation, can be used to communicate with Channel Recorder. Connect the tool to the port specified in the configuration file. The following commands are implemented in the service:

ABOUT

Command

Description

ABOUT GET

Prints license information of all libraries used in this software.

MAIN

Some of the following commands must be called during initialization. To configure these commands, use the configuration web interface and the restart the service. Refer to Channel Recorder Configuration for more information.

Command

Description

MAIN VERSION

Returns Channel Recorder version.

GET VERSION

Returns Channel Recorder version. Same as MAIN VERSION.

MAIN HOSTNAME

Returns system hostname.

MAIN SVCNAME

Returns Service Host version.

MAIN BOARD LIST

Lists all available boards.

MAIN BOARD SELECT [serial number]

Selects a board. The board is identified by the serial number. If the board with the given number is not found, the first board is selected.

MAIN BOARD GET

Returns the selected board.

MAIN CONNECTOR SELECT

Selects a connector. Connectors are labeled consecutively from A to P or numerically from 1 to 32. Numerical value is needed for addressing all inputs in a 2110 capable board.

This command can also be used to restart the channel without using the web interface.

MAIN CONNECTOR GET

Returns the selected connector.

MAIN LICENSES

Returns the state of the licenses defined at configuration. An example output is:

Example:
"Service Host Core" ENG_SVCHOST_CORE 1200004 300 7 1 VL_GRACE_LICENSED VL_SHARED 0 1540987200 0 0 license-server.vizrt.internal
"SDI/IP Video Input Enablement (max)" ENG_ING_SDIIP_MAX 1200200 300 21 1 VL_GRACE_LICENSED VL_SHARED 0 1540987200 0 0 license-server.vizrt.internal
"4K Video Enablement" ENG_ING_4KVIDEO 1200400 300 15 1 VL_GRACE_LICENSED VL_SHARED 0 1540987200 0 0 license-server.vizrt.internal
"Viz Engine DNxHD Codec Support" ENG_PLROY_DNXHD 1200603 300 18 1 VL_GRACE_LICENSED VL_SHARED 0 1540987200 0 0 license-server.vizrt.internal

Each line is one license and each row separated by space is:

  • Long name of the license in quotes.

  • Short name of the license.

  • The ID of the license.

Available licenses are:

  • Service Host Core (VL_ENG_SVCHOST_CORE, 1200004)

  • SDI IN MAX (VL_ENG_ING_SDIIP_MAX, 1200200)

  • DNxHD Ingest (VL_ENG_PLROY_DNXHD, 1200603)

  • UHD for Playback and Ingest (VL_ENG_ING_4KVIDEO, 1200400)

  • UHD for Ingest (VL_ING_4KVIDEO, 1200404)

  • How many licenses of this type are available in the current container.

  • How many licenses of this type are currently in use in the current container.

  • How many licenses are in use by Channel Recorder.

  • Grace state of the license. Possible values are VL_GRACE_LICENSED, VL_GRACE_UNLICENSED or VL_GRACE_GRACE.

  • How is the license allocated. Possible values are VIZLIC_USER_LIMIT, VIZLIC_NO_USER_LIMIT, VIZLIC_EXCLUSIVE or VIZLIC_SHARED. The licenses used by Channel Recorder always has VIZLIC_SHARED as value.

  • Date when the license starts. In Unix time.

  • Date when the license expires. In Unix time.

  • Start date of the currently valid support contract of a customer (only filled at application licenses) In Unix time.

  • End date of the currently valid support contract of a customer (only filled at application licenses). In Unix time.

  • The host name of the current license server (contains the local computer name in case of a local license).

MAIN CRASH [type]

Crashes the service. [type] can either be omitted or be one of:

  • MAIN: Crash the service (same as when omitted).

  • RECORD: Crash the recording thread.

OUTPUT

One output target can be initialized during startup. During execution more than one output can be enabled. For instance you can have VideoOut A enabled. Please refer to Channel Recorder Configuration to initialize an output during startup.

Command

Description

OUTPUT GET

Lists the active targets.

OUTPUT LIST

Lists available targets.

OUTPUT START [target]

Starts an output handler for the specified [target]. Several output handlers can be started in parallel, but only one is allowed for each target. Valid targets are:

  • VideoOut: This target requires one additional parameter: [connector]. The [connector] parameter specifies the video output connector of the Matrox board.

Example: OUTPUT START VideoOut A

OUTPUT STOP [target]

Stops the output handler for the specified target.

RECORD

Crash Recording / One-time Scheduling

These are specific commands used only for crash and one-time scheduling of recording. These command are available from version 1.0. For scheduling, it is recommended to use RECORD SET introduced from version 1.1.

Command

Description

RECORD CLIP [clip name]

Sets the clip name and initializes the recorder. This command does not start recording (see RECORD START).

RECORD START [duration] [start time] [end mode]

Starts or continues recording. The [duration], [start time], and [end mode] parameters are optional. However, the parameters are interdependent as follows:

  • If the parameter [start time] is provided, [duration] is also required.

  • If the parameter [end mode] is provided, [duration] is also required.

The format for both is Timecode (see Data Types).

  • [duration] and [start time] can be zero timecode, which is then ignored.

  • [end mode] can either be STOP, which finalizes and closes the clip, or PAUSE (default behavior), where the clip stays open and can be used for further recording.

RECORD PAUSE

Pauses recording.

RECORD STOP [end time]

Stops recording and flushes the recorder. A new clip needs to be set afterwards (see RECORD CLIP). The end time is optional and specifies the timecode when the recording should end.

Example:

Crash recording:

RECORD CLIP Crash.mxf
RECORD START
RECORD STOP

One-time scheduling recording:

RECORD CLIP Crash.mxf
RECORD START 600 15:00:00:00

Loop Recording

These are specific commands used only for loop recording. It allows setup, start or stop loop recording. These are introduced from version 1.1.

Command

Description

RECORD LOOP [key=value] ... [key=value] [operation]

Starts, stops or configures the settings for loop recording. Any number of properties can be applied in the form of key-value-pairs. If no property is supplied, and the entry does not yet exist, it is added with the default values. Available keys are:

  • PREFIX: Prefixes to the filename. It is appended with the timestamp of the start time.

  • POSTFIX: Postfixes to the filename. Is appended after the timestamp.

  • LENGTH: Determines the length of the loop in frames or timecode. At least this amount of frames reside on the disk. The minimum length value is 00:02:00:00 or the equivalent number of fields / frames.

  • CHUNK: Sets the size of one chunk in frames or timecode. The chunk size influences the loop length. The minimum chunk value is 00:00:30:00 or the equivalent number of fields / frames.

  • DISKSIZE: Sets the size of the loop is defined by the size of the clips on the disk. The oldest clips are deleted until the disk size drops below the specified value.

  • DISKFREE: Sets the size of the loop is defined by the space left on the disk. If it drops below the value, the oldest clips are deleted until at least the specified amount is free again.

[operation] can be START or STOP. When no [operation] is specified then only the settings are set for the specified key-value-pairs. It is possible to specify [key=value] [operation] at the same time but only when [operation] is START.

Example: RECORD LOOP LENGTH=00:05:00:00 CHUNK=00:00:30:00 PREFIX=Loopy START
RECORD LOOP STOP

Protected Loop Recording

Starting with version 2.0, it is possible to protect a range of files from being overwritten. 

Command

Description

RECORD LOOP NAME=test%n.mxf CHUNK=00:00:10:00 LENGTH=00:01:00:00 START

Starts recording in one second chunks.

RECORD LOOP IN=00:00:00:00 OUT=00:00:20:00 PROTECT

Protects the first two files (0-10 sec) and (10-20 sec) from being overwritten.

RECORD LOOP IN=00:00:00:00 OUT=00:00:20:00 UNPROTECT

The unprotected files are the first one being deleted (file0.mxf and then file1.mxf). This is determined by the internal timecode.

Information: It is not possible to protect all files. The minimum number of unprotected files is the number of writers. This is to prevent a lock down and the recorder not being able to record anything.

Scheduled Recording

These are specific commands used only for scheduled recording. It allows setup, start or stop scheduled recording. 

Command

Description

RECORD SET [name] [key=value] ... [key=value]

Adds a new clip to the timeline, or changes a property of an entry defined by [name]. Any number of properties can be applied in the form of key-value-pairs. If no property is supplied, and the entry does not yet exist, it is added with the default values. Available keys are:

  • FILE_EXTENSION: Enables or disables automatically adding a file extension to the file name. If this feature is turned off, the client application has full control over the file name.

  • CONTAINER: Sets the container type of the recorded file. With the container type, a default codec is also set. By setting the container type, a valid recording can be started.

  • CODEC: Sets the codec type of the recorded file. By setting the codec type, default values for bitrate and audio are also set.

  • BITRATE: Sets the bitrate for the video encoding. The value can either be applied as bits per second or as Megabits per second. Not all codecs allow changes to the bitrate. In such cases, BITRATE is ignored.

  • IN: Sets the default value for the recording in point. The value must be in timecode format: 00:00:00:00.

  • OUT: Sets the default value for the recording out point. The value must be in timecode format: 00:00:00:00.

  • DURATION: Sets the default value for the recording duration. The value can be in frames or in timecode format: 00:00:00:00.

  • STARTTC: Sets the default value for the starting timecode. The value must be in timecode format: 00:00:00:00.

  • AUDIOCHANNELS: Sets the number of audio channels to record. How many channels are actually recorded depends on the codec and the input signal.

  • DISKACCESSSIZE: Sets the size of data blocks written to the disk in byte. Postfixes like KiB, Kb, k, etc., are allowed, but must not be separated from the value with a blank space. The default value is 4MiB (4194304 bytes). The minimum value is 32KiB (32768 bytes). KiB and k multiplies the value by 1024. kb multiplies the value by 1000. The same works with m for mega and g for giga.

  • VBR: Sets whether the recorded file, when the format supports it, should be in VBR (Variable Bit Rate).

  • TDIR Sets the default behavior of TDIR (Time Delayed Instant Replay).

  • TDIRINTERVAL: Sets the interval of file header updates in TDIR (Time Delayed Instant Replay) recordings. The value is in seconds and fractions of seconds, meaning both 11.1 and 11.2 are considered valid values. Minimum allowed value is 10s, which is interpreted by Channel Recorder as every frame. The maximum value is 60.0s.

  • TDIRDURATIONPREDEFINED : Sets the TDIR duration to -1 while the file is growing, when enabled. The initial value is Off.

  • UPDATEMT: Updates the modification time of the recorded clip regardless of TDIR value. The initial value is On.

  • STOPATEND: Sets the default behavior at the end of the recording.

For more information regarding these settings possible values and default values check the section CONFIG SET below.

RECORD REMOVE [name] ... [name]

Removes the entry [name]. Multiple [name] arguments can be provided.

RECORD GET [name] | [key] ... [name] | [key]

Lists all entries or shows the properties of an entry. If no parameter is applied, a list of all scheduled clips is returned. Any number of [name] and [key] can be applied. The values of all keys are returned for all values. If no [key] is provided, all values of the applied keys are returned and vice versa. This means that if you call RECORD GET with clip names only, the command returns all properties of these clips. When called with properties only, it returns this property for all clips. A special [key] is TIMELINE , which returns all entries in the timeline.

Common Record Commands

Some of these commands are only used for loop and crash recording, while others are used for all three modes.

Command

Description

RECORD DURATION

If no duration parameter is applied to the command, it returns the timecode relative to the start timecode. If a duration parameter is applied, the duration of an ongoing recording is changed. The duration parameter can be specified as either a number of frames or a timecode (see Data Types ). In the case of loop and schedule recording the value used to set using this command is ignored.

RECORD RESOLUTION GET

Returns the resolution the Channel Recorder is running at.

RECORD STATE

Returns the state the Record Channel service is in. By default state is idle. State is only invalid when the clip was configured incorrectly (for example, container / codec combination is wrong).

State flow:

Idle -- Start() --> Recording -- Stop() --> Paused ^ | | `-- Flush() ----------+---------------------´

RECORD STARTTC [starttc]

Defines which start timecode to use for the recording. If the command is not called before the recording starts, the current timecode is written to the clip. If no value is given, the command returns the current value. This is only used for loop and schedule recording.

CONFIG

Command

Description

CONFIG GET

Gets the current settings.

CONFIG LIST [argument]

Lists all available variables. The optional [argument] flag provides information specific to the applied argument. Known arguments are:

  • CONTAINER: Displays all known container types.

  • CODEC: Displays all known codec types.

  • DUMP: Displays the current dump file setting.

  • PRIORITY: Displays the current process priority setting.

CONFIG SET [variable] [value]

Sets the [variable] to [value]. To get all available variables, call CONFIG LIST. Refer also to variables and values for CONFIG SET below.

CONFIG SET

Variable and values for CONFIG SET command. The CONFIG SET command is used to set the configuration globally, this means that all the recording mode uses these settings by default unless specified otherwise. Only schedule recording can specify different settings for each schedule by specifying them via RECORD SET command.

IPIN

Variable

Value

IPIN IPGENERAL REDUNDANCY [bool]

Enables redundancy flows.

IPIN IPGENERAL JOINTYPE [type]

Indicates the type of membership request made when IPv4 address is a multicast address. Valid values for [type] are:

  • 0 None

  • 1 IGMPv2

  • 2 IGMPv3

The default value is None.

IPIN IPVIDEO [ bool]

Enables video flow if True.

IPIN IPVIDEO ADDRESS [address]

Sets destination IPv4 address. The default value is 239.0.10.10.

IPIN IPVIDEO PORT [port]

Sets destination port. The default value is 50002.

IPIN IPVIDEO RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to True. The default value is 96.

IPIN IPVIDEO PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For video, the range is from 6.4 nanoseconds to 419424.0 nanoseconds in intervals of 6.4 nanoseconds. The default value is 6.4.

IPIN IPVIDEO FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPVIDEO IGMPV3 FILTERLIST [list]

Lists IPv4 addresses to be included or excluded separated by a space character.

IPIN IPVIDEO_S ADDRESS [address]

Destination IPv4 address. The default value is 239.1.10.10.

IPIN IPVIDEO_S PORT [port]

Destination port. The default value is 50002.

IPIN IPVIDEO_S PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For video, the range is from 6.4 nanoseconds to 419424.0 nanoseconds in intervals of 6.4 nanoseconds. The default value is 6.4.

IPIN IPVIDEO_S IGMPV3 FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPVIDEO_S IGMPV3 FILTERLIST [list]

Lists IPv4 addresses to be included or excluded separated by a space character.

IPIN IPAUDIO [bool]

Enables audio flow if True.

IPIN IPAUDIO ADDRESS [address]

Destination IPv4 address. The default value is 239.0.10.12.

IPIN IPAUDIO PORT [port]

Destination port. The default value is 50004.

IPIN IPAUDIO RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to True. The default value is 97.

IPIN IPAUDIO PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For audio, the range is from 102.4 nanoseconds to 6710681.6 nanoseconds in intervals of 102.4 nanoseconds. The default value is 102.4.

IPIN IPAUDIO FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPAUDIO FILTERLIST [list]

Lists IPv4 addresses to be included or excluded separated by a space character.

IPIN IPAUDIO USETRACKCOUNT [bool]

Uses track count to specify the number of tracks for the incoming IP stream if True. The default value is False.

IPIN IPAUDIO TRACKCOUNT [count]

Specifies the number of tracks for the incoming IP stream. Valid values for [count] are:

  • 1 Mono

  • 2 Stereo

  • 4 4

  • 8 8

  • 16 16

  • 32 32

  • 64 64

The default value is 8.

IPIN IPAUDIO PACKETDURATION [duration]

Indicates the duration of the incoming audio packet. The packet size (in samples) can be computed using the sample rate (48000 samples/sec) and the packet duration. Valid values for [duration] are:

  • 0 125us

  • 1 250us

  • 2 333us

  • 3 1ms

  • 4 4ms

The default value is 3.

IPIN IPAUDIO_S ADDRESS [address]

Destination IPv4 address. The default value is 239.1.10.12.

IPIN IPAUDIO_S PORT [port]

Destination port. The default value is 50004.

IPIN IPAUDIO_S PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For audio, the range is from 102.4 nanoseconds to 6710681.6 nanoseconds in intervals of 102.4 nanoseconds. The default value is 102.4.

IPIN IPAUDIO_S IGMPV3 FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPAUDIO_S IGMPV3 FILTERLIST [list]

Lists IPv4 addresses to be included or excluded separated by a space character.

IPIN IPANC [bool]

Enables ANC flow if True.

IPIN IPANC ADDRESS [address]

Destination IPv4 address. The default value is 239.0.10.14.

IPIN IPANC PORT [port]

Destination port. The default value is 50006.

IPIN IPANC RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to true. The default value is 100.

IPIN IPANC PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For ancillary data, the range is from 819.2 nanoseconds to 53685452.8 nanoseconds in intervals of 819.2 nanoseconds. The default value is 819.2.

IPIN IPANC FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPANC FILTERLIST [list of ips]

List of IPv4 addresses to be included or excluded separated by a space character.

IPIN IPANC_S ADDRESS [address]

Destination IPv4 address. The default value is 239.1.10.14.

IPIN IPANC_S PORT [port]

Destination port. The default value is 50006.

IPIN IPANC_S PACKETINTERVALTHRESHOLD [threshold]

Indicates the threshold for generating the time interval between the IP packets alarm on the main IP stream. For ancillary data, the range is from 819.2 nanoseconds to 53685452.8 nanoseconds in intervals of 819.2 nanoseconds. The default value is 819.2.

IPIN IPANC_S IGMPV3 FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

IPIN IPANC_S IGMPV3 FILTERLIST [list]

List of IPv4 addresses to be included or excluded separated by a space character.

SFP

[sfp] can be A or B and it refers to the SFP cage.

Note: These parameters are board-wide, meaning that any change done affects any other instances of any application that is using the board. The values for these parameters should be the same for every instance of Channel Recorder that is using the board.

Variable

Value

SFP [sfp] ADDRESS [ip]

Sets IPv4 address. The default value is 10.0.0.3.

SFP [sfp] GATEWAY [ip]

Sets IPv4 gateway. The default value is 10.0.0.1.

SFP [sfp] NETMASK [ip]

Sets IPv4 netmask. The default value is 255.255.255.0.

SFP [sfp] DHCP [bool]

Enable DHCP protocol.

SFP [sfp] TOSDSCP [number]

Specifies a datagram's priority and request a route for low-delay, high-throughput, or highly-reliable service. The default value is 0.

SFP [sfp] DELAYMECHANISM [mechanism]

Specifies the type of network delay mechanism to use for the time server connection. Valid values for [mechanism] are:

  • 1 End-to-End

  • 2 Peer-to-Peer

The default value is End-to-End.

SFP [sfp] IPMODE [mode]

Specifies the type of internet protocol mode to use for the time server connection. Valid values for [mode] are:

  • 1 Multicast

  • 2 Unicast

  • 3 Hybrid

The default value is Multicast.

SFP [sfp] MASTERCLOCKDOMAINNUMBER [number]

Specifies the master clock domain number. The default value is 127.

SFP [sfp] ANNOUNCERECEIPTTIME [number]

Specifies the announce receipt time.

SFP [sfp] JOINTYPE [type]

Indicates the type of membership request made when IPv4 address is a multicast address. Valid values for [type] are:

  • 0 None

  • 1 IGMPv2

  • 2 IGMPv3

The default value is None.

SFP [sfp] IGMPV3 FILTERTYPE [type]

Specifies the type of filtering applied to the source list when IGMPv3 is used. Valid values for [type] are:

  • 1 Inclusion

  • 2 Exclusion

The default value is 1.

SFP [sfp] IGMPV3 FILTERLIST [list of ips]

List of IPv4 addresses to be included or excluded separated by a space character.

2059

Variable

Value

2059 BESTMASTERSELECTION

Specifies the BMCA (Best Master Cock Algorithm) used to select the genlock over IP signal.

PROCESS

Variable

Value

PRIORITY [priority]

Sets the process priority class. The values correspond to the Windows process priority. Valid values for [priority] are:

  • IDLE

  • BELOW_NORMAL

  • NORMAL

  • ABOVE_NORMAL

  • HIGH

  • REALTIME

The default value is REALTIME.

CAPTURE

All the configuration below requires a channel restart. This can be achieved by restarting the service or by calling MAIN CONNECTOR SELECT while Channel Recorder is running.

Variable

Value

CLIP_ROOT [path]

Sets the root folder for the captured files. If the filename in command RECORD CLIP does not contain a absolute path name, the CLIP_ROOT is prepended.

UHD [bool]

Enables detection of UHDTV signals. When set to On, the Channel Recorder scans the signal resolution on the four corresponding input connectors. If four 3G signals are detected, they are interpreted as one UHDTV signal. When set to OFF, the four connectors are treated as separate 3G signals. This flag must be set before selecting a connector using MAIN CONNECTOR SELECT. The default value is Off.

V210 [bool]

Uses the 10-bit surface format V210. This is needed to record XAVC. It also increases performance when for example recording ProRes. This surface format is not supported on the Matrox X.mio2+. This flag must be set before selecting a connector using MAIN CONNECTOR SELECT. The default value is Off.

COLORIMETRY

Specifies the colorimetry to be used to be able to record in HDR. By default, ITUR_BT_601 is used for SD resolution and ITUR_BT_709 for HD and UHD resolution.

VBI [bool]

Turns off VBI recording. The default value is On. This flag must be set before selecting a connector using MAIN CONNECTOR SELECT.

RESOLUTION [resolution]

Sets the default resolution. Format of [resolution] is:
WxHs@F, WxHs@FM, Hs@F, Hs@FM, NTSC, PAL
With W = Width, H = Height, s = Scanmode, F = Framerate, and M = Drop Frame Flag.
Possible values for s are:

  • i or I: Interlaced

  • p or P: Progressive

  • psf or PSF: Progressive segmented

M is optional, and as an alternative, you can use framerate with two decimal points (e.g. 30M = 29.97).
Examples: NTSC, PAL, 1280x720p@50, 1920X1080P@50, 1280x720p@60M, 1280x720p@59.97, 720p50, 720P60M, 1080P50.
This flag must be set before selecting a connector using MAIN CONNECTOR SELECT.

The default value is NTSC.

MULTICONNECTORMODE [mode]

Specifies if an UHD signal is single-link or quad-link. For quad-link inputs, this also specifies how the signal is split. Only used with X.mio5/DSX.LE5 SDI. Valid values are:

  • NONE

  • 2SI

  • SQUARE_DIVISION

SDASPECTRATIO [type]

Specifies the aspect ratio for SD resolution. Available sources are:

  • 4_3

  • 16_9

ALIASNODESOURCE [type]

Specifies the input source of an alias node. Available sources are:

  • INPUT

  • OUTPUT

RESTARTINGDELAY [delay]

Specifies the time in milliseconds before the channel is restarted after detecting a change in resolution.

RESTARTING [bool]

Enable or disable restarting after detecting a change in resolution.

RESOLUTIONDETECTION [bool]

Enable or disable resolution detection.

ALIASNODESOURCE [source]

Specifies the source of the alias node which specify from which output or input connector the application records.

TEST

Variable

Value

PERFORMANCETESTMODE [mode]

Sets the number of audio channels to record. How many channels are actually recorded depends on the codec and the input signal.

MANAGER

Variable

Value

RINGBUFFERSIZE [size]

Sets the size of the capture ring buffer. The default value is 60.

TIMEOUT [timecode]

Sets the timeout for the capture operation in milliseconds. If the recorder reports timeout errors, increasing the timeout could help. Refer to Data Types for information on time code formatting.

PERSISTENCE

Variable

Value

PERSISTENCE [bool]

Turns on persistence for operational data like the config and the timeline. Network changes done by NMOS persist through service restarts. The default value is Off.

PERSISTENCEINTERVAL [seconds]

Sets the interval, at which the data is written to the disk. The value is in seconds and fractions of seconds, meaning both 0.1 and 1.0 are considered valid values. A value of 0 means that every change is written.
The default value is 0.

SCHEDULER

Variable

Value

WRITERSCOUNT [number]

Sets the number of writers to initialize. More writers cause more memory usage. This flag must be set before selecting a connector

TRIGGERTHRESHOLD [frames|timecode]

If a timed command missed the execution time, but is still within the trigger threshold, it is executed late. Outside of this window it is just ignored until the next time the timecode is received. The value can either be a number of frames or a timecode based relative value. The default value is 5 frames.

TIMECODESOURCE [source]

Specifies the timecode source. Available sources are:

  • VITC

  • LTC

  • TIME_OF_DAY

INCLUSIVEOUT [bool]

When enabled the last timecode written to the file is the defined out point of the recording. The default value is NO/FALSE/OFF.

DISCONTINUOUSTC [bool]

When enabled each field / frame uses the timecode calculated from the system time in case of TIME_OF_DAY and ATC/VITC / ATC/LTC embedded in the fields / frames if this is chosen as timecode source. This option is useful to support DST (Daylight Saving Time) or when the input's timecode is expected to have gaps and this must be kept in the recorded file. StartTC will not work when this is enabled. The default value is NO/FALSE/OFF.

LOG

Variable

Value

TCLOGINTERVAL [frames|timecode]

Specifies the interval at which the current timecode is logged. The value can either be a number of frames or a timecode-based relative value. The default value is 0, which means that every full second is logged.

CLIP

For the following parameters to take effect Channel Recorder does not need to be restarted, however, a new recording must be issued.

Variable

Value

FILE_EXTENSION [bool]

Enables or disables automatically adding a file extension to the file name. If this feature is turned off, the client application has full control over the file name. The default value is On. Please refer to Data Types for details on accepted boolean values.

CONTAINER [container type]

Sets the container type of the recorded file. With the container type, a default codec is also set. By setting the container type, a valid recording can be started. Available container types are:

  • AVCINTRAMXF

  • AVI

  • DVCPROMXF

  • MOV

  • MXF

  • XAVCMXF

  • XDCAMMXF

  • DNxHDMXF

Note: To utilize the TDIR capabilities of the ProRes codec with a .mov container in Viz Engine, you must use the .Ref-file

Note: When container is XDCAMMXF, the default codec is XDCam which is HD422. The default bitrate for XDCam, XDCamEX and XDCamHD are 50, 35 and 35 or 25 respectively. XDCamEX outputs 1920x1080 clip at 35 Mbps and XDCamHD outputs 1440x1080 clip at 35 Mbps (VBR) or 25 Mbps (CBR) depending on the bitrate chosen. Refer to the Supported Codecs for further details.

CODEC [codec type]

Sets the codec type of the recorded file. By setting the codec type, default values for bitrate and audio are also set. These values can be changed (Refer to the Supported Codecs for further details). Not all codec types are available with all container types. Available codec types are:

  • DvCam

  • DvCPro

  • Dv50

  • IFrame

  • XDCam

  • XDCamEX

  • XDCamHD

  • AVCIntra50

  • AVCIntra100

  • ProRes

  • XAVC

  • DNxHD

Note: To utilize the TDIR capabilities of the ProRes codec with a .mov container in Viz Engine, you must use the .Ref-file.

Note: When container is XDCAMMXF, the default codec is XDCam which is HD422. The default bitrate for XDCam, XDCamEX and XDCamHD are 50, 35 and 35 respectively. XDCamEX outputs 1920x1080 clip at 35 Mbps and XDCamHD outputs 1440x1080 clip at 35 Mbps (VBR) or 25 Mbps (CBR) depending on the bitrate chosen. Refer to the Supported Codecs for further details.

BITRATE [rate]

Sets the bitrate for the video encoding. The value can either be applied as bits per second or as Megabits per second. Not all codecs allow changes to the bitrate. In such cases, BITRATE is ignored.

IN [timecode]

Sets the default value for the recording start time. The initial value is empty.

OUT [timecode]

Sets the default value for the recording stop time. The initial value is empty.

DURATION [frames|timecode]

Sets the default value for the recording duration. The initial value is 0. When applying a duration to the RECORD START command, the default value is ignored but not changed. Refer to Data Types for information on time code formatting.

STARTTC [timecode]

Sets the default value for the starting timecode. The value must be in timecode format: 00:00:00:00.

AUDIOCHANNELS [channels]

Sets the number of audio channels to record. How many channels are actually recorded depends on the codec and the input signal.

DISKACCESSSIZE [size]

Sets the size of data blocks written to the disk in byte. Postfixes like KiB, Kb, k, etc., are allowed, but must not be separated from the value with a blank space (see example).

  • The default value is 4 MiB (4194304 bytes).

  • The minimum value is 32 KiB (32768 bytes).

  • KiB and k multiplies the value by 1024. kb multiplies the value by 1000.

  • The same works with m for mega and g for giga.

Example: CONFIG SET DISKACCESSSIZE 1024KiB

VBR [bool]

Activates variable bit rates for codecs which support it (currently XAVC only). The default setting is Off.

TDIR [bool]

Sets the default behavior of TDIR (Time Delayed Instant Replay). The default setting is On.

TDIRINTERVAL [time]

Sets the interval of file header updates in TDIR recordings. The value is in seconds and fractions of seconds, meaning both 0.1 and 1.0 are considered valid values. Minimum allowed value is 0.001, which is interpreted by Channel Recorder as every frame. A typical value would be 10.0, the default value is 3.0.

Warning: To secure proper operation with Viz Engine, this value must not exceed 10.0.

TDIRDURATIONPREDEFINED [bool]

Sets the TDIR duration to -1 while the file is growing if enabled. The initial value is Off.

UPDATEMT [bool]

Updates the modification time of the recorded clip regardless of TDIR value. The initial value is On.

STOPATEND [bool]

Sets the default behavior at the end of the recording.

CLOCK

Variable

Value

CLOCKTYPE [type]

Defines the type of clock used. Valid values for [type] are:

  • INPUT

  • GENLOCK

Note: INPUT clock should be use if automatic detection of input is a requirement.

GENLOCKFLYWHEEL [bool]

Uses the flywheel in case of genlock loss, if genlock is used. The default value is Off.

FLYWHEELTIMEOUT [timeout]

Sets the timeout for the genlock flywheel in seconds. This defines the time until the genlock switches to free run, as well as the maximum time the flywheel can use to resynchronize. The initial value is 5.0.

IPOUT

Variable

Value

IPOUT IPVIDEO [bool]

Enables video flow if True.

IPOUT IPVIDEO ADDRESS [address]

Sets destination IPv4 address. The default value is 239.0.12.10.

IPOUT IPVIDEO PORT [port]

Sets destination port. The default value is 50002.

IPOUT IPVIDEO RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to true. The default value is 97.

IPOUT IPAUDIO [bool]

Enables audio flow if True.

IPOUT IPAUDIO ADDRESS [address]

Sets destination IPv4 address. The default value is 239.0.12.12.

IPOUT IPAUDIO PORT [port]

Sets destination port. The default value is 50004.

IPOUT IPAUDIO RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to true. The default value is 98.

IPOUT IPAUDIO USETRACKCOUNT [bool]

Uses track count to specify the number of tracks for the outgoing IP stream if True. The default value is False.

IPOUT IPAUDIO TRACKCOUNT [count]

Specifies the number of tracks for the incoming IP stream. Valid values for [count] are:

  • 1 Mono

  • 2 Stereo

  • 4 4

  • 8 8

  • 16 16

  • 32 32

  • 64 64

The default value is 8.

IPOUT IPAUDIO PACKETDURATION [duration]

Indicates the duration of the incoming audio packet. The packet size (in samples) can be computed using the sample rate (48000 samples/sec) and the packet duration. Valid values for [duration] are:

  • 0 125us

  • 1 250us

  • 2 333us

  • 3 1ms

  • 4 4ms

The default value is 3.

IPOUT IPANC [bool]

Enables ANC flow if True.

IPOUT IPANC ADDRESS [address]

Sets destination IPv4 address. The default value is 239.0.12.14.

IPOUT IPANC PORT [port]

Sets destination port. The default value is 50006.

IPOUT IPANC RTPPAYLOADID [id]

Indicates the RTP (Real-time Transfer Protocol) Payload ID to capture. Used when RTP Payload ID is set to True. The default value is 100.

IPOUT IPANC SMPTE352 [bool]

Enables SMPTE 352 packets if True. The default value is False.

COMMUNICATION

Command

Description

COMMAND_HANDLER PORT SET [port]

Sets the port of the command interface. A port can only be set once.

COMMAND_HANDLER DUMP

Prints this list of available commands.

MVCP PORT [port]

Sets the port for the MVCP communication. This command is required to initialize MVCP.

EXIT

Command

Description

exit, EXIT

Stops all channels, clean up the hardware and stop the service.