VideoWidget

touchgfx/widgets/VideoWidget.hpp

A Widget for displaying video. The Widget interacts with a VideoController instance.

Inherits from: Widget, Drawable

Public Functions


void	clearMovieEndedAction()
	Clears the movie ended action previously set by setMovieEndedAction.

virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.

uint32_t	getCurrentFrameNumber() const
	Get the current frame number.

virtual Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).

void	getVideoInformation(VideoInformation * data) const
	Get Video information.

virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.

bool	isPlaying() const
	Check if the video is playing (not paused or stopped).

void	pause() const
	Pause the video.

void	play() const
	Play the video.

void	seek(uint32_t frameNumber) const
	Seek to specific frame.

void	setFrameRate(uint32_t ui_frames, uint32_t video_frames) const
	Sets the frame rate of the video.

void	setMovieEndedAction(GenericCallback< const VideoWidget & > & callback)
	Associates an action to be performed when the movie has ended.

void	setRepeat(bool repeat) const
	Set repeat mode.

void	setVideoBuffer(uint8_t *const videoBuffer)
	Set video buffer data.

void	setVideoBufferFormat(Bitmap::BitmapFormat bufferFormat, int16_t width, int16_t height)
	Set video buffer format.

void	setVideoData(const uint8_t * movie, const uint32_t length)
	Set the video data for the stream.

void	setVideoData(VideoDataReader & reader)
	Set the video data for the stream.

void	showFrame(uint32_t frameNumber) const
	Seek to a specific frame and update the display.

void	stop() const
	Stop the video.

	VideoWidget()
	Default constructor.

virtual	~VideoWidget()
	Destructor.

Additional inherited members


virtual void	getLastChild(int16_t , int16_t , Drawable ** last)
	Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

Public Functions inherited from Drawable


void	center()
	Centers the Drawable inside its parent.

void	centerX()
	Center the Drawable horizontally inside its parent.

void	centerY()
	Center the Drawable vertically inside its parent.

virtual void	childGeometryChanged()
	This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.

	Drawable()
	Initializes a new instance of the Drawable class.

void	drawToDynamicBitmap(BitmapId id)
	Render the Drawable object into a dynamic bitmap.

void	expand(int margin =0)
	Expands the Drawable to have the same size as its parent with a given margin around the edge.

Rect	getAbsoluteRect() const
	Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.

virtual Drawable *	getFirstChild()
	Function for obtaining the first child of this drawable if any.

int16_t	getHeight() const
	Gets the height of this Drawable.

virtual void	getLastChild(int16_t x, int16_t y, Drawable ** last) =0
	Function for obtaining the the last child of this drawable that intersects with the specified point.

Drawable *	getNextSibling()
	Gets the next sibling node.

Drawable *	getParent() const
	Returns the parent node.

const Rect &	getRect() const
	Gets the rectangle this Drawable covers, in coordinates relative to its parent.

virtual Rect	getSolidRectAbsolute()
	Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.

virtual void	getVisibleRect(Rect & rect) const
	Function for finding the visible part of this drawable.

int16_t	getWidth() const
	Gets the width of this Drawable.

int16_t	getX() const
	Gets the x coordinate of this Drawable, relative to its parent.

int16_t	getY() const
	Gets the y coordinate of this Drawable, relative to its parent.

virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.

virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.

virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.

virtual void	invalidate() const
	Tell the framework that this entire Drawable needs to be redrawn.

virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.

virtual void	invalidateRect(Rect & invalidatedArea) const
	Request that a region of this drawable is redrawn.

bool	isTouchable() const
	Gets whether this Drawable receives touch events or not.

bool	isVisible() const
	Gets whether this Drawable is visible.

virtual void	moveRelative(int16_t x, int16_t y)
	Moves the drawable.

virtual void	moveTo(int16_t x, int16_t y)
	Moves the drawable.

virtual void	setHeight(int16_t height)
	Sets the height of this drawable.

void	setPosition(const Drawable & drawable)
	Sets the position of the Drawable to the same as the given Drawable.

void	setPosition(int16_t x, int16_t y, int16_t width, int16_t height)
	Sets the size and position of this Drawable, relative to its parent.

void	setTouchable(bool touch)
	Controls whether this Drawable receives touch events or not.

void	setVisible(bool vis)
	Controls whether this Drawable should be visible.

virtual void	setWidth(int16_t width)
	Sets the width of this drawable.

void	setWidthHeight(const Bitmap & bitmap)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).

void	setWidthHeight(const Drawable & drawable)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).

void	setWidthHeight(const Rect & other)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).

void	setWidthHeight(int16_t width, int16_t height)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).

virtual void	setX(int16_t x)
	Sets the x coordinate of this Drawable, relative to its parent.

void	setXY(const Drawable & drawable)
	Sets the x and y coordinates of this Drawable.

void	setXY(int16_t x, int16_t y)
	Sets the x and y coordinates of this Drawable, relative to its parent.

virtual void	setY(int16_t y)
	Sets the y coordinate of this Drawable, relative to its parent.

virtual void	translateRectToAbsolute(Rect & r) const
	Helper function for converting a region of this Drawable to absolute coordinates.

virtual	~Drawable()
	Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable


Drawable *	nextSibling
	Pointer to the next Drawable.

Drawable *	parent
	Pointer to this drawable's parent.

Rect	rect
	The coordinates of this Drawable, relative to its parent.

bool	touchable
	True if this drawable should receive touch events.

bool	visible
	True if this drawable should be drawn.

Public Functions Documentation

clearMovieEndedAction


void clearMovieEndedAction	(			)

Clears the movie ended action previously set by setMovieEndedAction.

See also:

setMovieEndedAction

draw

Draw this drawable.

It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.

Parameters:


invalidatedArea	The sub-region of this drawable that needs to be redrawn, expressed in coordinates relative to its parent (e.g. for a complete redraw, invalidatedArea will be (0, 0, width, height).

Reimplements: touchgfx::Drawable::draw

getCurrentFrameNumber


uint32_t getCurrentFrameNumber	(			)	const

Get the current frame number.

Returns:

Returns the current frame number.

getSolidRect


virtual Rect getSolidRect	(			)	const

Get (the largest possible) rectangle that is guaranteed to be solid (opaque).

This information is important, as any Drawable underneath the solid area does not need to be drawn.

Returns:

The solid rectangle part of the Drawable.

Note

The rectangle returned must be relative to upper left corner of the Drawable, meaning that a completely solid widget should return the full size Rect(0, 0, getWidth(), getHeight()). If no area can be guaranteed to be solid, an empty Rect must be returned. Failing to return the correct rectangle may result in errors on the display.

Reimplements: touchgfx::Drawable::getSolidRect

getVideoInformation

Get Video information.

Get information from the video data.

Parameters:


data	Pointer to VideoInformation where information should be stored.

handleTickEvent


virtual void handleTickEvent	(			)

Called periodically by the framework if the Drawable instance has subscribed to timer ticks.

See also:

Application::registerTimerWidget

Reimplements: touchgfx::Drawable::handleTickEvent

isPlaying


bool isPlaying	(			)	const

Check if the video is playing (not paused or stopped).

Returns:

Returns true if the video is playing.

pause


void pause	(			)	const

Pause the video.

play


void play	(			)	const

Play the video.

seek

Seek to specific frame.

Frame number 1 is the first frame. The display is not updated updated unless the video is playing.

Parameters:


frameNumber	The frame number to seek to.

See also:

showFrame

setFrameRate


void setFrameRate	(	uint32_t	ui_frames ,	const
		uint32_t	video_frames	const
		)	const

Sets the frame rate of the video.

To get 20 video frames pr second on a 60 fps display use video_frames = 20 and ui_frames = 60.

Parameters:


ui_frames	Number of UI frames (divider)
video_frames	Number of video_frames (dividend)

setMovieEndedAction

Associates an action to be performed when the movie has ended.

If the video is set to repeat, the action is also triggered when the animation starts over.

Parameters:


callback	The callback is executed when done. The callback is given the VideoWidget.

setRepeat

Set repeat mode.

When set the video is restarted when the end is reached.

Parameters:


repeat	When true, the video is repeated.

setVideoBuffer

Set video buffer data.

Only used when video frames are decoded to a buffer and not directly to the framebuffer.

Parameters:


videoBuffer	Video buffer.

setVideoBufferFormat

Set video buffer format.

Only used when video frames are decoded to a buffer and not directly to the framebuffer.

Parameters:


bufferFormat	Format of the videoBuffer (RGB565 or RGB888)
width	Width of the videoBuffer in pixels
height	Height of the videoBuffer in pixels

setVideoData

Set the video data for the stream.

The video is paused and set to start on the first frame.

Parameters:


movie	Pointer to the video data.
length	Length of the vide data.

setVideoData

Set the video data for the stream.

The video is paused and set to start on the first frame.

Parameters:


reader	Reference to a VideoDataReader object.

showFrame

Seek to a specific frame and update the display.

Equal to seek if the video is playing.

Parameters:


frameNumber	The frame number to seek to.

See also:

seek

stop


void stop	(			)	const

Stop the video.

VideoWidget


VideoWidget	(			)

Default constructor.

~VideoWidget


virtual ~VideoWidget	(			)

Destructor.

Unregisters the Widget from the Controller.

Public Functions​

Additional inherited members​

Public Functions inherited from Widget​

Public Functions inherited from Drawable​

Protected Attributes inherited from Drawable​

Public Functions Documentation​

clearMovieEndedAction​

draw​

getCurrentFrameNumber​

getSolidRect​

Note

getVideoInformation​

handleTickEvent​

isPlaying​

pause​

play​

seek​

setFrameRate​

setMovieEndedAction​

setRepeat​

setVideoBuffer​

setVideoBufferFormat​

setVideoData​

setVideoData​

showFrame​

stop​

VideoWidget​

~VideoWidget​

Public Functions

Additional inherited members

Public Functions inherited from Widget

Public Functions inherited from Drawable

Protected Attributes inherited from Drawable

Public Functions Documentation

clearMovieEndedAction

draw

getCurrentFrameNumber

getSolidRect

getVideoInformation

handleTickEvent

isPlaying

pause

play

seek

setFrameRate

setMovieEndedAction

setRepeat

setVideoBuffer

setVideoBufferFormat

setVideoData

setVideoData

showFrame

stop

VideoWidget

~VideoWidget