gva::WidgetVideo Class Reference

Class defining the video widget. More...

#include <video.h>

Inheritance diagram for gva::WidgetVideo:

Collaboration diagram for gva::WidgetVideo:

Public Member Functions
	WidgetVideo (const RendererGva &renderer)
	Construct a new Widget video object.
	~WidgetVideo () final
	Destroy the Widget video object.
void	SetReceiveTimeout (uint32_t timeout_ms)
	Set the Receive timeout attribute for frame data, default 80ms.
void	Draw () final
	This will update the video frame if one available.
void	Start ()
	Start the video stream.
void	Stop ()
	Stop the video stream.
void	SetSessionName (std::string_view session_name)
	Set the Session Name attribute.
void	SetIpAddress (std::string_view ip_address)
	Set the Ipaddress attribute.
Public Member Functions inherited from gva::WidgetCanvas
	WidgetCanvas (const RendererGva &renderer)
	Construct a new Widget Keyboard object.
	~WidgetCanvas () override=default
	Destroy the Widget mode object.
std::string	GetWidgetName () const final
	Get the Widget Name attribute.
void	DrawCanvas ()
	Draw the canvas.
void	SetMode (const SurfaceType mode)
	Set the Mode object.
SurfaceType	GetMode () const
	Get the Mode object.
void	SetBlackout ()
	Set Blackout mode.
bool	GetBlackout () const
	Get the Blackout attribute.
void	SetFilename (const std::string_view filename)
	Set the Filename attribute, canvas will show the image. Image will be rescaled to fit current resolution.
void	SetSurface (cairo_surface_t *surface)
	Set the canvas to surface.
void	SetSurfaceDefault ()
	Set the Surface to the default background.
void	Reset ()
	Set to default background.
Public Member Functions inherited from gva::WidgetX
	WidgetX (const RendererGva &renderer, widget::WidgetEnum widget_type)
	Construct a new Widget X object.
virtual widget::WidgetEnum	GetWidgetType () const
	Get the Widget Type attribute.
void	SetVisible (bool visible)
	Set the Visible object.
bool	GetVisible () const
	Get the Visible object.
virtual void	SetX (uint32_t x)
	Set the X dimension.
uint32_t	GetX () const
	Get the Y dimension.
virtual void	SetY (uint32_t y)
	Set the Y dimension.
uint32_t	GetY () const
	Get the Y dimension.
void	SetWidth (uint32_t width)
	Set the Width.
uint32_t	GetWidth () const
	Get the Width.
void	SetHeight (uint32_t width)
	Set the Height.
uint32_t	GetHeight () const
	Get the Height.
widget::WidgetEnum	GetType () const
	Get the Type object.
RendererGva *	GetRenderer () const
	Get the Renderer object.
void	SetStateText (LabelStates state)
	Set the State Text of an on screen label.
void	SetStateLabel (const LabelStates state)
	Set the State Label object.
uint32_t	GetStateTextColour (LabelStates state) const
	Get the State Text Colour object.

Additional Inherited Members
Data Fields inherited from gva::WidgetX
uint32_t	x_ = 0
	The widget x location in pixels.
uint32_t	y_ = 0
	The widget y location in pixels.
uint32_t	width_ = 0
	The widget width in pixels.
uint32_t	height_ = 0
	The widget height in pixels.

Detailed Description

Class defining the video widget.

Constructor & Destructor Documentation

WidgetVideo()

gva::WidgetVideo::WidgetVideo ( const RendererGva &  renderer )

explicit

Construct a new Widget video object.

Parameters

renderer

Member Function Documentation

Draw()

void gva::WidgetVideo::Draw ( )

finalvirtual

This will update the video frame if one available.

Reimplemented from gva::WidgetCanvas.

SetIpAddress()

void gva::WidgetVideo::SetIpAddress

(

std::string_view

ip_address

)

Set the Ipaddress attribute.

Parameters

ip_address

the IPV4 address of the video stream

SetSessionName()

void gva::WidgetVideo::SetSessionName

(

std::string_view

session_name

)

Set the Session Name attribute.

Parameters

session_name

The SAP/SDP session name

---

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

• src/hmicore/widgets/canvas/video.h
• src/hmicore/widgets/canvas/video.cc