DtVideoStreamConfigurationInterface is the abstract interface for a video stream configuration widget. All factory-creatable video stream configuration widgets inherit this class. This is a windowing system independent interface that can be used by the associated logic to communicate with the GUI.

Inheritance diagram for makVrv::DtVideoStreamConfigurationInterface:

[legend]

Public Types
enum	VideoStreamState { Stopped, Started, Suspended, Unavailable }

Public Member Functions
	DtVideoStreamConfigurationInterface ()

virtual	~DtVideoStreamConfigurationInterface ()

virtual void	activate ()=0

virtual void	setCurrentWindowName (const DtUnicode &windowName)=0

virtual void	addWindowName (const DtUnicode &windowName)=0

virtual void	removeWindowName (const DtUnicode &windowName)=0

virtual void	setCurrentChannelName (const DtUnicode &channelName)=0

virtual void	addChannelName (const DtUnicode &channelNames)=0

virtual void	removeChannelName (const DtUnicode &channelNames)=0

virtual void	setCurrentFrameRate (int frameRate)=0

virtual void	setCurrentNumBuffers (int numBuffers)=0

virtual void	setCurrentReadBuffer (const DtUnicode &readBuffer)=0

virtual void	setCurrentEncodingMethod (bool useGPU)=0

virtual void	setCurrentEncodingFormat (const DtUnicode &encodingFormat)=0

virtual void	setReadBufferValues (const std::list< DtUnicode > &data, const std::list< DtUnicode > &names)=0

virtual void	setEncodingMethodValues (const std::list< DtUnicode > &names)=0

virtual void	setEncodingFormatValues (const std::list< DtUnicode > &names)=0

virtual void	setImageTaskTypesAndNames (const std::list< DtUnicode > &taskTypes, const std::list< DtUnicode > &taskNames)=0

virtual void	setMetadataPublisherTypesAndNames (const std::list< DtUnicode > &publisherTypes, const std::list< DtUnicode > &publisherNames)=0

virtual void	addImageTask (int index, const makArchives::DtImageTaskRecord &task)=0

virtual void	removeImageTask (int index)=0

virtual void	setImageTask (int index, const makArchives::DtImageTaskRecord &task)=0

virtual void	swapImageTasks (int index1, int index2)=0

virtual void	setImageTaskMoveUpArrowEnabled (int index, bool enabled)=0

virtual void	setImageTaskMoveDownArrowEnabled (int index, bool enabled)=0

virtual void	setMetadataCheckBox (bool onOff)=0

virtual void	setWindowChannelNameWarningLabel (bool warn)=0

virtual void	disableMetadataPublishers ()=0

virtual void	setMetadataPublisherVisible (bool visible)=0

virtual void	setMetadataPublisherType (const DtUnicode &publisherType)=0

virtual void	setActionButtonState (VideoStreamState state)=0

virtual void	setVideoStreamAutoStartState (bool autoStart)=0

virtual bool	enable32BitTextureReadback ()=0

Public Attributes
boost::signalslib::signal < void(const DtUnicode &)>	signal_windowNameSelectionChanged

boost::signalslib::signal < void(const DtUnicode &)>	signal_channelNameSelectionChanged

boost::signalslib::signal < void(int)>	signal_frameRateSelectionChanged

boost::signalslib::signal < void(int)>	signal_numBuffersSelectionChanged

boost::signalslib::signal < void(const DtUnicode &)>	signal_readBufferSelectionChanged

boost::signalslib::signal < void(const DtUnicode &)>	signal_encodingMethodSelectionChanged

boost::signalslib::signal < void(const DtUnicode &)>	signal_encodingFormatSelectionChanged

boost::signalslib::signal < void(int)>	signal_metadataPublisherIncludedChanged

boost::signalslib::signal < void(const DtUnicode &)>	signal_metadataPublisherTypeSelectionChanged

boost::signalslib::signal < void(int index, const DtUnicode &taskType)>	signal_imageTaskTypeChanged

boost::signalslib::signal< void()>	signal_addImageTaskPressed

boost::signalslib::signal < void(int index)>	signal_deleteImageTaskPressed

boost::signalslib::signal < void(int index)>	signal_moveImageTaskUpPressed

