IVideoManagerImpl< T > Class Template Reference

The video manager class, provides fundamental functionality for work in all fields on this library. More...

#include <ceVideoCoreImpl.h>

List of all members.

Public Member Functions
const short	VerifyVideoManager (void) const
	Verify the integrity of the manager class.
void	SetWindowInfo (const SWindowInfo &WindowInfo) const
	Sets the information of the window.
SWindowInfo *	GetWindowInfo (void) const
	Retrieves the information of the window.
void	RegisterVideoWindow (void *instance=NULL, void *handle=NULL) const
	This method registers a window for subsequent use in calls to the CreateVideoWindow() method.
void	RegisterVideoWindowFrom (const SWindowInfo &WindowInfo) const
	This method registers a window for subsequent use in calls to the CreateVideoWindow() method.
void	UnregisterVideoWindow (void) const
	This method unregisters a window, freeing the memory required for the window.
short	CreateVideoWindow (void) const
	This method creates an window.
void	DestroyVideoWindow (void) const
	This method destroys the window.
short	ShowVideoWindow (const short show=CE_SHOWDEFAULT) const
	This method sets the window's show state.
short	InitVideoWindow (void) const
	Initialize the window main loop.
int	UpdateVideoWindow (void) const
	Update the window main loop.
unsigned int	LoadVideoFile (char *file_name, unsigned long flags=0x0) const
	Load a video file.
short	ReleaseVideo (const unsigned int videoID=0x1) const
	Release the video.
void	ReleaseAllVideos (void) const
	Release all the videos.
SVideoInfo	GetVideoInfo (const unsigned int videoID=0x1) const
	Retrieves the video info.
SVideoInfo *	GetAsyncVideoInfo (const unsigned int videoID=0x1) const
	Retrieves the asynchronous video info.
short	ShowVideo (const unsigned int videoID=0x1, const int show=CE_VIDEO_SHOW) const
	This method sets the video's show state.
void	PlayVideo (const unsigned int videoID=0x1) const
	Start playing from the current position in the content.
void	PlayVideoFrom (const unsigned int videoID=0x1, unsigned long start=0x0) const
	Start from the specified location to the end of the content or until another command stops playback.
void	PlayVideoFromTo (const unsigned int videoID=0x1, unsigned long start=0x0, unsigned long end=0x0) const
	Plays a portion of content between specified starting and ending locations.
void	PlayVideoTo (const unsigned int videoID=0x1, unsigned long end=0x0) const
	Plays the content of the video from the current position to the specified ending location or until another command stops playback.
void	PauseVideo (const unsigned int videoID=0x1, const short pause=TRUE) const
	This method sends a command to an video to pause playing.
void	ResumeVideo (const unsigned int videoID=0x1) const
	Resumes playback content from the paused mode.
void	StopVideo (const unsigned int videoID=0x1) const
	Stops playing the content of the video.
void	SeekVideo (const unsigned int videoID=0x1, const unsigned long position=0x0) const
	Moves the playback position to the specified location in the content.
void	SeekStartVideo (const unsigned int videoID=0x1) const
	Moves the current position to the beginning of the content.
void	SeekEndVideo (const unsigned int videoID=0x1) const
	Moves the current position to the end of the content.
void	SetVolumeVideo (const unsigned int videoID=0x1, const unsigned int volume=1000) const
	Sets the volume level of the video.
void	SetZoomVideo (const unsigned int videoID=0x1, const unsigned int zoom=100) const
	Resizes a video image according to a zoom factor.
void	SetSpeedVideo (const unsigned int videoID=0x1, const unsigned int speed=1000) const
	Sets the playback speed of the video.
void	SetRepeatVideo (const unsigned int videoID=0x1, const short repeat=TRUE) const
	Sets the repeat flag associated with continuous playback.
unsigned int	GetVolumeVideo (const unsigned int videoID=0x1) const
	Retrieves the current volume setting of the video.
unsigned int	GetZoomVideo (const unsigned int videoID=0x1) const
	Retrieves the current zoom value used by the video.
unsigned int	GetSpeedVideo (const unsigned int videoID=0x1) const
	Retrieves the playback speed of the video.
unsigned int	GetRepeatVideo (const unsigned int videoID=0x1) const
	Determines if continuous playback has been activated.
unsigned long	GetPositionVideo (const unsigned int videoID=0x1) const
	Retrieves the numerical value of the current position within the content of the video.
unsigned long	GetLengthVideo (const unsigned int videoID=0x1) const
	Retrieves the length of the content used by the video.
unsigned long	GetStartVideo (const unsigned int videoID=0x1) const
	Retrieves location the beginning of the video of the video.
unsigned long	GetEndVideo (const unsigned int videoID=0x1) const
	Retrieves location of end of the video.
Protected Attributes
IVideoManager *	Video
	Instance to the video manager.

---

Detailed Description

