By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cVideoPlayer

VB6VideoPlayer - ActiveX (OCX) based on DS to play AVI, MPEG, DIVX
and many other movie files.

Functions

CheckDeviceReady - Public (Return Datatype: String)


Description: Check if the device is ready.
Return: String with with the movie status.
No Parameters

CheckError - Public (Return Datatype: String)


Description: Check for error.
Return: A string with the an error (if any).

Optional	ByVal/ByRef	Variable	Datatype
Optional		lErr	Long

CloseMovie - Public (Return Datatype: Long)


Description: Close opened movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

DeInit - Public (Return Datatype: Long)


Description: DeInit the control, must be call before closing the program.
Return: 0 if success, otherwise a number describe the error.
No Parameters

ExtractCurrentMovieSize - Public (Return Datatype: Long)


Description: Receive tow pointers (wWidth and wHeight) and fill them with the opened movie size.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wLeft	Long
	ByVal	wTop	Long
		wWidth	Long
		wHeight	Long

ExtractDefaultMovieSize - Public (Return Datatype: Long)


Description: Receive tow pointers (wWidth and wHeight) and fill them with the default movie size.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
		wWidth	Long
		wHeight	Long

ForwardByFrames - Public (Return Datatype: Long)


Description: Forward the movie to a specified number of frames.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numFrames	Long

ForwardByMS - Public (Return Datatype: Long)


Description: Forward the movie to a specified number of milliseconds.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numMS	Long

ForwardBySeconds - Public (Return Datatype: Long)


Description: Forward the movie to a specified number of seconds.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numSec	Long

GetAudioStatus - Public (Return Datatype: String)


Description: Get the audio status.
Return: A string with the audio status.
No Parameters

GetBitsPerPixel - Public (Return Datatype: Long)


Description: Get the bits per sample of the opened movie.
Return: Returns the bits per sample.
No Parameters

GetCurrentSize - Public (Return Datatype: String)


Description: Get the current width and the height of the movie.
Return: A string with the width and the height of the movie.
No Parameters

GetDefaultSize - Public (Return Datatype: String)


Description: Get the default width and the height of the movie.
Return: A string with the default width and height of the movie.
No Parameters

GetDeviceName - Public (Return Datatype: String)


Description: Get the device name.
Return: A string with the device name.
No Parameters

GetDeviceVersion - Public (Return Datatype: String)


Description: Get the device version.
Return: A string with the device version.
No Parameters

GetFormatLength - Public (Return Datatype: String)


Description: Get the length of the movie in a user friendly time format.
Return: A length string with a user friendly time format.
No Parameters

GetFormatPosition - Public (Return Datatype: String)


Description: Get the position of the movie in a user friendly time format.
Return: A position string with a user friendly time format.
No Parameters

GetFramePerSecRate - Public (Return Datatype: Long)


Description: Get the frame per second of the movie.
Return: Returns a value with frame per second of the movie.
No Parameters

GetLeftVolume - Public (Return Datatype: Long)


Description: Get the volume of the left channel of the playing movie.
Return: A value with the left channel volume of the playing movie.
No Parameters

GetLengthInFrames - Public (Return Datatype: Long)


Description: Get the length of the movie in frames.
Return: Returns a value with the number of frames in the movie.
No Parameters

GetLengthInMS - Public (Return Datatype: Long)


Description: Get the length of the movie in milliseconds.
Return: Returns a value with the number of milliseconds in the movie.
No Parameters

GetLengthInSec - Public (Return Datatype: Long)


Description: Get the length of the movie in seconds.
Return: Returns a value with the number of seconds in the movie.
No Parameters

GetMovieInput - Public (Return Datatype: String)


Description: Get the movie input.
Return: A string with the movie input.
No Parameters

GetMovieOutput - Public (Return Datatype: String)


Description: Get the movie output.
Return: A string with the movie output.
No Parameters

GetNominalFrameRate - Public (Return Datatype: Long)


Description: Get the nominal frame rate the movie.
Return: Returns a value with the nominal frame rate of the movie.
No Parameters

GetPositionInFrames - Public (Return Datatype: Long)


Description: Get the position of the movie in frames.
Return: The position of the movie in frames.
No Parameters

GetPositionInMS - Public (Return Datatype: Long)


Description: Get the position of the movie in milliseconds.
Return: The position of the movie in milliseconds.
No Parameters

GetPositionInSec - Public (Return Datatype: Long)


Description: Get the position of the movie in seconds.
Return: Value with the position of the playing movie in seconds.
No Parameters

GetRate - Public (Return Datatype: Long)


Description: Get the speed of the movie.
Return: The speed of the movie.
No Parameters

GetRightVolume - Public (Return Datatype: Long)


Description: Get the volume of the right channel of the playing movie.
Return: A value with the right channel volume of the playing movie.
No Parameters

GetStatus - Public (Return Datatype: String)


Description: Get the status of the movie.
Return: A string with: Playing, Stopped, Paused, Not Ready.
No Parameters

GetTimeFormat - Public (Return Datatype: String)


Description: Get the current time format.
Return: A string with: Frames or Millisecond.
No Parameters

GetVideoStatus - Public (Return Datatype: String)

