VideoWriterInventor

MLModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLVideoWriter
definition MLVideoWriter.def
see also VideoWriterML
inherits from OffscreenRenderer
keywords video, movie

Purpose

The VideoWriterInventor module is derived from the OffscreenRenderer module. It renders a given Open Inventor scenes and writes the resulting images to a video stream.

Usage

Connect an Open Inventor scene to the input of the VideoWriterInventor module. Specify the size and frame rate for the target video. Use the Create New Video field to open a video stream. Trigger the Write Frame field to render the attached scene and write a single frame into the video stream. When finished, trigger the Finish Video field to close the video stream.

Windows

Default Panel

../../../Modules/ML/MLVideoWriter/mhelp/Images/Screenshots/VideoWriterInventor._default.png

Input Fields

sceneGraph

name: sceneGraph, type: SoNode

The field for connecting the input scene.

Parameter Fields

Field Index

availableFrameQueueSpace: Integer fourcc: String stencilBuffer: Bool
availCodecsList: String Frames Per Second: Integer supported: Bool
bgColor: Color Image Format: String update: Trigger
bufferType: Enum isImageSourceValid: Bool updateAvailableFrameQueueSpace: Trigger
Create New Video: Trigger isVideoFileOpen: Bool Write Frame: Trigger
Current Error: String pixelScale: Float Write Images Instead Of Video: Bool
Duration (in seconds): Float quality: Float writeFrameFPS: Double
enableMultiSampling: Bool renderFPS: Double Written Frames: Integer
Filename: String selectedCodec: String  
Finish Video: Trigger Size: Vector2  

Visible Fields

Size

name: size, type: Vector2, default: 64 64

see OffscreenRenderer.size

Current Error

name: currentError, type: String, persistent: no

Contains the current error or an empty string if no error occurred.

Written Frames

name: frameCounter, type: Integer, persistent: no

Counts the number of written frames.

Duration (in seconds)

name: duration, type: Float, persistent: no

Contains the duration of the video in seconds.

Frames Per Second

name: framesPerSecond, type: Integer, default: 30

Contains the frame rate in frames per second.

Create New Video

name: createNewVideo, type: Trigger

Opens a new video stream.

Finish Video

name: finishVideo, type: Trigger

Closes an open video stream.

Filename

name: filename, type: String

Contains the filename of the video file.

Write Frame

name: writeFrame, type: Trigger

Triggers rendering the scene and writes it as a single frame into the video stream.

Write Images Instead Of Video

name: writeImagesInsteadOfVideo, type: Bool, default: FALSE

Image Format

name: imageFormat, type: String, default: png

Hidden Fields

bufferType

name: bufferType, type: Enum, default: AUTO

see OffscreenRenderer.bufferType

supported

name: supported, type: Bool, default: TRUE

see OffscreenRenderer.supported

stencilBuffer

name: stencilBuffer, type: Bool, default: FALSE

see OffscreenRenderer.stencilBuffer

pixelScale

name: pixelScale, type: Float, default: 1

see OffscreenRenderer.pixelScale

bgColor

name: bgColor, type: Color, default: 0 0 0

see OffscreenRenderer.bgColor

update

name: update, type: Trigger

see OffscreenRenderer.update

enableMultiSampling

name: enableMultiSampling, type: Bool, default: FALSE

see OffscreenRenderer.enableMultiSampling

isImageSourceValid

name: isImageSourceValid, type: Bool, persistent: no

Indicates whether the image source is valid, i.e. if an Inventor scene is connected.

availCodecsList

name: availCodecsList, type: String, persistent: no

selectedCodec

name: selectedCodec, type: String, persistent: no

fourcc

name: fourcc, type: String, default: H264

Contains the four character code of the used codec.

quality

name: quality, type: Float, default: 30

Specifies the encoding quality (this depends on the chosen codec).

renderFPS

name: renderFPS, type: Double, persistent: no

writeFrameFPS

name: writeFrameFPS, type: Double, persistent: no

isVideoFileOpen

name: isVideoFileOpen, type: Bool, persistent: no

Indicates whether a video stream is open.

updateAvailableFrameQueueSpace

name: updateAvailableFrameQueueSpace, type: Trigger

availableFrameQueueSpace

name: availableFrameQueueSpace, type: Integer, persistent: no