IVideoManager Class Reference

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

#include <ceVideoCore.h>

List of all members.

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

---

Detailed Description

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

---

Member Function Documentation

virtual void SetWindowInfo

(

const SWindowInfo &

WindowInfo

)

[pure virtual]

Sets the information of the window.

Parameters:

WindowInfo

The information of the window.

virtual SWindowInfo* GetWindowInfo

(

void

)

[pure virtual]

Retrieves the information of the window.

Returns:

A SWindowInfo pointer.

virtual void RegisterVideoWindow	(	void *	instance = NULL,
		void *	handle = NULL
	)			[pure virtual]

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.

virtual void RegisterVideoWindowFrom

(

const SWindowInfo &

WindowInfo

)

[pure virtual]

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

Parameters:

WindowInfo

The information of the window.

virtual void UnregisterVideoWindow

(

void

)

[pure virtual]

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

virtual short CreateVideoWindow

(

void

)

[pure virtual]

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.

virtual void DestroyVideoWindow

(

void

)

[pure virtual]

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).

virtual short ShowVideoWindow

(

const short

show = CE_SHOWDEFAULT

)

[pure virtual]

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.

virtual short InitVideoWindow

(

void

)

[pure virtual]

Initialize the window main loop.

Returns:

Returns 0 if successful or 1 in error case.

virtual int UpdateVideoWindow

(

void

)

[pure virtual]

Update the window main loop.

Returns:

Returns TRUE to continue or FALSE to end the loop.

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

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.

virtual short ReleaseVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual void ReleaseAllVideos

(

void

)

[pure virtual]

Release all the videos.

virtual SVideoInfo GetVideoInfo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

Retrieves the information of 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:

A SVideoInfo.

virtual SVideoInfo* GetAsyncVideoInfo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

Retrieves the asynchronous information of 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:

A SVideoInfo pointer.

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

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.

virtual void PlayVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

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

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.

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

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.

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

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.

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

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.

virtual void ResumeVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual void StopVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

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

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.

virtual void SeekStartVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual void SeekEndVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

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

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.

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

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.

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

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.

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

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.

virtual unsigned int GetVolumeVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned int GetZoomVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned int GetSpeedVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned int GetRepeatVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned long GetPositionVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned long GetLengthVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned long GetStartVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

virtual unsigned long GetEndVideo

(

const unsigned int

videoID = 0x1

)

[pure virtual]

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.

---

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

• ceVideoCore.h