No Parameters

GetVolume - Public (Return Datatype: Long)


Description: Get the volume of the playing movie.
Return: A value with the volume of the playing movie.
No Parameters

HideMovie - Public (Return Datatype: Long)


Description: Hide the played movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

Init - Public (Return Datatype: Long)


Description: Init the control, must be call before using any functionality of the control.
Return: 0 if success, otherwise a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	sKey	String

IsMoviePaused - Public (Return Datatype: Boolean)


Description: Check if the movie is paused.
Return: True if paused, false if not.
No Parameters

IsMoviePlaying - Public (Return Datatype: Boolean)


Description: Check if the movie is playing.
Return: True if play, false if not.
No Parameters

MinimizeMovie - Public (Return Datatype: Long)


Description: Minimize the window of the movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

OpenMovie - Public (Return Datatype: Long)


Description: Open the movie with a default window style (new window).
Return: Returns zero if successful or an error otherwise.
No Parameters

OpenMovieWindow - Public (Return Datatype: Long)


Description: Open the movie under the picture box and receive the events.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFileName	String
	ByVal	bNewWindow	Boolean

PauseMovie - Public (Return Datatype: Long)


Description: Pause playing the movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

PlayFullScreen - Public (Return Datatype: Long)


Description: Play the movie in a full screen mode.
Return: Returns zero if successful or an error otherwise.
No Parameters

PlayMovie - Public (Return Datatype: Long)


Description: Play the opened video file.
Return: Returns zero if successful or an error otherwise.
No Parameters

RestartMovie - Public (Return Datatype: Long)


Description: Start playing from the beginning.
Return: Returns zero if successful or an error otherwise.
No Parameters

RestoreMovie - Public (Return Datatype: Long)


Description: Restore the movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

RestoreSizeDefault - Public (Return Datatype: Long)


Description: Restore the movie under window to original size.
Return: Returns zero if successful or an error otherwise.
No Parameters

ResumeMovie - Public (Return Datatype: Long)


Description: Resume playing the movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

RewindByFrames - Public (Return Datatype: Long)


Description: Rewind the movie a specified number of frames.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numFrames	Long

RewindByMS - Public (Return Datatype: Long)


Description: Rewind the movie a specified number of milliseconds.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numMS	Long

RewindBySeconds - Public (Return Datatype: Long)


Description: Rewind the movie by a specified number of seconds.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	numSec	Long

SecondsAsTimeString - Public (Return Datatype: String)


Description: Get a time length in seconds and return somthing like '02:22.08'.
Return: Returns a string with the time.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wSeconds	Long

SetAudioOff - Public (Return Datatype: Long)


Description: Set the audio of the movie to Off.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetAudioOn - Public (Return Datatype: Long)


Description: Set the audio of the movie to on.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetDoorClosed - Public (Return Datatype: Long)


Description: Close the CDROM/DVD door.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetDoorOpen - Public (Return Datatype: Long)


Description: Open the CDROM/DVD door.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetLeftOff - Public (Return Datatype: Long)


Description: Set the left channel of the playing movie to off.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetLeftOn - Public (Return Datatype: Long)


Description: Set the left channel of the playing movie to on.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetLeftVolume - Public (Return Datatype: Long)


Description: Set the left volume.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Long

SetPositionTo - Public (Return Datatype: Long)


Description: Set the position to play in seconds.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lSecond	Long

SetRightOff - Public (Return Datatype: Long)


Description: Set the right channel of the playing movie to off.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetRightOn - Public (Return Datatype: Long)


Description: Set the right channel of the playing movie to on.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetRightVolume - Public (Return Datatype: Long)


Description: Set the right volume.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Long

SetSpeed - Public (Return Datatype: Long)


Description: Set the speed to play the movie, the values can be 1 to 2000.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Long

SetVideoOff - Public (Return Datatype: Long)


Description: Set the video of the movie to off.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetVideoOn - Public (Return Datatype: Long)


Description: Set the video of the movie to on.
Return: Returns zero if successful or an error otherwise.
No Parameters

SetVolume - Public (Return Datatype: Long)


Description: Raise or lower the volume for both channels, the lValue can be 0 to 1000.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lValue	Long

ShowMovie - Public (Return Datatype: Long)


Description: Show the hidden movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

SizeLocateMovie - Public (Return Datatype: Long)


Description: Change the size and the location of the movie in pixels.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Left	Long
	ByVal	Top	Long
	ByVal	Width	Long
	ByVal	Height	Long

StepFrames - Public (Return Datatype: Long)


Description: Step movie by 'value' stape.
Return: Returns zero if successful or an error otherwise.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Long

StopMovie - Public (Return Datatype: Long)


Description: Stop playing the movie.
Return: Returns zero if successful or an error otherwise.
No Parameters

Event Declares

Error - Public


Error is apearing.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lErrNumber	Long
	ByVal	sErrMessage	String

OpenMedia - Public


Optional	ByVal/ByRef	Variable	Datatype
		sMediaFile	String

Pause - Public

No Parameters

Play - Public

No Parameters

StopPlay - Public

No Parameters

UnPause - Public

No Parameters