VideoPlayer

Scaleform::GFx::Video::VideoPlayer

Declaration

class VideoPlayer : public NewOverrideBase<Stat_Video_Mem>;

Description

VideoPlayer is an internal video playback interface returned by Video::CreateVideoPlayer method when a SWF file requests a video playback. End users do not need to create or access objects of this class. One VideoPlayer object is created for each video file.

Classes

Class	Description
SyncObject	Synchronization object used for synchronizing video stream with SWF movieclip timeline.

Enumerations

Enumeration	Description
CuePointType	Lists the type of the embedded cue point data in the video file.
SoundTrack	Enumeration listing the sound tracks used in the video file.
Status	An enumeration listing the status of the video player for loading and playing the movie.

Methods

Method	Description
CreateTexture	Creates a texture for the movies.
Decode	Performs decoding of the video file.
Destroy	Deletes the VideoPlayer object and all resources associated with the object.
GetCurrentCuePoints	Retrieves the cue points that were triggered since the last call to this method.
GetPosition	Returns the current playback position in the movie instance.
GetReadBufferInfo	Obtains the read buffer information on the video read operations .
GetSoundChannel	Obtains the sound channels for playing the audio content in the video file.
GetStatus	Returns the status of a movie.
GetSubtitleChannel	Returns the subtitle channel number.
GetVideoInfo	Retrieves the information of the video file being played.
IsTextureReady	Determines whether the video frame is decoded and ready for playing.
LoadVideoInfo	Reads a video file header without playing the file.
Open	Opens a movie for playback.
Pause	Pauses or resumes the playback of the movie.
Play	Starts the movie playback.
ReplaceCenterVoice	Changes the voice track of 5.1ch music.
Seek	Seeks to the specified position in the movie file.
SetAudioTrack	Sets the audio track to play audio when a movie file has multiple audio tracks.
SetDecodeHeaderTimeout	Sets the decoding header timeout in seconds.
SetExtraAudioTrack	Sets an extra audio track, similar to SubAudio track for playing audio.
SetLoopFlag	Sets a loop flag to repeatedly play the movie.
SetNumberOfFramePools	Sets the number of internal video buffers.
SetReloadThresholdTime	Sets the reload timing in seconds.
SetSoundSpatialInfo	Sets the sound spatial information such as position, orientation and velocity.
SetSubAudioTrack	Sets a secondary or SubAudio track, which is typically used to play a dialog track or sound effects along with a movie.
SetSubtitleChannel	Sets the subtitle channel to play.
SetSyncObject	Sets the video synchronization object for synchronizing the streaming video with the SWF movie clip timeline.
Stop	Stops the playback of the movie.
UpdateTexture	Updates the texture image if the next movie frame is ready.

Structures

Structure	Description
AudioTrackInfo	Provides information on the audio track included in the video file.
CuePoint	Describes the cue points encoded into the video file.
CuePointParam	Structure for holding the data associated with a cue point.
ReadBufferInfo	Contains read buffer information on the video read operations.
VideoInfo	Provides information on the playback video file.

File

Video_Video.h