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

User Control: cSound

Properties

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


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

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


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

CutSilence [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Boolean

CutSilence [Get] - Public (Return Datatype: Boolean)

No Parameters

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

No Parameters

CutSilenceVal [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	value	Long

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

Metter [Let] - Public


Set the current metter.
This will let the component know about a silence/noise.
Use it when you want to cut the silnce section from the end of the recorded audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	Long

RecordTo [Let] - Public


Set the format of the destination audio file:
MP3 - Record to MP3 audio file.
WMA - Record to WMA audio file.
WAV - Record to WAV audio file.
ACM - Record to WAV ACM audio file (WAV with codecs).
OGG - Record to OGG audio file.
APE - Record to APE audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	eRecordTo

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

WriteWAVHeader [Let] - Public


Write the wav headers of ACM and PCM wav files. Default value is true.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	RHS	Boolean

Subroutines

About - Public


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

DisplayRegistration - Public


Description: Display registration window.
No Parameters

SetACM - Public


Set the format properties of the WAV ACM audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sTag	String
	ByVal	sFormat	String

SetAPE - Public


Set the format properties of the APE audio file.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lCompressionLevel	Long

SetMP3 - Public


Set the format properties of the MP3 audio file.

Optional	ByVal/ByRef	Variable	Datatype
		MP3Properties	MP3_Properties

SetMP3Vals - Public


Set the new MP3 properties for C++.
Description: Set the MP3 target without using the MP3_Properties type (for C++, etc..).

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ABRBitrate	Long
	ByVal	Bitrate	Long
	ByVal	CopyrightBit	Boolean
	ByVal	ErrorProtection	Boolean
	ByVal	Mode	MPEGMode
	ByVal	OriginalBit	Boolean
	ByVal	SampleRate	Long
	ByVal	Quality	Long
	ByVal	StrictISO	Boolean
	ByVal	VBR	VBRMode
	ByVal	VBRForceMinBitrate	Boolean
	ByVal	VBRMinBitrate	Long
	ByVal	VBRMaxBitrate	Long
	ByVal	VBRQuality	Long
	ByVal	WriteVBRTag	Boolean

SetOGG - Public


Set the format properties of the OGG audio file.

Optional	ByVal/ByRef	Variable	Datatype
		OGGProperties	OGG_Properties

SetOGGVals - Public


Description: Set the OGG target without using the OGG_Properties type (for C++, etc..).
Quality_Mode = 1
Bitrate_Mode = 2

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lMode	Long
	ByVal	lBitrateNominal	Long
	ByVal	lQuality	Long

SetWAV - Public


Set the format properties of the WAV audio file.

Optional	ByVal/ByRef	Variable	Datatype
		WAVProperties	WAV_Properties

SetWAVVals - Public


Description: Set the WAV target without using the WAV_Properties type (for C++, etc..).

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lSampleRate	Long
	ByVal	nChannels	Integer
	ByVal	nBitsPerSample	Integer

Functions

CloseFile - Public (Return Datatype: Long)


Description: Close the stream of the source file.
Return: Zero if success, or -1 if the file is already closed.
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

DonePlay - Public (Return Datatype: Boolean)


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

ErrorTextIn - Public (Return Datatype: String)


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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	errnum	Long

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

GetDetailsDeviceChannels - Public (Return Datatype: String)


Description: Get the device channels by the DeviceIndex. lInOut: 1 Out, 2 In.
Return: 0 if success, or a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	lInOut	Long

GetDetailsDeviceDriver - Public (Return Datatype: String)


Description: Get the device driver by the DeviceIndex. lInOut: 1 Out, 2 In.
Return: 0 if success, or a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	lInOut	Long

GetDetailsDeviceFormat - Public (Return Datatype: String)


Description: Get the device format by the DeviceIndex. lInOut: 1 Out, 2 In.
Return: 0 if success, or a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	lInOut	Long

GetDetailsDeviceName - Public (Return Datatype: String)


Description: Get the device name by the DeviceIndex. lInOut: 1 Out, 2 In.
Return: 0 if success, or a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	lInOut	Long

GetFormatsByTag - Public (Return Datatype: Long)


Description: Get the formats of the sTagsName.
Return: Zero if success, or an error number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sTagsName	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

GetTagInfo - Public (Return Datatype: String)


Description: Get information about sTagName.
Return: String that describe the information about tag name.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sTagName	String

GetTags - Public (Return Datatype: Long)


Description: Get all the ACM tags that installed on the local machine according to the parameters.
Return: Zero if success, or an error number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lFormatTag	Long
	ByVal	lSamplesPerSec	Long
	ByVal	lChannels	Long
	ByVal	lBitsPerSample	Long
	ByVal	eTagMode	eTagsMode

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

IsPausedIn - Public (Return Datatype: Boolean)


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

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

IsPreScreen - Public (Return Datatype: Boolean)

No Parameters

IsRecording - Public (Return Datatype: Boolean)


Description: Check if the component is on recording mode.
Return: True if recording, 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 device in the local system.
Return: the number of sound devices.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iInOut	InOut

NumOfAudioDevicesX - Public (Return Datatype: Long)


Description: Get the number of the device in the local system without a data type (UI for C++). lInOut: 1 Out, 2 In.
Return: the number of sound devices.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lInOut	Long

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)

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

PreScreenClose - Public (Return Datatype: Long)


Description: Close pre screen call
Return: Zero if success, or an error number describe the error.
No Parameters

PreScreenOpen - Public (Return Datatype: Long)


Description: Open the pre screen to the DeviceIndex with a selected format to play. Use this function after record has started.
Return: Zero if success, or an error number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	ToDeviceIndex	Long(-1)

RecordPause - Public (Return Datatype: Long)


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

RecordStart - Public (Return Datatype: Long)


Description: Start record from DeviceIndex to sFileName with the InputFormat data type.
Return: Zero if success, or a number descibe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	sFileName	String
		InputFormat	AudioFormat

RecordStartOnNoise - Public (Return Datatype: Long)


Description: Start record when noise is detected from DeviceIndex to sFileName with the InputFormat data type. The noise value can be 1 to 100.
Return: Zero if success, or a number descibe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	sFileName	String
	ByVal	lNoiseVal	Long
		InputFormat	AudioFormat

RecordStartOnNoiseX - Public (Return Datatype: Long)


Description: Start record when noise is detected from DeviceIndex to sFileName without the InputFormat data type. The noise value can be 1 to 100.
Return: Zero if success, or a number descibe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	sFileName	String
	ByVal	lNoiseVal	Long
	ByVal	lSamplesPerSec	Long
	ByVal	lBitsPerSample	Long
	ByVal	lChannels	Long

RecordStartX - Public (Return Datatype: Long)


Description: Start record from DeviceIndex to sFileName without the InputFormat data type (UI for C++).
Return: Zero if success, or a number descibe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	DeviceIndex	Long
	ByVal	sFileName	String
	ByVal	lSamplesPerSec	Long
	ByVal	lBitsPerSample	Long
	ByVal	lChannels	Long

RecordStop - Public (Return Datatype: Long)

No Parameters

RecordUnPause - Public (Return Datatype: Long)


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

SetWMA - Public (Return Datatype: Boolean)


Set the format properties of the WMA audio file.

Optional	ByVal/ByRef	Variable	Datatype
		WMAProperties	WMA_Properties

SetWMAVals - Public (Return Datatype: Boolean)


Description: Set the WMAV target without using the WMAV_Properties type (for C++, etc..).

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lCodec	Long
	ByVal	lFormat	Long

TagCodecs - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sTagName	String

TagFormats - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sTagFormat	String

WMACodecFormats - Public (Return Datatype: Collection)


Description: Get a list of WMA formats of the lCodecIndex.
Return: Collection type of list of WMA format.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lCodecIndex	Long

WMACodecFormatXVal - Public (Return Datatype: String)


Description: Get the WMA format name of the lCodecIndex by the lFormatIndex.
Return: A string with the codec name.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lCodecIndex	Long
	ByVal	lFormatIndex	Long

WMACodecs - Public (Return Datatype: Collection)


Description: Get a list of WMA codecs.
Return: Collection type of WMA codecs.
No Parameters

WMACodecsFormatsX - Public (Return Datatype: Long)


Description: Get a counter of the number of the formats by the lCodecIndex value.
Return: A long with a counter of the number of the codecs by the lCodecIndex.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lCodecIndex	Long

WMACodecsX - Public (Return Datatype: Long)


Description: Get a counter of the number of the WMA codecs that installed on the local machine.
Return: A long with a counter of the number of the WMA codecs.
No Parameters

WMACodecXVal - Public (Return Datatype: String)


Description: Get the WMA codec name by the lIndex.
Return: A string with the codec name.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Event Declares

DonePlay - Public


Raise when the component is done play.
No Parameters

DoneRecord - Public


Raise when the component is done record.
No Parameters

Err - Public


Raise when error is appearing.

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

ProgressRecord - Public


Raise when the component is on record mode, with the recording progress values.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sSize	String
	ByVal	sTime	String
	ByVal	lSize	Double
	ByVal	lTime	Double