A message containing a stream status. More...

Inheritance diagram for ramses::StreamStatusMessage:

Collaboration diagram for ramses::StreamStatusMessage:

Public Types
enum class	Status { Ready = 0 , Enabled , Valid , Invalid , Halted , ChannelError , InvalidCommand , VideoResolutionChanged }
	The states of the video decoder on the instrument cluster. More...

Public Member Functions
	StreamStatusMessage (Status status)
	Create a StreamStatusMessage object containing the provided status. More...

Status	getStreamStatus () const
	Returns the contained status. More...

	StreamStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
	Constructor from impl, only for internal usage. More...

Public Member Functions inherited from ramses::DcsmStatusMessage
class StreamStatusMessage const *	getAsStreamStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

class ActiveLayoutMessage const *	getAsActiveLayout () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

class WidgetFocusStatusMessage const *	getAsWidgetFocusStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

virtual	~DcsmStatusMessage ()
	Default destructor of DcsmStatusMessage. More...

	DcsmStatusMessage (DcsmStatusMessage const &)=delete
	Disable copying. More...

	DcsmStatusMessage (DcsmStatusMessage &&)=delete
	Disable moving. More...

Additional Inherited Members
Public Attributes inherited from ramses::DcsmStatusMessage
std::unique_ptr< DcsmStatusMessageImpl >	impl

Protected Member Functions inherited from ramses::DcsmStatusMessage
	DcsmStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
	Constructor from impl. More...

Detailed Description

A message containing a stream status.

Member Enumeration Documentation

strong

The states of the video decoder on the instrument cluster.

Enumerator
Ready	video subsystem ready (ready to accept start command, this is provided in regard of system startup and error condition management).
Enabled	stream enabled (channel is open, no video data available yet).
Valid	stream valid (valid video data has been forwarded to VSPD).
Invalid	stream invalid (video stream does not provide valid video data).
Halted	stream halted (stream has been halted, channels closed).
ChannelError	channel error (channel experienced error, no video).
InvalidCommand	invalid command Error.
VideoResolutionChanged	video resolution changed.

ramses::StreamStatusMessage::StreamStatusMessage ( Status status )

explicit

Create a StreamStatusMessage object containing the provided status.

Parameters

status The status to transmit.

ramses::StreamStatusMessage::StreamStatusMessage ( std::unique_ptr< DcsmStatusMessageImpl > && impl_ )

explicit

Constructor from impl, only for internal usage.

Parameters

impl_ impl

Status ramses::StreamStatusMessage::getStreamStatus ( ) const

Returns the contained status.

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

/home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/DcsmStatusMessage.h