This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
编程
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
应用程序接口
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Unigine::WidgetSpriteVideo Class

Header: #include <UnigineWidgets.h>
Inherits: WidgetSprite
Read More

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: 2020-07-31
Build: ()