Difference between revisions of "SDK Contents"

From Winamp Developer Wiki
Jump to: navigation, search
(add intro)
(format descriptions as list)
Line 5: Line 5:
 
==SDK Sections==
 
==SDK Sections==
  
Agave - collection of [[Wasabi API|Wasabi]] objects unique to Winamp 5
+
* Agave - collection of [[Wasabi API|Wasabi]] objects unique to Winamp 5
 
+
** Aave\AlbumArt - [[Album Art API]] interface definition files
:Agave\AlbumArt - [[Album Art API]] interface definition files
+
** Agave\Component - [[System Component Interface|W5S system component]]interface definition files
 
+
** Agave\Config - [[Agave Config API|Winamp 5 configuration]].  Not be confused with the Winamp3 [[Wasabi Config API]]
:Agave\Component - [[System Component Interface|W5S system component]]interface definition files
+
** Agave\Language - [[Language API]]
 
+
** Agave\Metadata - [[Agave Metadata API]]
:Agave\Config - [[Agave Config API|Winamp 5 configuration]].  Not be confused with the Winamp3 [[Wasabi Config API]]
+
* burner
 
+
* coverdirectory - Cover Directory sample plugin.  Demonstrates the [[Album Art API]], [[Service Factory|Service Factories]], and how to build a [[System Component Interface|System Component (W5S)]
:Agave\Language - [[Language API]]
+
* dsp_test - [[Audio Effects plugin|DSP Plugin]] example
 
+
* enc_flac - [[Audio Encoder Plugin]] example using the [http://flake-enc.sourceforge.net/ Flake] FLAC encoder.  Although the project name is enc_flac, the plugin compiles as enc_flake.dll to allow it to co-exist with the [http://flac.sourceforge.net/api/index.html libFLAC] based encoder that ships with Winamp.
:Agave\Metadata - [[Agave Metadata API]]
+
* gen_classicart - Example [[General Purpose Plugin]] which demonstrates creating a Skinned window and the [[Album Art API]]
 
+
* gen_ml - Collection of header files that comprise the [[Media Library API]] and the struct definition for creating a [[Media Library Plugin]].  Most of the content is contained in ml.h
 
+
* gen_tray - Source code for the System Tray plugin which ships with Winamp.
burner
+
* in_chain - Example plugin showing how to use another input plugin within your own input plugin
 
+
* in_raw - Example [[Input Plugin]]
coverdirectory - Cover Directory sample plugin.  Demonstrates the [[Album Art API]], [[Service Factory|Service Factories]], and how to build a [[System Component Interface|System Component (W5S)]
+
* in_tone - Example [[Input Plugin]]
 
+
* irctell - Example [[System Component Interface|W5S]] plugin demonstrating [[System Callbacks API]] and the old Winamp3 [[Media Core API]] (only available in modern skins)
dsp_test - [[Audio Effects plugin|DSP Plugin]] example
+
* maki - Tools and include files for compiling [[maki]] scripts for use in the Modern Skinning engine.  More information is available in the [[Skin Developer]] portion of this wiki.
 
+
* ml_http - Example [[Media Library Plugin]] demonstrating using embedded IE and the Javascript [[Javascript External Interface|window.external]] interface.
enc_flac - [[Audio Encoder Plugin]] example using the [http://flake-enc.sourceforge.net/ Flake] FLAC encoder.  Although the project name is enc_flac, the plugin compiles as enc_flake.dll to allow it to co-exist with the [http://flac.sourceforge.net/api/index.html libFLAC] based encoder that ships with Winamp.
+
* ml_iso - Example [[Media Library Plugin]] demonstrating the send-to menu
 
+
* ml_local - Header files comprising the Local Media Database API
gen_classicart - Example [[General Purpose Plugin]] which demonstrates creating a Skinned window and the [[Album Art API]]
+
* ml_xmlex - Example [[Media Library Plugin]] demonstrating basic media libary UI concepts and the [[XML Parser object]]
 
+
* mlExplorer - Standalone executable demonstrating how to use the [[Nullsoft Database Engine|Nullsoft Database Engine (NDE)]] in your own application to read Winamp's media library contents.
gen_ml - Collection of header files that comprise the [[Media Library API]] and the struct definition for creating a [[Media Library Plugin]].  Most of the content is contained in ml.h
+
* nde - [[Nullsoft Database Engine]] source code
 
+
* nsv
gen_tray - Source code for the System Tray plugin which ships with Winamp.
+
* nu
 
+
* playlist
in_chain - Example plugin showing how to use another input plugin within your own input plugin
+
* plLoadEx
 
+
* ReplayGainAnalysis
in_raw - Example [[Input Plugin]]
+
* Wasabi
 
+
* Winamp
in_tone - Example [[Input Plugin]]
+
* xml
 
+
* xspf
irctell - Example [[System Component Interface|W5S]] plugin demonstrating [[System Callbacks API]] and the old Winamp3 [[Media Core API]] (only available in modern skins)
+
 
+
maki - Tools and include files for compiling maki scripts for use in the Modern Skinning engine.  More information is available in the [[Skin Developer]] portion of this wiki.
+
 
+
ml_http - Example [[Media Library Plugin]] demonstrating using embedded IE and the Javascript [[Javascript External Interface|window.external]] interface.
+
 
+
ml_iso - Example [[Media Library Plugin]] demonstrating the send-to menu
+
 
+
ml_local - Header files comprising the Local Media Database API
+
 
+
ml_xmlex - Example [[Media Library Plugin]] demonstrating basic media libary UI concepts and the [[XML Parser object]]
+
 
+
mlExplorer - Standalone executable demonstrating how to use the [[Nullsoft Database Engine|Nullsoft Database Engine (NDE)]] in your own application to read Winamp's media library contents.
+
 
+
nde - [[Nullsoft Database Engine]] source code
+
 
+
nsv
+
 
+
nu
+
 
+
playlist
+
 
+
plLoadEx
+
 
+
ReplayGainAnalysis
+
 
+
Wasabi
+
 
+
Winamp
+
 
+
xml
+
 
+
xspf
+

Revision as of 15:39, 12 June 2009

The Winamp SDK is a collection of code and examples projects that illustrate how code can be written for Winamp. If you are looking to write a plugin but don't know where to start, try looking for an example project that does something similar. You can then check out that specific section of code and begin learning how winamp works.

You can download a copy of the Winamp 5.55 SDK here.

SDK Sections