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

User Control: cPlayer

Properties

AudioDataOut [Get] - Public (Return Datatype: Long)


A pointer to the audio data. Use it with the AudioGraph.
No Parameters

Info_Bitrate [Get] - Public (Return Datatype: Long)


Bitrate file info
No Parameters

Info_BitsPerSample [Get] - Public (Return Datatype: Long)


BitsPerSample file info
No Parameters

Info_Channels [Get] - Public (Return Datatype: Integer)


Channels file info
No Parameters

Info_Duration [Get] - Public (Return Datatype: Double)


Duration file info
No Parameters

Info_Samplerate [Get] - Public (Return Datatype: Long)


Samplerate file info
No Parameters

Tag_Album [Let] - Public


Set the Albume tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_Album [Get] - Public (Return Datatype: String)


Get the Albume tag of the source audio file.
No Parameters

Tag_Artist [Let] - Public


Set the Artist tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_Artist [Get] - Public (Return Datatype: String)


Get the Artist tag of the source audio file.
No Parameters

Tag_Comment [Get] - Public (Return Datatype: String)


Get the Comment tag of the source audio file.
No Parameters

Tag_Comment [Let] - Public


Set the Comment tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_Genre [Let] - Public


Set the Genre tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_Genre [Get] - Public (Return Datatype: String)


Get the Genre tag of the source audio file.
No Parameters

Tag_SongYear [Let] - Public


Set the SongYear tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_SongYear [Get] - Public (Return Datatype: String)


Get the SongYear tag of the source audio file.
No Parameters

Tag_Title [Let] - Public


Set the Title tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_Title [Get] - Public (Return Datatype: String)


Get the Title tag of the source audio file.
No Parameters

Tag_TrackNumber [Let] - Public


Set the TrackNumber tag for the destination audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	String

Tag_TrackNumber [Get] - Public (Return Datatype: String)


Get the TrackNumber tag of the source audio file.
No Parameters

Subroutines

About - Public


Description: Display About message box with the license details.
No Parameters

DisplayRegistration - Public


Description: Display registration window.
No Parameters

Functions

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

DonePlay - Public (Return Datatype: Boolean)


Description: Check if done play out.
Return: True if done, false if not.
No Parameters

ErrorTextOut - Public (Return Datatype: String)


Description: Get error description by error number.
Return: String contains the error description.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lErrNum	Long

GetDetailsDevice - Public (Return Datatype: Long)


Description: Get the sound device details by the DeviceIndex to the DeviceDetails type.
Return: 0 if success, or a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	iInOut	InOut
	ByRef	DeviceDetails	AudioDeviceDetails

GetID3Tags - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	strFile	String

GetSecondsAsTimeString - Public (Return Datatype: String)


Description: Get time length in seconds and return somthing like 02:22.08
Return: Return the time in string

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Seconds	Long

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

IsPausedOut - Public (Return Datatype: Boolean)


Description: Check if pause playing.
Return: True if pause, false if not.
No Parameters

IsPlaying - Public (Return Datatype: Boolean)


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

ISubclass_WindowProc - Friend (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hWnd	Long
	ByVal	uMsg	Long
	ByVal	wParam	Long
	ByVal	lParam	Long

NumOfAudioDevices - Public (Return Datatype: Long)


Description: Get the number of the sound device in the local system.
Return: the number of sound devices.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iInOut	InOut

OpenAudioFile - Public (Return Datatype: Long)


Description: Open an audio file. After calling this function you can get the information about the audio file.
Return: Zero if success, or an error number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	strFile	String

PlayPause - Public (Return Datatype: Long)


Description: Pause playing.
Return: Zero if success, or an error number describe the error.
No Parameters

PlayStart - Public (Return Datatype: Long)


Description: Start play an audio file to the DeviceIndex, DeviceIndex can be any sound card that installed on the local machine.
Return: Zero if success, or an error number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sAudioFile	String
Optional		DeviceIndex	Long(-1)
Optional		lBufferSize	Long(800)

PlayStop - Public (Return Datatype: Long)


Description: Stop play
Return: Zero if success, or an error number describe the error.
No Parameters

PlayUnPause - Public (Return Datatype: Long)


Description: UnPause playing.
Return: Zero if success, or an error number describe the error.
No Parameters

PositionGet - Public (Return Datatype: Long)


Description: Get the current position in seconds.
Return: The currrent position in seconds.
No Parameters

PositionSet - Public (Return Datatype: Long)


Description: Seek to a position in the file in seconds.
Return: Zero if success, else a number descibe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lPosition	Long

Event Declares

DonePlay - Public

No Parameters

Err - Public


Optional	ByVal/ByRef	Variable	Datatype
		FunctionName	String
		ErrorNumber	Long
		ErrorDecription	String