disk-consumer

disk-consumer — A consumer that archives a stream to disk.

Properties

symlink-to-last-recording

If set, this symlink will be created and will point to the latest finished recording.

Type: string

Optional property. Single values only.

start-recording

Whether to start recording when the component starts (defaults to True).

Type: bool

Optional property. Single values only.

stream-marker-filename-prefix

The formatting template for the program id (default '%03d.').

Type: string

Optional property. Single values only.

filename

If set, the given template will be used to decide filenames for recordings. The template will be expanded according to strftime(3).

Type: string

Optional property. Single values only.

react-to-stream-markers

Whether to start/stop the disker when stream marker events are received.

Type: bool

Optional property. Single values only.

time

The maximum duration of each file (in seconds).

Type: long

Optional property. Single values only.

directory

The directory to which to save the archives.

Type: string

Required property. Single values only.

rotate-type

'size', 'time', or 'none' (default 'none').

Type: string

Optional property. Single values only.

ical-schedule

If set, the given iCalendar schedule will be used to decide when to record. Every event defined indicates a recording, and the event description will be used as the filename template.

Type: string

Optional property. Single values only.

symlink-to-current-recording

If set, this symlink will be created and will point to the latest started recording.

Type: string

Optional property. Single values only.

size

The maximum size of each file (in bytes).

Type: long

Optional property. Single values only.