boost::signalslib::signal < void(int index)>	signal_moveImageTaskDownPressed

boost::signalslib::signal< void()>	signal_toggleVideoStreamState

boost::signalslib::signal< void()>	signal_toggleCurrentVideoStreamAutoStartState

Member Enumeration Documentation

enum makVrv::DtVideoStreamConfigurationInterface::VideoStreamState

Enumerate the possible video states.

Enumerator
Stopped	Not streaming (but available)
Started	Currently Streaming.
Suspended	Not implemented.
Unavailable	Not streaming and not available, because some other video stream is streaming on the same window/channel.

Constructor & Destructor Documentation

makVrv::DtVideoStreamConfigurationInterface::DtVideoStreamConfigurationInterface ( )

CTOR.

virtual makVrv::DtVideoStreamConfigurationInterface::~DtVideoStreamConfigurationInterface ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtVideoStreamConfigurationInterface::activate ( )

pure virtual

Create the logic element.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentWindowName ( const DtUnicode & windowName )

pure virtual

Set the window name to display in the window selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::addWindowName ( const DtUnicode & windowName )

pure virtual

Add a window name to the window selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::removeWindowName ( const DtUnicode & windowName )

pure virtual

Remove a window name from the window selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentChannelName ( const DtUnicode & channelName )

pure virtual

Set the channel name to display in the channel selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::addChannelName ( const DtUnicode & channelNames )

pure virtual

Add a channel name to the channel selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::removeChannelName ( const DtUnicode & channelNames )

pure virtual

Remove a channel name from the channel selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentFrameRate ( int frameRate )

pure virtual

Set the value of the frame rate widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentNumBuffers ( int numBuffers )

pure virtual

Set the value of the number of buffers widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentReadBuffer ( const DtUnicode & readBuffer )

pure virtual

Set the value of the read buffer type widget, e.g. "back".

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentEncodingMethod ( bool useGPU )

pure virtual

Set the value of the encoding method selection widget. This function expects a boolean which, when true, means to use the GPU for encoding. Otherwise, use the CPU for encoding.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setCurrentEncodingFormat ( const DtUnicode & encodingFormat )

pure virtual

Set the value of the encoding format selection widget. This function expects a string containing "h264" or "h265". This is only associated with GPU encoding.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setReadBufferValues	(	const std::list< DtUnicode > &	data,
		const std::list< DtUnicode > &	names
	)

pure virtual

Set the allowable values for readBuffer; this populates the read buffer selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setEncodingMethodValues ( const std::list< DtUnicode > & names )

pure virtual

Set the allowable values for encoding method; this populates the encoding method selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setEncodingFormatValues ( const std::list< DtUnicode > & names )

pure virtual

Set the allowable values for encoding format; this populates the encoding format selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setImageTaskTypesAndNames	(	const std::list< DtUnicode > &	taskTypes,
		const std::list< DtUnicode > &	taskNames
	)

pure virtual

Provide the list of all process image tasks currently supported. The widget maintains this list, making it available to process ismage task configuration widgets as they are added to the image task pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setMetadataPublisherTypesAndNames	(	const std::list< DtUnicode > &	publisherTypes,
		const std::list< DtUnicode > &	publisherNames
	)

pure virtual

Provide the list of all metadata plublisher types currently supported. This populates the metadata publisher selection widget.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::addImageTask	(	int	index,
		const makArchives::DtImageTaskRecord &	task
	)

pure virtual

Add an image task to the image task pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::removeImageTask ( int index )

pure virtual

Remove an image task from the image task pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setImageTask	(	int	index,
		const makArchives::DtImageTaskRecord &	task
	)

pure virtual

Specify the process image task that should be at the location indicated by index in the image task pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::swapImageTasks	(	int	index1,
		int	index2
	)

pure virtual

Swap the image tasks at the pipeline at the specified indices.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setImageTaskMoveUpArrowEnabled	(	int	index,
		bool	enabled
	)

pure virtual

Enable or disable the move up arrow button for the image task at the specified index in the pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setImageTaskMoveDownArrowEnabled	(	int	index,
		bool	enabled
	)

pure virtual

Enable or disable the move down arrow button for the image task at the specified index in the pipeline.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setMetadataCheckBox ( bool onOff )

