Streaming Video Updater Role Parameters

Detailed Description

Collaboration diagram for Streaming Video Updater Role Parameters:

Variables
constexpr const char *	makVre::StreamingVideoUpdaterConfig::defaultStreamChannel = "defaultStreamChannel"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::defaultStreamLabel = "defaultStreamLabel"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::defaultStreamWindow = "defaultStreamWindow"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::readBuffer = "readBuffer"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::streamName = "streamName"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::streamOutputFilenameOverride = "streamOutputFilenameOverride"
constexpr const char *	makVre::StreamingVideoUpdaterConfig::videoStreamAutoStart = "videoStreamAutoStart"

Variable Documentation

defaultStreamChannel

const char* makVre::StreamingVideoUpdaterConfig::defaultStreamChannel = "defaultStreamChannel"

constexpr

Parameter Name	defaultStreamChannel
Parameter Description	Default channel name for video streaming output.
Parameter Type	string
Parameter Default	"Channel 1"
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   defaultStreamChannel = "Channel 1"; 
   ... 
};

defaultStreamLabel

const char* makVre::StreamingVideoUpdaterConfig::defaultStreamLabel = "defaultStreamLabel"

constexpr

Parameter Name	defaultStreamLabel
Parameter Description	Default label for the video stream display.
Parameter Type	string
Parameter Default	"Main Window"
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   defaultStreamLabel = "Main Window"; 
   ... 
};

defaultStreamWindow

const char* makVre::StreamingVideoUpdaterConfig::defaultStreamWindow = "defaultStreamWindow"

constexpr

Parameter Name	defaultStreamWindow
Parameter Description	Default window name for video streaming capture.
Parameter Type	string
Parameter Default	"Window 1"
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   defaultStreamWindow = "Window 1"; 
   ... 
};

readBuffer

const char* makVre::StreamingVideoUpdaterConfig::readBuffer = "readBuffer"

constexpr

Parameter Name	readBuffer
Parameter Description	Buffer selection for video capture (front or back buffer).
Parameter Type	string
Parameter Default	"back"
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   readBuffer = "back"; 
   ... 
};

streamName

const char* makVre::StreamingVideoUpdaterConfig::streamName = "streamName"

constexpr

Parameter Name	streamName
Parameter Description	Name identifier for the video stream configuration.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   streamName = ""; 
   ... 
};

streamOutputFilenameOverride

const char* makVre::StreamingVideoUpdaterConfig::streamOutputFilenameOverride = "streamOutputFilenameOverride"

constexpr

Parameter Name	streamOutputFilenameOverride
Parameter Description	Override filename for stream output file generation.
Parameter Type	string
Parameter Default	""
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   streamOutputFilenameOverride = ""; 
   ... 
};

videoStreamAutoStart

const char* makVre::StreamingVideoUpdaterConfig::videoStreamAutoStart = "videoStreamAutoStart"

constexpr

Parameter Name	videoStreamAutoStart
Parameter Description	Whether to automatically start video streaming when the component initializes.
Parameter Type	bool
Parameter Default	false
Required?	No

Example Role Config Usage:

["streamingVideoUpdater"] = { 
   ... 
   videoStreamAutoStart = false; 
   ... 
};