template<class T>
class ce::IVideoManagerImpl< T >

The video manager class, provides fundamental functionality for work in all fields on this library.

---

Member Function Documentation

const short VerifyVideoManager

(

void

)

const [inline]

Verify the integrity of the manager class.

Returns:

If this succeeds, the return is a TRUE value or if this fails, the return is a FALSE value.

void SetWindowInfo

(

const SWindowInfo &

WindowInfo

)

const [inline]

Sets the information of the window.

Parameters:

WindowInfo

The information of the window.

SWindowInfo* GetWindowInfo

(

void

)

const [inline]

Retrieves the information of the window.

Returns:

A SWindowInfo pointer.

void RegisterVideoWindow	(	void *	instance = NULL,
		void *	handle = NULL
	)			const [inline]

This method registers a window for subsequent use in calls to the CreateVideoWindow() method.

Parameters:

	instance	Handle to the current instance of the application.
	handle	Handle to the current window.

void RegisterVideoWindowFrom

(

const SWindowInfo &

WindowInfo

)

const [inline]

This method registers a window for subsequent use in calls to the CreateVideoWindow() method.

Parameters:

WindowInfo

The information of the window.

void UnregisterVideoWindow

(

void

)

const [inline]

This method unregisters a window, freeing the memory required for the window.

short CreateVideoWindow

(

void

)

const [inline]

This method creates an window.

Returns:

Returns TRUE if successful or FALSE in error case.

Note:

Call to this method is required to get the informetion of the video info with the GetVideoInfo() method.

void DestroyVideoWindow

(

void

)

const [inline]

This method destroys the window.

Note:

This method also destroys the window's menu, flushes the thread message queue, destroys timers, removes clipboard ownership, and breaks the clipboard viewer chain (if the window is at the top of the viewer chain).

short ShowVideoWindow

(

const short

show = CE_SHOWDEFAULT

)

const [inline]

This method sets the window's show state.

Parameters:

show

Specifies how the window is to be shown. CE_FORCEMINIMIZE Windows 2000/XP: Minimizes a window, even if the thread that owns the window is not responding. This flag should only be used when minimizing windows from a different thread. CE_HIDE Hides the window and activates another window. CE_MAXIMIZE Maximizes the window. CE_MINIMIZE Minimizes the window and activates the next top-level window in the Z order. CE_RESTORE Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when restoring a minimized window. CE_SHOW Activates the window and displays it in its current size and position. CE_SHOWDEFAULT Sets the show default state. CE_SHOWMAXIMIZED Activates the window and displays it as a maximized window. CE_SHOWMINIMIZED Activates the window and displays it as a minimized window. CE_SHOWMINNOACTIVE Displays the window as a minimized window. This value is similar to CE_SHOWMINIMIZED, except the window is not activated. CE_SHOWNA Displays the window in its current size and position. This value is similar to CE_SHOW, except the window is not activated. CE_SHOWNOACTIVATE Displays a window in its most recent size and position. This value is similar to CE_SHOWNORMAL, except the window is not actived. CE_SHOWNORMAL Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.

Returns:

Returns TRUE if successful or FALSE in error case.

short InitVideoWindow

(

void

)

const [inline]

Initialize the window main loop.

Returns:

Returns 0 if successful or 1 in error case.

int UpdateVideoWindow

(

void

)

const [inline]

Update the window main loop.

Returns:

Returns TRUE to continue or FALSE to end the loop.

unsigned int LoadVideoFile	(	char *	file_name,
		unsigned long	flags = 0x0
	)			const [inline]

Load a video file.

Parameters:

	file_name	Null-terminated string indicating the name of an video data file to open.
	flags	Defining the video style. CE_VIDEO_NOMENU Hides the Menu button from view on the toolbar and prohibits users from accessing its pop-up menu. CE_VIDEO_NOPLAYBAR Hides the toolbar from view and prohibits users from accessing it. CE_VIDEO_SHOW Show the video. CE_VIDEO_HIDE Hides the video. CE_VIDEO_REPEAT Continuous playback. Only affects playback when the user initiates by hitting the play button on the toolbar. It will not affect playback when started with the PlayVideo() method. CE_VIDEO_AUTOPLAY AutoPlay video without the PlayVideo() method.

Returns:

Returns TRUE if successful or FALSE in error case.

short ReleaseVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Release the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns TRUE if successful or FALSE in error case.

void ReleaseAllVideos

(

void

)

const [inline]

Release all the videos.

SVideoInfo GetVideoInfo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the video info.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

A SVideoInfo.

SVideoInfo* GetAsyncVideoInfo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the asynchronous video info.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

A SVideoInfo pointer.

short ShowVideo	(	const unsigned int	videoID = 0x1,
		const int	show = CE_VIDEO_SHOW
	)			const [inline]

This method sets the video's show state.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	show	Specifies how the video is to be shown. CE_VIDEO_HIDE or FALSE to hide the video. CE_VIDEO_SHOW or TRUE to Show the video.

