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 will then be 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.

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 Prefix to the filename. It will be appended with the timestamp of the start time.

• POSTFIX Postfix to the filename. Will be appended after the timestamp.

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

• CHUNK 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 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 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.

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 Set 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 Set the codec type of the recorded file. By setting the codec type, default values for bitrate and audio will also be set.

• BITRATE Set 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 will be ignored.

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

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

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

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

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

• DISKACCESSSIZE Set 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 Set whether the recorded file, when the format supports it, should be in VBR (Variable Bit Rate) or not.

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

• TDIRINTERVAL Set 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.

• UPDATEMT Update the modification time of the recorded clip regardless of TDIR value. The initial value is ON.

• STOPATEND Set 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 will be returned for all values. If no [key] is provided, all values of the applied keys will be 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 will return this property for all clips. A special [key] is TIMELINE, which returns all entries in the timeline.

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 (e.g. container / codec combination is wrong).

 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.

IPIN SDIIP ADDRESS [address]

Destination IPv4 address. The default value is 239.0.10.10.

IPIN SDIIP PORT [port]

Destination port. The default value is 50002.

IPIN SDIIP PACKETINTERVALTHRESHOLD [threshold]

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

IPIN SDIIP 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]

If true, enables video flow.

IPIN IPVIDEO ADDRESS [address]

Destination IPv4 address. The default value is 239.0.10.10.

IPIN IPVIDEO PORT [port]

Destination port. The default value is 50002.

IPIN IPVIDEO RTPPAYLOADIDFILTERING [bool]

If true, the RTP Payload ID value will be used to filter the incoming network packets.

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 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 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 IPAUDIO FILTERLIST [list of ips]

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

IPIN IPAUDIO [bool]

If true, enables audio flow.

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 RTPPAYLOADIDFILTERING [bool]

If true, the RTP Payload ID value will be used to filter the incoming network packets.

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 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 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 IPAUDIO FILTERLIST [list of ips]

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

IPIN IPAUDIO USETRACKCOUNT [bool]

If true, uses track count to specify the number of tracks for the incoming IP stream. The default value is OFF.

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 IPANC [bool]

If true, enables ANC flow.

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 RTPPAYLOADIDFILTERING [bool]

If true, the RTP Payload ID value will be used to filter the incoming network packets. The default value is OFF.

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 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 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.

SFP [sfp] ADDRESS [ip]

IPv4 address. The default value is 10.0.0.3.

SFP [sfp] GATEWAY [ip]

IPv4 gateway. The default value is 10.0.0.1.

SFP [sfp] NETMASK [ip]

IPv4 netmask. The default value is 255.255.255.0.

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] 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] 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] FILTERLIST [list of ips]

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

2059 BESTMASTERSELECTION

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

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.

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 will be 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.

ALIASNODESOURCE [source]

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

PERFORMANCETESTMODE [mode]

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

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 [bool]

Turns on persistence for operational data like the config and the timeline. 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.

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.

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. Known container types are:

• AVCINTRAMXF (See note regarding audio and timecode support)

• AVI

• DVCPROMXF (See note regarding audio and timecode support)

• MOV

• MXF (See note regarding audio and timecode support)

• XAVCMXF (See note regarding audio and timecode support) (Requires a Matrox M264 card in order to work)

• XDCAMMXF (See note regarding audio and timecode support)

CODEC [codec type]

Sets the codec type of the recorded file. By setting the codec type, default values for bitrate and audio will also be set. These values can be changed (see below). Not all codec types are available with all container types. Available codec types are:

• DvCam

• DvCPro

• Dv50

• IFrame

• XDCam (See note regarding bitrates specification)

• XDCamEX (See note regarding bitrates specification)

• XDCamHD (See note regarding bitrates specification)

• AVCIntra50

• AVCIntra100

• ProRes

• XAVC

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 will be 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.

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.

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.

CLOCKTYPE [type]

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

• INPUT

• GENLOCK

GENLOCKFLYWHEEL [bool]

If genlock is used, also use the flywheel in case of genlock loss. 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 SDIIP ADDRESS [address]

Destination IPv4 address. The default value is 239.0.12.10.

IPOUT SDIIP PORT [port]

Destination port. The default value is 50002.

IPOUT IPVIDEO [bool]

If true, enables video flow.

IPOUT IPVIDEO ADDRESS [address]

Destination IPv4 address. The default value is 239.0.12.10.

IPOUT IPVIDEO PORT [port]

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]

If true, enables audio flow.

IPOUT IPAUDIO ADDRESS [address]

Destination IPv4 address. The default value is 239.0.12.12.

IPOUT IPAUDIO PORT [port]

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]

If true, uses track count to specify the number of tracks for the outgoing IP stream. The default value is OFF.

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]

If true, enables ANC flow.

IPOUT IPANC ADDRESS [address]

Destination IPv4 address. The default value is 239.0.12.14.

IPOUT IPANC PORT [port]

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]

If true, enables SMPTE 352 packets. The default value is OFF.

SHMOUT SHMNAME [name]

Shared memory name. The default value is SHM_CR.

SHMOUT ADDRESS [address]

Destination IPv4 address. The default value is 127.0.0.1.

SHMOUT PORT [port]

Destination port. The default value is 10002.