ZPlay C# Class interface

C# Class interface for libZPlay library.

This is C# class wrapper for libzplay.dll library. Each method of this class is wrapper for one of C Style functions exported from libzplay.dll library.

Note:

ZPlay C# Class must have access to libzplay.dll to function properly.

All you need to do is to create instance of ZPlay class. Interaction with this class is implemented through class methods.

How to use C# interface

add libZPlay.cs to your project
include libZplay namespace
create instance of ZPlay class
use ZPlay methods to play music

Example

// add libZPlay.cs to your project
// ...

// include libZPlay namespace
using libZPlay;

// ...

// create ZPlay class
ZPlay player = new ZPlay();

// open file and play
player.OpenFile("myFile.mp3", TStreamFormat.sfAutodetect);
player.StartPlayback();

Classes

	Name	Description
	ZPlay	C# Class interface for libZPlay library.

Group

Interface

ZPlay Methods

	Name	Description
	AddFile	Add file to gapless queue.
	Close	Close open stream.
	DetectBPM	Detect beat-per-minute of current stream.
	DetectFileBPM	Detect beat-per-minute value of specified file.
	DrawFFTGraphOnHDC	Draw FFT graph on window control using window handle.
	DrawFFTGraphOnHWND	Draw FFT graph on window control using window handle.
	EnableEcho	Enable or disable echo.
	EnableEqualizer	Enable or disable equalizer.
	EnumerateWaveIn	Enumerate waveform-audio input devices.
	EnumerateWaveOut	Enumerate waveform-audio output devices.
	GetBitrate	Get current bitrate.
	GetDynamicStreamLoad	Get dynamic stream load.
	GetEchoParam	Get current echo effects.
	GetEqualizerBandGain	Get equalizer band gain.
	GetEqualizerParam	Get equalizer parameters, band gain and preamp gain.
	GetEqualizerPoints	Get equalizer points of frequency bands.
	GetEqualizerPreampGain	Get equalizer preamp gain.
	GetError	Get description of last error.
	GetFFTData	Get FFT data for currently playing samples.
	GetFFTGraphParam	Get parameters of FFT graph.
	GetFileFormat	Determine stream format of specified file.
	GetMasterVolume	Get output volume of wave out device driver.
	GetPitch	Get pitch.
	GetPlayerVolume	Get internal volume.
	GetPosition	Get current position.
	GetRate	Get rate.
	GetSettings	Get class instance settings.
	GetStatus	Get current status of stream (playing, paused, echo status, eqaulizer status, ....)
	GetStreamInfo	Get stream informations (length, sampling rate, channel number, ...).
	GetTempo	Get tempo.
	GetVersion	Get library version number.
	GetVUData	Get VU data for left and right channel
	GetWaveInInfo	Retrieves the capabilities of a specified waveform-audio input device.
	GetWaveOutInfo	Retrieves the capabilities of a specified waveform-audio output device.
	IsStreamDataFree	Check if stream data is free.
	LoadFileID3	Load ID3 data from specified file.
	LoadFileID3Ex	Load extended ID3 data from specified file. Only in version 2.00 and above.
	LoadID3	Load ID3 data from current stream.
	LoadID3Ex	Load extended ID3 data from current stream. Only in version 2.00 and above.
	MixChannels	Mix stereo channels into mono channel.
	OpenFile	Open disk file.
	OpenStream	Open memory stream.
	PausePlayback	Pause playing.
	PlayLoop	Play specified segment of song, in loop if needed.
	PushDataToStream	Push new data to dynamic stream.
	ResumePlayback	Resume paused playing.
	ReverseMode	Enable or disable reverse mode.
	Seek	Seek position.
	SetCallbackFunc	Set callback function.
	SetEchoParam	Set and change echo effect parameters.
	SetEqualizerBandGain	Set equalizer band gain.
	SetEqualizerParam	Set equalizer parameters, band gain and preamp gain.
	SetEqualizerPoints	Set equalizer points to create new frequency bands.
	SetEqualizerPreampGain	Set equalizer preamp gain.
	SetFFTGraphParam	Set and change parameters of FFT graph.
	SetMasterVolume	Set external volume.
	SetPitch	Change pitch without changing tempo.
	SetPlayerVolume	Set internal volume.
	SetRate	Change playing rate (change pitch and tempo).
	SetSettings	Set interface settings.
	SetTempo	Change tempo without changing pitch.
	SetWaveInDevice	Set wave out input for this class instance.
	SetWaveOutDevice	Set wave out device for this class instance.
	SetWaveOutFile	Set wave output to disk file.
	SlideVolume	Slide internal volume.
	StartPlayback	Start playing from current position.
	StereoCut	Cut center or sides from stereo.
	StopPlayback	Stop playing.

Structs, Records, Enums

	Name	Description
	TBPMDetectionMethod	Beat-per-minute detection method.
	TCallbackMessage	Callback messages.
	TEchoEffect	Echo effect structure.
	TFFTGraphHorizontalScale	FFT graph horizontal frequency scale.
	TFFTGraphParamID	FFT graph parameter identifier.
	TFFTGraphSize	Minimal FFT graph size.
	TFFTGraphType	FFT graph type.
	TFFTWindow	FFT window.
	TID3Info	ID3 informations.
	TID3InfoEx	Extended ID3 informations. Only in version 2.00 and above.
	TID3Picture	TID3 picture. Only in version 2.00 and above.
	TID3Version	ID3 version identifier.
	TSeekMethod	Seek method.
	TSettingID	Interface setting identifier.
	TStreamFormat	Stream format identifier.
	TStreamHMSTime	Hour-minute-second time format.
	TStreamInfo	Stream informations ( length, sampling rate, ...).
	TStreamLoadInfo	Dynamic stream load informations.
	TStreamStatus	Stream status informations.
	TStreamTime	Stream time structure.
	TTimeFormat	Time format.
	TWaveInInfo	Wave input info.
	TWaveInMapper	Specifies a waveform-audio output device capable of playing the given format.
	TWaveOutFormat	Wave out supported formats.
	TWaveOutFunctionality	Wave out optional functionality supported by the device.
	TWaveOutInfo	Wave out info.
	TWaveOutMapper	Specifies a waveform-audio output device capable of playing the given format.

Topics

Name	Description
libZPlay.cs
ZPlay Methods	The methods of the ZPlay class are listed here.
Classes	The following table lists classes in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.

Types

Name	Description
TCallbackFunc	Callback function prototype.

Web: http://libzplay.sourceforge.net/

Email: zcindori@inet.hr

Made with Doc-O-Matic® Express