VideoBase

Scaleform::GFx::Video

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

Declaration

class VideoBase : public State;

Description

VideoBase is an abstract interface for creating instances of Video interface when GFx needs to play video files. This interface has four responsibilities:

Create an instance of a VideoPlayer interface when GFx library requires a video play back. Each video requires its own VideoPlayer.
Attach the audio from the video source to a movieclip object.
Register all Action Script objects that are required for video playback.
Read video stream tags from a SWF file.

VideoBase interface provides two ways of implementing background loading of game data while a video file is playing:

Using a callback object that will notify a user when a video system needs to read a new chunk of video data and when a read operation has been completed.
Using IsIORequired method to detect if the reading of video data is required and EnableIO method to disable/enable video read operations.

Classes

Class	Description
ReadCallback	Callback interface for notifying the application when a video read operation is required and when it is completed.

Methods

Method	Description
CreateVideoPlayer	Creates an instance of VideoPlayer interface for playing the 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.
GetHeap	Obtains a pointer to the memory heap used by the video system.
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.
VideoBase	VideoBase constructor.

File

GFx_VideoBase.h