Project: VB6Tapi
Version: 3.0.0
Report Date: 08/06/2023 12:06:18
By: Yaron Goali (WISERBIT DOT COM) for Microncode.com
User Control: cWave
Properties
CutSilence [Let] - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
Value |
Boolean |
CutSilence [Get] - Public (Return Datatype: Boolean)
CutSilenceVal [Get] - Public (Return Datatype: Long)
CutSilenceVal [Let] - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
Value |
Long |
MeterIn [Get] - Public (Return Datatype: Boolean)
MeterIn [Let] - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
Value |
Boolean |
Functions
CheckDeviceFormat - Public (Return Datatype: Long)
Description: Check if the device support the selected format.
Return: Zero if the device supports the format, false if not.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
|
iInOut |
InOut |
|
|
ChkFormat |
WaveFormat |
CheckDeviceFormatX - Public (Return Datatype: Long)
Description: UI for C++/VC6. Check if the device supports the selected format.
Return: Zero if the device support the format, false if not.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
ByVal |
iInOut |
Long |
|
ByVal |
nSamplesPerSec |
Long |
|
ByVal |
wBitsPerSample |
Integer |
|
ByVal |
nChannels |
Integer |
|
ByVal |
cbSize |
Integer |
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.
DonePlay - Public (Return Datatype: Boolean)
Description: Check if done play out.
Return: True if done, false if not.
FileSeek - Public (Return Datatype: Long)
Description: Seek to a position in the file in percent.
Return: Zero if success, else a number descibe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
lPosition |
Long |
FileSeekSec - Public (Return Datatype: Long)
Description: Seek to a position in the file in percent.
Return: Zero if success, else a number descibe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
lPositionSec |
Long |
GetDetailsDevice - Public (Return Datatype: Long)
Description: Get in/out device details to the DeviceDetails data type.
Return: 0 if success, or a number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
ByRef |
DeviceDetails |
WaveDeviceDetails |
|
ByVal |
InOut |
InOut |
GetDetailsDeviceX - Public (Return Datatype: Long)
Description: UI for C++/VC6. Get in/out device details without using the DeviceDetails data type. InOut can be Input = 1, Output = 2.
Return: 0 if success, or a number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
|
DeviceName |
String |
|
|
DeviceDriver |
String |
|
|
DeviceChannels |
Integer |
|
|
DeviceFormat |
Long |
|
ByVal |
InOut |
Long |
GetDetailsWaveFile - Public (Return Datatype: Long)
Description: Get wave file details to the WaveFileDetailsType data type.
Return: 0 if success, or a number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
WaveFile |
String |
|
|
WaveFileDetailsType |
WaveFileDetails |
GetDetailsWaveFileX - Public (Return Datatype: Long)
Description: UI for C++/VC6. Get wave file details without using the WaveFileDetailsType data type.
Return: 0 if success, or a number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
WaveFile |
String |
|
|
wFormatTag |
Integer |
|
|
nChannels |
Integer |
|
|
nSamplesPerSec |
Long |
|
|
nAvgBytesPerSec |
Long |
|
|
nBlockAlign |
Integer |
|
|
wBitsPerSample |
Integer |
|
|
cbSize |
Integer |
|
|
FileName |
String |
|
|
FilePath |
String |
|
|
SecondsLength |
Long |
GetPositionSeconds - Public (Return Datatype: Long)
Description: Get the current position in seconds.
Return: The currrent position in seconds.
GetPositionSlider - Public (Return Datatype: Long)
Description: Get the position of the slider
Return: a number describe the position
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 |
|
|
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 |
IsPausedIn - Public (Return Datatype: Boolean)
Description: Check if pause record.
Return: True if pause, false if not.
IsPausedOut - Public (Return Datatype: Boolean)
Description: Check if pause playing.
Return: True if pause, false if not.
IsPlaying - Public (Return Datatype: Boolean)
Description: Check if the control is playing.
Return: True if playing, false if not.
IsPreScreen - Public (Return Datatype: Boolean)
IsRecording - Public (Return Datatype: Boolean)
Description: Check if the control is on recording mode.
Return: True if recording, false if not
ISubclass_WindowProc - Friend (Return Datatype: Long)
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
hWnd |
Long |
|
ByVal |
uMsg |
Long |
|
ByVal |
wParam |
Long |
|
ByVal |
lParam |
Long |
NumOfWaveDevices - Public (Return Datatype: Long)
Description: Get the number of the sound device in the system.
Return: the number of in/out sound devices.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
InOut |
InOut |
PlayPause - Public (Return Datatype: Long)
Description: Pause playing.
Return: Zero if success, or an error number describe the error.
PlayStart - Public (Return Datatype: Long)
Description: Play a PCM WAV file directly to the DeviceIndex, DeviceIndex can be sound card or modem. Please make sure to play a file with the format that is supported by the voice modem formt (usually nChannels = 1, wBitsPerSample = 16, nSamplesPerSec = 8000).
Return: Zero if success, or an error number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
File |
String |
| Optional |
|
DeviceIndex |
Long(-1) |
| Optional |
|
BufferSize |
Long(800) |
PlayStop - Public (Return Datatype: Long)
Description: Stop play
Return: Zero if success, or an error number describe the error.
PlayUnPause - Public (Return Datatype: Long)
Description: UnPause playing.
Return: Zero if success, or an error number describe the error.
PreScreenClose - Public (Return Datatype: Long)
Description: Close pre screen call
Return: Zero if success, or an error number describe the error.
PreScreenOpen - Public (Return Datatype: Long)
Description: Open the pre screen call to the DeviceIndex with a selected format to play
Return: Zero if success, or an error number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
WaveFormatPreScreen |
WaveFormat |
| Optional |
ByVal |
ToDeviceIndex |
Long(-1) |
PreScreenOpenX - Public (Return Datatype: Long)
Description: UI for C++/VC6. Open the pre screen call to the DeviceIndex with a selected format to play
Return: Zero if success, or an error number describe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
nSamplesPerSec |
Long |
|
ByVal |
wBitsPerSample |
Integer |
|
ByVal |
nChannels |
Integer |
|
ByVal |
ToDeviceIndex |
Long |
RecordPause - Public (Return Datatype: Long)
Description: Pause record.
Return: Zero if success, or an error number describe the error.
RecordStart - Public (Return Datatype: Long)
Description: Start record from DeviceIndex with the InputFormat format.
Return: Zero if success, or a number descibe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
ByVal |
sFileName |
String |
|
|
InputFormat |
WaveFormat |
| Optional |
|
BufferSize |
Long(8000) |
RecordStartX - Public (Return Datatype: Long)
Description: UI for C++/VC6. Start record from DeviceIndex without the InputFormat format.
Return: Zero if success, or a number descibe the error.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
DeviceIndex |
Long |
|
ByVal |
sFileName |
String |
|
ByVal |
nSamplesPerSec |
Long |
|
ByVal |
wBitsPerSample |
Long |
|
ByVal |
nChannels |
Long |
|
ByVal |
BufferSize |
Long |
RecordStop - Public (Return Datatype: Long)
RecordUnPause - Public (Return Datatype: Long)
Description: UnPause record.
Return: Zero if success, or an error number describe the error.
WaveInErrText - Public (Return Datatype: String)
***************************************************************************************
Part 3: Recording
***************************************************************************************
Description: Get error description by error number.
Return: String contains the error description.
| Optional | ByVal/ByRef | Variable | Datatype |
|
ByVal |
ErrNum |
Long |
WaveOutErrText - 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 |
Event Declares
Err - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
FunctionName |
String |
|
|
ErrorNumber |
Long |
|
|
ErrorDecription |
String |
InBuffer - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
pBytes |
Long |
|
|
nSize |
Long |
InMeter - Public
| Optional | ByVal/ByRef | Variable | Datatype |
|
|
Meter |
Integer |