pure virtual

Set the value of the metadata checkbox. This widget indicates whether a metadata publisher is included in this video stream.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setWindowChannelNameWarningLabel ( bool warn )

pure virtual

Set the state of the window warning label. This label is shown When the selected window name does not exist.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::disableMetadataPublishers ( )

pure virtual

Called during initialization if there are no metadata publisher plugins installed. Causes everything related to metadata publishers to be removed from the dialog.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setMetadataPublisherVisible ( bool visible )

pure virtual

Set whether the metadata publisher selection widget is shown.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setMetadataPublisherType ( const DtUnicode & publisherType )

pure virtual

Set the selected metadata publisher type (if shown)

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setActionButtonState ( VideoStreamState state )

pure virtual

Set the state of the action button (start / stop )

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual void makVrv::DtVideoStreamConfigurationInterface::setVideoStreamAutoStartState ( bool autoStart )

pure virtual

Set the state of the auto start button.

Implemented in makVrv::DtVideoStreamConfigurationWidget.

virtual bool makVrv::DtVideoStreamConfigurationInterface::enable32BitTextureReadback ( )

pure virtual

used to protect the 32bit texture readback video stream from being used with SensorFX without the toolkit

Implemented in makVrv::DtVideoStreamConfigurationWidget.

Member Data Documentation

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_windowNameSelectionChanged

Signal raised by the widget when a window name is selected.

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_channelNameSelectionChanged

Signal raised by the widget when a channel name is selected.

boost::signalslib::signal<void ( int )> makVrv::DtVideoStreamConfigurationInterface::signal_frameRateSelectionChanged

Signal raised by the widget when a frame rate is selected.

boost::signalslib::signal<void ( int )> makVrv::DtVideoStreamConfigurationInterface::signal_numBuffersSelectionChanged

Signal raised by the widget when a buffer count is selected.

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_readBufferSelectionChanged

Signal raised by the widget when a read buffer type is selected.

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_encodingMethodSelectionChanged

Signal raised by the widget when an encoding method is selected.

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_encodingFormatSelectionChanged

Signal raised by the widget when an encoding format is selected.

boost::signalslib::signal<void ( int )> makVrv::DtVideoStreamConfigurationInterface::signal_metadataPublisherIncludedChanged

Signal raised by the widget when inclusion or exclusion of a metadata publisher is selected.

boost::signalslib::signal<void ( const DtUnicode& )> makVrv::DtVideoStreamConfigurationInterface::signal_metadataPublisherTypeSelectionChanged

Signal raised by the widget when a metadata publisher type is selected.

boost::signalslib::signal<void( int index, const DtUnicode& taskType )> makVrv::DtVideoStreamConfigurationInterface::signal_imageTaskTypeChanged

Signal raised by the widget when a process image task type is selected.

boost::signalslib::signal<void()> makVrv::DtVideoStreamConfigurationInterface::signal_addImageTaskPressed

Signal raised by the widget when the addition of a process image task is indicated.

boost::signalslib::signal<void( int index )> makVrv::DtVideoStreamConfigurationInterface::signal_deleteImageTaskPressed

Signal raised by the widget when the deletion of a process image task is indicated.

boost::signalslib::signal<void( int index )> makVrv::DtVideoStreamConfigurationInterface::signal_moveImageTaskUpPressed

Signal raised by the widget when the move up button of a process image task is pressed.

boost::signalslib::signal<void( int index )> makVrv::DtVideoStreamConfigurationInterface::signal_moveImageTaskDownPressed

Signal raised by the widget when the move down button of a process image task is pressed.

boost::signalslib::signal<void( )> makVrv::DtVideoStreamConfigurationInterface::signal_toggleVideoStreamState

Signal raised by the widget when the action button is pressed, indicating that the video stream should be started or stopped.

boost::signalslib::signal<void ()> makVrv::DtVideoStreamConfigurationInterface::signal_toggleCurrentVideoStreamAutoStartState

Signal raised by the widget when the auto start button is pressed, enabling or disabling auto start for the video stream.

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvVideoStreamQt/DtVideoStreamConfigurationInterface.h

Public Types

Public Member Functions

Public Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation