Skip to main content

VideoWidget

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

See: VideoController

Inherits from: Widget, Drawable

Public Functions

voidclearMovieEndedAction()
Clears the movie ended action previously set by setMovieEndedAction.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
uint32_tgetCurrentFrameNumber() const
Get the current frame number.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
voidgetVideoInformation(VideoInformation * data) const
Get Video information.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
boolisPlaying() const
Check if the video is playing (not paused or stopped).
voidpause() const
Pause the video.
voidplay() const
Play the video.
voidseek(uint32_t frameNumber) const
Seek to specific frame.
voidsetFrameRate(uint32_t ui_frames, uint32_t video_frames) const
Sets the frame rate of the video.
voidsetMovieEndedAction(GenericCallback< const VideoWidget & > & callback)
Associates an action to be performed when the movie has ended.
voidsetRepeat(bool repeat) const
Set repeat mode.
voidsetVideoBuffer(uint8_t *const videoBuffer)
Set video buffer data.
voidsetVideoBufferFormat(Bitmap::BitmapFormat bufferFormat, uint16_t width, uint16_t height)
Set video buffer format.
voidsetVideoData(const uint8_t * movie, const uint32_t length)
Set the video data for the stream.
voidsetVideoData(VideoDataReader & reader)
Set the video data for the stream.
voidshowFrame(uint32_t frameNumber) const
Seek to a specific frame and update the display.
voidstop() const
Stop the video.
VideoWidget()
Default constructor.
~VideoWidget()
Destructor.

Additional inherited members

Public Functions inherited from Widget

virtual voidgetLastChild(int16_t x, int16_t y, 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

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
virtual voidchildGeometryChanged()
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.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
RectgetAbsoluteRect() 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_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(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 RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & event)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & rect)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(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.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Public Functions Documentation

clearMovieEndedAction

Clears the movie ended action previously set by setMovieEndedAction.

See also:

draw

virtual void draw(const Rect &invalidatedArea)

Draw this drawable.

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

Parameters:
invalidatedAreaThe 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:
dataPointer 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:

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

void seek(uint32_tframeNumber)

Seek to specific frame.

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

Parameters:
frameNumberThe frame number to seek to.
See also:

setFrameRate

void setFrameRate(uint32_tui_frames ,const
uint32_tvideo_framesconst
)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_framesNumber of UI frames (divider)
video_framesNumber of video_frames (dividend)

setMovieEndedAction

void setMovieEndedAction(GenericCallback< const VideoWidget & > &callback)

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:
callbackThe callback is executed when done. The callback is given the VideoWidget.

setRepeat

void setRepeat(boolrepeat)

Set repeat mode.

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

Parameters:
repeatWhen true, the video is repeated.

setVideoBuffer

void setVideoBuffer(uint8_t *constvideoBuffer)

Set video buffer data.

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

Parameters:
videoBufferVideo buffer.

setVideoBufferFormat

void setVideoBufferFormat(Bitmap::BitmapFormatbufferFormat ,
uint16_twidth ,
uint16_theight
)

Set video buffer format.

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

Parameters:
bufferFormatFormat of the videoBuffer (RGB565 or RGB888)
widthWidth of the videoBuffer in pixels
heightHeight of the videoBuffer in pixels

setVideoData

void setVideoData(const uint8_t *movie ,
const uint32_tlength
)

Set the video data for the stream.

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

Parameters:
moviePointer to the video data.
lengthLength 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:
readerReference to a VideoDataReader object.

showFrame

void showFrame(uint32_tframeNumber)

Seek to a specific frame and update the display.

Equal to seek if the video is playing.

Parameters:
frameNumberThe frame number to seek to.
See also:

stop

void stop()const

Stop the video.

VideoWidget

Default constructor.

~VideoWidget

Destructor.

Unregisters the Widget from the Controller.