Video

Scaleform::GFx::Video

Scaleform::GFx::State
    Scaleform::GFx::Video::VideoBase
        Scaleform::GFx::Video::Video

Declaration

class Video : public VideoBase;

Description

Video state is used to initialize video playback in GFx; an instance of this object should be created at startup time and set on the loader with Loader::SetVideo. If this object is not created, video support will not be linked into your application.

   Ptr<Scaleform::GFx::Video::Video> pvc = *new Video(Scaleform::Thread::NormalPriority);
   loader.SetVideo(pvc);

As a part of video initialization, users need to call SetSoundSystem to initialize video sound output. The provided sound system object can be either a platform-specific version of the sound system, such as VideoSoundSystemXA2 (for XBox360), or a SoundRenderer implementation that implements SoundRenderer::AuxStreamer. Video (usm) files can be loaded from game-specific pack files by overriding GFx::FileOpener and implementing File interface.

Methods

Method	Description
ApplySystemSettings	Called during video initialization to apply system specific settings for video playback.
CreateVideoPlayer	Creates an instance of VideoPlayer interface for playing video files.
EnableIO	Enables/disables video read operations for background loading of game data.
GetAS2Support	Gets the AS2 Video ActionScript interface.
GetAS3Support	Gets the AS3 Video ActionScript interface.
GetDecoder	Returns the decoder used for decoding of the video player.
GetHeap	Obtains a pointer to the memory heap used by the video system.
GetReaderConfig	Returns the VideoReaderConfig used for accessing data from the video files.
GetSoundSystem	Returns the video sound system used in the video playbacks.
GetTextureManager	Returns the texture manager used for the texture image.
IsIORequired	Determines if a video system needs to perform any video data read operation.
ReadDefineVideoStreamTag	Reads video definition tags from a SWF file.
SetReadCallback	Sets a read callback instance to the video system for background loading of game data.
SetSoundSystem	Initializes the video sound output in the video playbacks.
SetTextureManager	Sets the texture manager used to create VideoImage.
Video	Initializes Video object.

File

Video_Video.h