Unigine::WidgetSpriteVideo Class
Header: | #include <UnigineWidgets.h> |
Inherits from: | WidgetSprite |
This class is used to create a virtual monitor that plays a video file (currently only *.OGV files are supported). It can be synchrozied with playback of the ambient sound or the directional sound source.
The following example illustrates how to play a video-file on the system GUI or a GUI object using the WidgetSpriteVideo class.
Create a C++ component named VideoSprite and copy the code below to the corresponding files:
#pragma once
#include <UnigineComponentSystem.h>
class VideoSprite :
public Unigine::ComponentBase
{
public:
COMPONENT_DEFINE(VideoSprite, Unigine::ComponentBase);
COMPONENT_INIT(init);
// path to the video file to play (only *.OGV type is supported)
PROP_PARAM(File, file_name, "");
private:
// sprite video widgets
Unigine::WidgetSpriteVideoPtr TVscreen;
Unigine::WidgetSpriteVideoPtr MAINscreen;
void init();
};
#include "VideoSprite.h"
#include <UnigineGui.h>
REGISTER_COMPONENT(VideoSprite);
using namespace Unigine;
void VideoSprite::init()
{
// creating the first sprite video widget that plays a file_name video file on the system GUI
MAINscreen = WidgetSpriteVideo::create(Gui::getCurrent(), file_name, 1);
// setting size and position of the second sprite video widget on the screen
MAINscreen->setPosition(100, 100);
MAINscreen->setWidth(400);
MAINscreen->setHeight(225);
MAINscreen->arrange();
// adding the sprite video widge to the system GUI
Gui::getCurrent()->addChild(MAINscreen, Gui::ALIGN_OVERLAP | Gui::ALIGN_BACKGROUND);
// setting looped playback mode
MAINscreen->setLoop(1);
// launching playback
MAINscreen->play();
// checking if the node to which the component is assigned is a GUI Object
if (node->getType() != Node::OBJECT_GUI)
{
Log::message("Node is not a GUI Object!\n");
return;
}
ObjectGuiPtr GUIObject = checked_ptr_cast<ObjectGui>(node);
// creating the second sprite video widget that plays a file_name video file on the GUI object
TVscreen = WidgetSpriteVideo::create(GUIObject->getGui(), file_name, 1);
// adjusting the size of the widget to fit the size of the GUI object
TVscreen->setWidth(GUIObject->getScreenWidth());
TVscreen->setHeight(GUIObject->getScreenHeight());
// adding the sprite video widget to the GUI object
GUIObject->getGui()->addChild(TVscreen, Gui::ALIGN_OVERLAP | Gui::ALIGN_BACKGROUND);
// setting looped playback mode
TVscreen->setLoop(1);
// launching playback
TVscreen->play();
}
See Also#
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder:
- video_00
- video_01
WidgetSpriteVideo Class
Members
static WidgetSpriteVideoPtr create ( const Ptr<Gui> & gui, const char * name = 0, int mode = 1 ) #
Constructor. Creates a new sprite that plays video and adds it to the specified GUI.Arguments
- const Ptr<Gui> & gui - GUI, to which the new sprite will belong.
- const char * name - Path to a video file.
- int mode - YUV flag: 1 if conversion to RGB should be performed by the GPU, 0 - if by the CPU.
static WidgetSpriteVideoPtr create ( const char * name = 0, int mode = 1 ) #
Constructor. Creates a new sprite that plays video and adds it to the Engine GUI.Arguments
- const char * name - Path to a video file.
- int mode - YUV flag: 1 if conversion to RGB should be performed by the GPU, 0 - if by the CPU.
void setAmbientSource ( const Ptr<AmbientSource> & source ) #
Synchronizes video playback to the ambient sound source playback.Arguments
- const Ptr<AmbientSource> & source - Ambient sound source according to which video playback will be synchronized.
Ptr<AmbientSource> getAmbientSource ( ) const#
Returns the ambient sound source according to which video playback is synchronized.Return value
Ambient sound source.void setLoop ( int loop ) #
Sets a value indicating if the video should be looped.Arguments
- int loop - Positive number to loop the video, 0 to play it only once.
int getLoop ( ) const#
Returns a value indicating if the video is looped.Return value
Positive number if the video is looped; otherwise, 0.bool isPlaying ( ) const#
Returns a value indicating if the video is being played at the moment.Return value
1 if the video is being played; otherwise, 0.void setSoundSource ( const Ptr<SoundSource> & source ) #
Synchronizes video playback to the sound source playback.Arguments
- const Ptr<SoundSource> & source - Sound source according to which video playback will be synchronized.
Ptr<SoundSource> getSoundSource ( ) const#
Returns the sound source according to which video playback is synchronized.Return value
Sound source.bool isStopped ( ) const#
Returns a value indicating if the video is stopped at the moment.Return value
1 if the video is stopped; otherwise, 0.void setVideoTime ( float time ) #
Rewinds or fast-forwards the video to a given time.Arguments
- float time - Time in seconds.
float getVideoTime ( ) const#
Returns the time of the currently played frame.Return value
Time in seconds.void setYUV ( int yuv ) #
Sets a flag for YUV conversion.Arguments
- int yuv - Mode flag: 1 if conversion to RGB should be performed by the GPU, 0 if it is converted by the CPU.
int getYUV ( ) const#
Returns a flag for YUV conversion.Return value
1 if conversion to RGB is performed by the GPU, 0 if it is converted by the CPU.void play ( ) #
Starts playing video.void stop ( ) #
Stops playing video. This function saves the playback position so that playing of the file can be resumed from the same point.Last update:
2024-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)