Returns:

Returns TRUE if successful or FALSE in error case.

void PlayVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Start playing from the current position in the content.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

void PlayVideoFrom	(	const unsigned int	videoID = 0x1,
		unsigned long	start = 0x0
	)			const [inline]

Start from the specified location to the end of the content or until another command stops playback.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	start	Starting location. The units for the starting location depend on the current time format.

void PlayVideoFromTo	(	const unsigned int	videoID = 0x1,
		unsigned long	start = 0x0,
		unsigned long	end = 0x0
	)			const [inline]

Plays a portion of content between specified starting and ending locations.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	start	Position to seek; it is also the starting location.
	end	Ending location.

Note:

This method seeks to the specified point to begin playback, then plays the content to the specified ending location.

void PlayVideoTo	(	const unsigned int	videoID = 0x1,
		unsigned long	end = 0x0
	)			const [inline]

Plays the content of the video from the current position to the specified ending location or until another command stops playback.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	end	Ending location. The units for the ending location depend on the current time format.

Note:

If the specified ending location is beyond the end of the content, playback stops at the end of the content.

void PauseVideo	(	const unsigned int	videoID = 0x1,
		const short	pause = TRUE
	)			const [inline]

This method sends a command to an video to pause playing.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	pause	TRUE value to pause or FALSEvalue to resume.

void ResumeVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Resumes playback content from the paused mode.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Note:

This method restarts playback from the current position in the content.

void StopVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Stops playing the content of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

void SeekVideo	(	const unsigned int	videoID = 0x1,
		const unsigned long	position = 0x0
	)			const [inline]

Moves the playback position to the specified location in the content.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	position	Position to seek.

void SeekStartVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Moves the current position to the beginning of the content.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

void SeekEndVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Moves the current position to the end of the content.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

void SetVolumeVideo	(	const unsigned int	videoID = 0x1,
		const unsigned int	volume = 1000
	)			const [inline]

Sets the volume level of the video.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	volume	New volume level. Specify 1000 for normal volume level. Specify a higher value for a louder volume or a lower value for a quieter volume.

void SetZoomVideo	(	const unsigned int	videoID = 0x1,
		const unsigned int	zoom = 100
	)			const [inline]

Resizes a video image according to a zoom factor.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	zoom	Zoom factor expressed as a percentage of the original image. Specify 100 to display the image at its authored size, 200 to display the image at twice its normal size, or 50 to display the image at half its normal size.

Note:

This method adjusts the size of video while maintaining a constant aspect ratio.

void SetSpeedVideo	(	const unsigned int	videoID = 0x1,
		const unsigned int	speed = 1000
	)			const [inline]

Sets the playback speed of the video.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	speed	Playback speed. Specify 1000 for normal speed, larger values for faster speeds, and smaller values for slower speeds.

void SetRepeatVideo	(	const unsigned int	videoID = 0x1,
		const short	repeat = TRUE
	)			const [inline]

Sets the repeat flag associated with continuous playback.

Parameters:

	videoID	Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.
	repeat	New state of the repeat flag. Specify TRUE to turn on continuous playback.

unsigned int GetVolumeVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the current volume setting of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the current volume setting. The default value is 1000. Higher values indicate louder volumes; lower values indicate quieter volumes.

unsigned int GetZoomVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the current zoom value used by the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the most recent values used with SetZoomVideo().

A return value of 100 indicates the image is not zoomed. A value of 200 indicates the image is enlarged to twice its original size. A value of 50 indicates the image is reduced to half its original size.

unsigned int GetSpeedVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the playback speed of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the playback speed if successful. The value for normal speed is 1000. Larger values indicate faster speeds; smaller values indicate slower speeds.

unsigned int GetRepeatVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Determines if continuous playback has been activated.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns TRUE if continuous playback is activated or FALSE otherwise.

unsigned long GetPositionVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the numerical value of the current position within the content of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns an integer corresponding to the current position. The units for the position value depend on the current time format.

unsigned long GetLengthVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves the length of the content used by the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the length. The units for the length depend on the current time format.

unsigned long GetStartVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves location the beginning of the video of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the location in the current time format.

Typically, the return value is zero; but some devices use a nonzero starting location. Seeking to this location sets the device to the start of the media.

unsigned long GetEndVideo

(

const unsigned int

videoID = 0x1

)

const [inline]

Retrieves location of end of the video.

Parameters:

videoID

Handle of the video or also can take CE_VIDEOID_FIRST Handle to first video. CE_VIDEOID_LAST Handle to last video. CE_VIDEOID_ALL Handle to all videos.

Returns:

Returns the location in the current time format.

---

Member Data Documentation

IVideoManager* Video [protected]

Instance to the video manager.

---

The documentation for this class was generated from the following file:

• ceVideoCoreImpl.h