Engine
Class VideoPlayer

source: C:\XIII\Engine\Classes\VideoPlayer.uc
Core.Object
   |
   +--Engine.VideoPlayer
Direct Known Subclasses:None

class VideoPlayer
extends Core.Object

//----------------------------------------------------------- // //-----------------------------------------------------------

Function Summary
 int GetStatus()
     
//***********************************
// GetStatus
//-----------------------------------
// Description : Get the status of the video player
//-----------------------------------
// Out
//   return :
//           0 : no playback, or the playback is end
//           1 : playback of the video in progress
//           2 : an error occurs during playback of the video
//
 bool Open(string FileName)
     
//***********************************
// Open
//-----------------------------------
// Description : Open a video file and prepare the engine to play
//               the video
//-----------------------------------
// In
//   Filename : the name of the video file to open
//              ( without extension, and without path )
//-----------------------------------
// Out
//   Return true if the file is successfully open
//-----------------------------------
 void Pause()
     
//***********************************
// Pause
//-----------------------------------
// Description : Pause the playback of the current video
 void Play()
     
//***********************************
// Play
//-----------------------------------
// Description : Begin to play the video
 void Resume()
     
//***********************************
// Resume
//-----------------------------------
// Description : Resume the playback of the current video
 void SetSoundTrack(int SoundTrack)
     
//***********************************
// SetSoundTrack
//-----------------------------------
// Description : Specifies the sound track number to play
//-----------------------------------
// In
//   SoundTrack : the sound track number
//
 void SetSoundVolume(int SoundVolume)
     
//***********************************
// SetSoundVolume
//-----------------------------------
// Description : Set the volume of the video
//-----------------------------------
// In
//   SoundVolume : Specifies the new volume level from 0 (silent) to 32768
//
 void Stop()
     
//***********************************
// Stop
//-----------------------------------
// Description : Stop to play the video, and close the video player



Source Code


00001	//-----------------------------------------------------------
00002	//
00003	//-----------------------------------------------------------
00004	class VideoPlayer extends Object
00005	      native;
00006	
00007	//***********************************
00008	// Open
00009	//-----------------------------------
00010	// Description : Open a video file and prepare the engine to play
00011	//               the video
00012	//-----------------------------------
00013	// In
00014	//   Filename : the name of the video file to open
00015	//              ( without extension, and without path )
00016	//-----------------------------------
00017	// Out
00018	//   Return true if the file is successfully open
00019	//-----------------------------------
00020	native(484) static final function bool Open(string FileName);
00021	
00022	
00023	//***********************************
00024	// Play
00025	//-----------------------------------
00026	// Description : Begin to play the video
00027	native(483) static final function Play();
00028	
00029	
00030	//***********************************
00031	// Stop
00032	//-----------------------------------
00033	// Description : Stop to play the video, and close the video player
00034	native(482) static final function Stop();
00035	
00036	//***********************************
00037	// Pause
00038	//-----------------------------------
00039	// Description : Pause the playback of the current video
00040	native(481) static final function Pause();
00041	
00042	//***********************************
00043	// Resume
00044	//-----------------------------------
00045	// Description : Resume the playback of the current video
00046	native(479) static final function Resume();
00047	
00048	//***********************************
00049	// SetSoundVolume
00050	//-----------------------------------
00051	// Description : Set the volume of the video
00052	//-----------------------------------
00053	// In
00054	//   SoundVolume : Specifies the new volume level from 0 (silent) to 32768
00055	//
00056	native(478) static final function SetSoundVolume(int SoundVolume);
00057	
00058	//***********************************
00059	// SetSoundTrack
00060	//-----------------------------------
00061	// Description : Specifies the sound track number to play
00062	//-----------------------------------
00063	// In
00064	//   SoundTrack : the sound track number
00065	//
00066	native(477) static final function SetSoundTrack(int SoundTrack);
00067	
00068	
00069	//***********************************
00070	// GetStatus
00071	//-----------------------------------
00072	// Description : Get the status of the video player
00073	//-----------------------------------
00074	// Out
00075	//   return :
00076	//           0 : no playback, or the playback is end
00077	//           1 : playback of the video in progress
00078	//           2 : an error occurs during playback of the video
00079	//
00080	native(476) static final function int GetStatus();
00081	
00082	defaultproperties
00083	{
00084	}

End Source Code