Video Storage
Overview
Use this operator to store video sequences. The storage is started (and the file is created) if a START action has occued, either a general START or a start with a SyncID that corresponds to the SyncID of this operator.Operator ports
Input video In: Specific sample type, see below.Output review video: Video frames
Properties
Find more information about changing properties here: "Properties Viewer"Alias (stream name)
type: See descriptionThe short name (e.g. 'Video', max. 25 characters!) of a video file stream. Not all characters are allowed.
For more information about stream aliases, please refer to "Stream Alias - concept for naming of data files".
AbsolutePath
type: See descriptionThe absolute path to which the video is to be stored (press the button to open a file).
This property should contain a valid path to a file, or nothing. If only a directory is specified, an automatic name is created.
If you select a file here, then Alias will not be used, because you use either a variable stream alias, or a fixed file path.
You may use variables in the file path. For example, you could specify:
D:\Video Files\[$year$,*][$month$,*][$day$,*]_[$hour$,*][$minute$,*][$second$,*].[$alias$,*][$ext$,*]
If you select a file here, then Alias will not be used, because you use either a variable stream alias, or a fixed file path.
You may use variables in the file path. For example, you could specify:
D:\Video Files\[$year$,*][$month$,*][$day$,*]_[$hour$,*][$minute$,*][$second$,*].[$alias$,*][$ext$,*]
FileNameFormat
type: See descriptionThe format of the file name. The default is '[$year$,*][$month$,*][$day$,*]_[$hour$,*][$minute$,*][$second$,*].[$alias$,*].[$ext$,*]'.
FileType
type: UndefinedSelect a file type from the list. The file type is used to save your video data to disk. File Settings will be set to their defaults.
The list shows the file types that are installed on your system. For descriptions per file type, see this: "Installed File Formats".
Warning: if you change the file type, then if the file type has any specific settings, those settings are set to default values!
Warning: if you change the file type, then if the file type has any specific settings, those settings are set to default values!
SyncID
type: See descriptionIf you require the Storage to start or stop separately from other objects, you should refer to the Storage with a SyncID. This is a word or number you can think out yourself.
Caption
type: Word or phraseThe name of the object in the project. This name must not contain '.', '$' nor '@' characters.
For more information about the rules and usage of the Caption property, please refer to "Caption property - background and usage".
Documentation
type: See descriptionOptional documentation of this object. If this object is an operator, the Documentation text is displayed below the operator symbol.
Variable Parameters
Find more information about Variable Parameters here: "Variable Parameters"ReviewFile
type: See descriptionShows the caption of the file that is currently available for review at the output.
RecordingSeconds
type: See descriptionShows the time in seconds the storage is recording signals
RecordingTime
type: See descriptionShows the time video is being recorded, in hours, minutes and seconds
ExportFileInformation
type: Parameter list (see "Parameter List")Contains a list of read-only texts about the file that is currently being stored, such as the file path and start date and time.
ImportFileInformation
type: Parameter list (see "Parameter List")Contains a list of read-only texts about the file that is currently open for reviewers at the output of the Video Storage operator, such as the file path and start date and time.
Details
Starting behaviorIf a START action is performed in a project, the Video Storage checks if it should start storing video frames. Whether the Video Storage starts, depends on its SyncID property. If the SyncID has not been set (empty setting), the Video Storage will start on any START action, also if the START action has a SyncID value set. If the Video Storage does define a SyncID, it will only start storing the video signal at its input if a START action is issued with that SyncID code in its Value (see Actions "Actions - Overview" for more details).
Stopping behavior
If a STOP action is performed in a project, the Video Storage operator checks if it should stop storing video frames that comes in at its input. Whether storing is stopped again depends on the SyncID setting, but in a different way as for starting: the Video Storage stops if no SyncID has been defined in the STOP action (a so called 'general stop'), or if the SyncID specified for the STOP action equals the SyncID value of the Storage operator. Of course, if the no video signal is offered at the input of the Video Storage anymore, storing automatically stops.