video.h

《光线引擎演示程序》执行程序+源代码,《光线引擎演示程序》执行程序+源代码

/*==========================================================================;
 *
 *  光线游戏引擎（Light Game Engine）
 *
 *  版权所有 (C) 2005-2007 康 旭。 保留所有权利。
 *  Copyright (C) KangXu.  All Rights Reserved.
 *
 *  文件:   video.h
 *  内容:   视频(音频)函数
 *
 ****************************************************************************/


/*! \file video.h
 * 视频(音频)函数.
 * 此文件是视频(音频)函数头文件.
 */

/* 重复播放，直到明确停止 */
#define LIGHT_REPEAT_INFINITE  0x7FFFFFFF

/* 播放状态 */
#define LIGHT_STATE_STOPPED   0
#define LIGHT_STATE_PAUSED    1
#define LIGHT_STATE_PLAYING   2


/*! \class LightVideo
 *  \brief 视频/音频类 
 *
 *  本类负责视频/音频文件的播放，支持 MPEG2、AVI、MP3、WAV、MIDI等大部分常见的
 *  视频、音频文件。每个 LightVideo 实例都必须通过 LightEngine 类的 NewVideo 方法分配。 
 */

class LightVideo
{

public:

	/*! \fn int Open ( const char *filename )
	 *  \brief 打开视频文件
	 *
	 *  支持 MPEG2、AVI、MP3、WAV、MIDI等大部分常见的视频、音频文件。
	 *
	 *  \param filename 视频文件名
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 *
	 *  \see Close, Play, Stop
	 */
	virtual int Open ( const char *filename ) = 0;

	/*! \fn int SetWindow ( int left, int top, int right, int bottom )
	 *  \brief 设置播放窗口(全局有效)
	 *
	 *  设置播放窗口(全局有效)。
	 *
	 *  \param left 窗口左边框坐标
	 *
	 *  \param top 窗口上边框坐标
	 *
	 *  \param right 窗口右边框坐标
	 *
	 *  \param bottom 窗口下边框坐标
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int SetWindow ( int left, int top, int right, int bottom ) = 0;

	/*! \fn int Seek ( double pos )
	 *  \brief 设置播放位置
	 *
	 *  设置播放位置。
	 *
	 *  \param  double pos 播放位置
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int Seek ( double pos ) = 0;

	/*! \fn int SetRepeats ( int repeats )
	 *  \brief 设置重复播放次数
	 *
	 *  设置播放位置。
	 *
	 *  \param  int repeats 重复播放的次数。如果要一直重复播放，直到明确停止，可以设为 LIGHT_REPEAT_INFINITE 。
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int SetRepeats ( int repeats ) = 0;

	/*! \fn int Play ( void )
	 *  \brief 播放
	 *
	 *  播放视频文件。
	 *
	 *  \param  无
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int Play ( void ) = 0;

	/*! \fn int Pause ( void )
	 *  \brief 暂停
	 *
	 *  暂停播放视频文件。
	 *
	 *  \param  无
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int Pause ( void ) = 0;

	/*! \fn int Stop ( void )
	 *  \brief 停止
	 *
	 *  停止播放视频文件。
	 *
	 *  \param  无
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int Stop ( void ) = 0;

	/*! \fn int GetState ( void )
 	 *  \brief 查询播放状态
	 *
	 *  查询视频文件播放状态。
	 *
	 *  \param  无
	 *
	 *  \return  返回当前播放状态。返回下面的其中一种播放状态：
	 *           \li LIGHT_STATE_STOPPED   停止状态
	 *           \li LIGHT_STATE_PAUSED    暂停状态
	 *           \li LIGHT_STATE_PLAYING   正在播放
	 */
	virtual int GetState ( void ) = 0;

	/*! \fn int Close ( void )
	 *  \brief 关闭视频(音频)文件
	 *
	 *  关闭视频(音频)文件。
	 *
	 *  \param  无
	 *
	 *  \return 如果函数调用成功，返回非零值；如果函数调用失败，返回零。
	 */
	virtual int Close ( void ) = 0;

};