User talk:Culix

2010-05-20T12:25:47Z

Blo: Reverted edits by Blo (Talk) to last version by Ace Frahm

User talk:Culix

2010-05-20T12:25:12Z

Blo:

See my comments at [[Template_talk:Deleteme]]. I don't visit this Wiki very often, so if you leave a reply on my talk page, it may be a while before I see it. —[[User:Hydrargyrum|Hydrargyrum]]<sup>[[User_talk:Hydrargyrum|T]] [[Special:Emailuser/Hydrargyrum|@]]</sup> 18:43, 18 June 2009 (UTC)

== Going to do some more updating ==

Hi Culix,

I plan to make some more changes to your basic plugins wiki page. This is an outstanding start which I wanted to do for a while. You have encouraged me to actually do some of this. There is some interesting things about parts of the code that you have that I'd like to explain.

I'd like to turn these pages into a series of tutorials on plugins. The trick is that the gen_ plugins and ml_plugins are probably the most commonly used. We can go back and do some of the other types at some point but they tend to be more specialized.

I think the next step will be to expand your basic plugin to retrieve information from the Winamp core. I'll let you know and you can look at it. After that we'll talk about creating a dialog that can invoke methods in the plugin.

Thanks for starting the page. --[[User:SMonty|SMonty]] 20:48, 1 July 2009 (UTC)

== Request For Help ==

Please take a look at this:

http://dev.winamp.com/wiki/Talk:Beginner%27s_Basic_Plugin_Guide#Basic_gen_empty.dll_File_Crashes_WinAMP_On_Start_Of_WinAMP.

Culix,

Thanks so much for your help w/ the wiki. I would love to talk to you more to get your idea on how we can make this even better.

Much appreciated.

Glossary

2010-05-17T19:29:26Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]
== Glossary of Terms ==
* '''Agent''' - Winamp's taskbar component. Maintains file type associations.

* '''APE''' - Advanced Plug-in Effect. Third party Effect Module created for AVS.

* '''AVS''' - Advanced Visualization Studio comes bundled with Winamp. Allows endless user customization.

* '''Base Skin''' - The standard skin built into Winamp. Also the downloadable template used to create new skins.

* '''Bookmark''' - Winamp feature that allows quick access to favorite songs or streams.

* '''Codec''' - Short for coder/decoder. A software program for converting between digital data and analog signals. Winamp uses codecs to play many different kinds of audio files.

* '''Developer''' - Any one who creates a skin or writes an application or plug-in for Winamp.

* '''Discussion List''' - A mailing list hosted by Winamp.com to help foster the developer community.

* '''DLL''' - Dynamically Linked Library. A Win32 property that allows Winamp's plug-in architecture.

* '''DoubleSize Mode''' - Winamp option that doubles the width and height of the Main and Equalizer components.

* '''DSP Plug-in''' - A plug-in that manipulates audio data before being sent to the speakers.

* '''Easter Egg''' - A programming term used for a hidden, often humorous feature.

* '''Equalizer''' - Winamp component that allows audio tweaking for optimal sound quality.

* '''FAQ''' - Frequently Asked Questions.

* '''Forum''' - A message board hosted by Winamp.com to help foster the Winamp community.

* '''Flounder''' - Any of various marine flatfishes of the families Bothidae and Pleuronectidae, which include important food fishes.

* '''General Purpose Plug-in''' - A plug-in that does not require access to audio data.

* '''Input Plug-in''' - A plug-in that adds a new file type to Winamp's list of supported types.

* '''IPC''' - Inter-process communication. Basically, anytime one program communicates with another.

* '''Language Pack''' - A special plug-in that translates most Winamp text.

* '''Llama''' - A domesticated South American ruminant mammal (Lama glama) related to the camel, raised for its soft, fleecy wool. The only animal fully endorsed by Nullsoft.

* '''Mini-browser''' - Winamp component that allows internet browsing during audio play.

* '''MP3''' - MPEG-1 Audio Layer 3. A digital audio compression algorithm that acheives a compression factor of about twelve while preserving sound quality.

* '''NSDN''' - Nullsoft Developers Network. The developers source for official Nullsoft information.

* '''NSIS''' - Nullsoft Scriptable Install System. Nullsoft's in-house installer utility. Required for plug-in installation.

* '''Nullsoft''' - Group of benevolent artisans who revolutionize the computer world on a regular basis.

* '''Output Plug-in''' - A plug-in that directs audio flow to one or more destinations.

* '''PiMP''' - Plug-in Mini Packager. Predecessor to NSIS.

* '''PMP''' - Portable Media Player. Creative Zen, Apple iPod, etc. Not to be confused with the original name for NSIS (PiMP).

* '''Playlist Editor''' - Winamp component that allows easy sorting and sequencing of audio files.

* '''Plug-in''' - Basis of Winamp architecture. Allows third parties to add functionality to Winamp by "plugging in" additional code.

* '''Preset''' - Visually pleasing sequence of Effect Modules in AVS or Milkdrop.

* '''SDK''' - Software Development Kit. All the tools you need to perform a programming job.

* '''SHOUTcast''' - Nullsoft's internet streaming MP3 solution.

* '''Skin''' - Interchangeable visual interface for Winamp.

* '''Visualization Plug-in''' - A plug-in that uses audio data to drive graphics.

* '''WAL''' - Required format for Modern skins before submittal.

* '''WAV''' - Widely used uncompressed audio format. Usually more than 10X larger than MP3.

* '''Winamp''' - The ultimate high-fidelity music player for Windows 2000/XP/Vista. Winamp supports MP3, CD and other audio formats, not to mention hundreds of plug-ins and thousands of skins.

* '''Winamp.com''' - Official website of Winamp. Houses all approved skins, plug-ins, updates, forums, etc.

* '''WindowShade Mode''' - Winamp option that shrinks most components to a narrow bar with only most basic functionality.

* '''WSZ''' - Required format for Classic skins before submittal.

* '''WVS''' - Obsolete name for AVS.

== See also ==
* [[Plugin Terminology]]

Developers FAQ

2010-05-17T19:28:53Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]

'''''Like all wiki's, this page is a work in progress. This page is a placeholder for users to log developer related questions that they could not find answers to elsewhere in the Developer Network (or in the forums). As the site grows and common questions are asked, this page will develop into an FAQ page with subsections for each of the main development areas: Skin Developer, Visual Developer, & Plug-in Developer'''''

==Skin Developer FAQ==
*Q:How do make a Winamp skin?
**A: Start at [[Skin Developer]].

==Visual Developer FAQ==
*Q: How do I make a Visualization plugin?
**A: Start at [[Visual Developer]]

==Plug-in Developer FAQ==
*Q: How do I make a basic plugin?
**A: Try the [[Beginner's Basic Plugin Guide]].

Articles

2010-05-17T19:28:04Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]

==Skin Articles==

===Modern Skins===
*[http://dev.aol.com/article/2007/winamp_skins Winamp Skins Development Tutorial]
*[[Creating a ClassicPro Skin]]

===ClassicPro Skins===
* [[Creating a ClassicPro Skin]]

==Visualization Articles==
*[[MilkDrop_Preset_Authoring|MilkDrop Preset Authoring]]

==Plug-in Articles==

===General===
*[[Plugin Terminology]]
*[[Beginner's Basic Plugin Guide]]
--
* How To create:
**[[APE Plugins|AVS Plugins]]
**[[DSP Plugin|Audio Effects (DSP) plugins]]
** [[General Purpose Plugin|General Purpose plugins]]
** [[Input Plugin|Input plugins]]
** [[Media Library Plugin|Media Library plugins]]
** [[Output Plugin|Output plugins]]
** [[Portable_Plugin|Portable_Plugins]]
** [[Visualization_Plugin|Visualization_Plugins]]
--
* Overview of:
**[[Audio Encoder Plugin|Audio encoders (transcoding, CD ripper)]]
**[[JNetLib|JNetLib networking library]]
**[[Nullsoft Database Engine|Nullsoft Database Engine (NDE)]]
**[[NSV Plugins|NSV Audio and Video decoders]]
**[[System Component Interface]]
**[[Skinning Plugins|WAC Skinning plugins]]
**[[Winamp Orgler]]
**[[XML Parser Object]]

===API===
*[[Agave Config API]]
*[[Agave Metadata API]]
*[[Album Art API]]
*[[Application API]]
*[[Burner API]]
*[[Decode File API]]
*[[Language API]]
*[[Playlist API]]
*[[Podcasts API]]
*[[Media Core API|Media Core API (Freeform skins only!)]]
*[[Media Library API|Media Library SendMessage API]]
*[[Memory Manager API]]
*[[Random API]]
*[[Replay Gain API]]
*[[Service Manager API]]
*[[Skin API]]
*[[System Callbacks API]]
*[[Tagz API]]
*[[SendMessage API|Winamp 2 API]]
*[[Wasabi|Overview of the Wasabi API]]

===Services===
*[[File Reader Service]]
*[[Image Writer Service]]
*[[Image Loader Service]]
*[[Text Feed Service]]

==Online Services Articles==
* [[Tips for Writing an Awesome Online Service]]
* [[Winamp Browser Support]]

[[Category:Articles]]

SHOUTcast Broadcaster

2010-05-17T19:27:48Z

Blo: New page: '''Breadcrumb''' -- Wiki Main : Skin Developer : Visual Developer : Plug-in Developer : Online Service Developer : SHOUTcast Broadcaster : [[Articles|Arti...

Online Service Developer

2010-05-17T19:27:35Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]

[[Category:Winamp]]
==The What and Why of Online Services==
===What is a Winamp Online Service===
A Winamp online service has several distinctive features. The first is that it is a web site that appears embedded within the Winamp client. The second, and more fun feature, is that the web pages so displayed are able to interact with the Winamp Client. The third is that access to the online services is presented to the large Winamp community as part of the Winamp client's Online Services Gallery.

===Benefits to creating an Online Service===
There are many benefits for developing an Online Service. Before we delve into the list, the most important benefit is distribution. Winamp is a great distribution platform as it has 77 million unique users every month!!

Hence,
#a) if your website needs page views and more monetization
#b) if your brand needs more eye balls
#c) if your blog needs more readers
#d) if you want to develop an web application which has something to do with music, video, photo, streaming, podcasts, music events, #e-commerce, games then you will never regret making an Online Service in Winamp.

Try it now!

===Integrating Online Services with Winamp===
The Online Services API is designed to allow web pages, hosted (displayed) within the embedded browser of the Winamp client, to leverage a series of APIs that can interact with the rest of the Winamp application. In order to make this happen you have to do the following:

*Make sure you have the latest version of the Winamp client (v5.55 or above). You can download the client from [http://winamp.com/player winamp.com/player]
*Make sure you have the latest version of the Online Services developer plugin (ml_webdev.dll). Get the plugin from this [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe link]. This plugin will create a "WebDev Platform" node within the Medial Library pane. It has it's own special installer.

In order to change the starting web page for the online service, start the Winamp client and configure the plugin.
#Open the Winamp player
#Select Options->Preferences->Plug-ins->Media Library.
#Select "WebDev Test Platform v2.0" and press "Configure selected plugin".
#On the Web Dev Preferences dialog, set the URL field to the URL of the initial web page for the online service. For example, file://c:\myonlineservice\webdev.html
#Click on "Web Dev Test Platform" in the Media Library. You may have to right click and choose refresh to see the new web page.
You should now see the initial page of your online service in the Winamp embedded browser.

==Registering an Account==
While you can start developing an online service immediately, you will need to create a Winamp account before you can submit your service. To do this follow these steps:
*Open your favorite web browser and go to http://www.winamp.com
*Choose "Register" from the top of the page.
*Complete the registration process

==Submitting Your Service==
===The Submission Process===
Once you have come up with an amazing idea for an Online Service that uses Winamp, how do you get it into the Winamp Online Services Gallery so that users can start visiting it? Glad you asked. First you must start by submitting the service to Winamp. After being submitted, the service will go through a Winamp internal review process. If the service passes the review it will then be automatically included in the Winamp Online Services Gallery.

The progress of your service through these steps can be seen through the use of the "My Profile" link at the top of the Winamp.com main page after logging in.

====Submitting an Online Service====
*Login to www.winamp.com
**Navigate to www.winamp.com
**Select "Winamp.com: Login" from the top of the page
**Enter the email address and password specified when you registered your account.
**Mouse over the gold "Online Services" button at the top of the screen.
**Choose "submit an online service" from the buttons in the drop down
**Make sure you follow the guidelines specified and press "Proceed".
**Enter the following information on the form:
***Service Name (15 characters max) - This name will be displayed on the first line for the service in the Winamp Gallery.
***Description (750 characters max) - Enter text describing your online service.
***Online Service URL - Enter the URL to launch your service.
***Categories - Select two categories so your service can be grouped with other services.
***Tags - Enter tags so that users can find your service by searching
***Thumbnail Image (optional, .gif, .jpg, .png, max size 178x75 pixels) - Displayed in the Winamp Gallery.
***Installer Image (optional, .gif, .jpg, .png, max size, 64x64 pixels - Displayed by Winamp Installer
***List Icon Image (optional, .gif, .jpg, .pgn, max size: 16x16 pixels - Displayed in the Winamp "Media Library" pane.
***Country - Select the countries which your online service supports.
***Language - Select the languages which your online service supports.
***Customer Support Email Id - An email address where user comments/complaints will be sent.
***Click and read the Terms and Conditions
***Check "Agree to Terms and Conditions
***Click "Finish"

=====Categories/Types of Online Services=====
*Events
*Streaming
*Podcasts
*Photo
*Music
*Video
*Radio
*E-Commerce
*Artists
*Games
*Internet TV
*Others

=====Tags Vs. Categories=====
You can tag/categorize a piece of information in your site and allows this piece of information to be searched and indexed.

So what are categories? Categories help you organize your content under a more familiar taxonomy. By familiar, we mean non-unique and non-personal words; thereby allowing a user to navigate your content with ease knowing what they want. That's the reason why we have fixed the categories. They are Music, Video, Radio, E-Commerce, Photo, Artists, Streaming, Podcast, Games, Internet TV, Events and Other. This will also give you a clear indication on what you can actually create. And if you think you can create something else, there is always the 'Other' category.

Then why do we need tags? Well, you can personalize your Online Service with your own tags. For e.g. for a hypothetical online service Music Shoppe (Let's say) tags can be 'music shoppe', 'music shop', 'purchase music', 'music shop', 'music store' whereas categories can be broader like 'music' & 'e-commerce'. All you have to do is make them short, crisp, relevant (search compatible) and small in numbers so that they are relevant.

Tags will be introduced shortly. Till then, please use categories :)

===Monitoring the Status of your Submission with "My Profile"===
After you have successfully submitted an online service, Winamp will put it through a review process. You can check the status of your online service by examining the "My Profile" link in the upper right of the screen after logging in to www.winamp.com.

Note that once you go to your profile, there are three links, one for each of the types of submissions you may have made. Choose "Online Services" to see that type.

The online service will proceed thru the following stages:

#Online Services in Review - The online service has been submitted and is awaiting review
#Approved Online Services - The service has been reviewed and is waiting to be either published or rejected. An online service should only stay in this state for a short time.
#Published Online Services - The online service was found to be acceptable and is now available in the Winamp Gallery.
#Rejected Online Services - The online service was found to be '''un'''-acceptable and is '''not''' available in the Winamp Gallery.

===Managing your Online Service with "My Profile"===
Once your online service has been published, there are several things you can do to manage it through the My Profile page.

====Viewing Service Information====
Each published online service will show the following:
*Unique ID - A ID that uniquely identifies your online service.
*Version # - The current version number of your online service.
*Description - The description you typed when submitting the service.
*First Published on - Date on which this online service was first published.
*Last Edited on - Last date this online services was edited.
*Last Approved on - Last date this online service was approved.
*Reporting On - A section showing the following statistics
**Service has been added - The service is available in the gallery.
**Service has been removed - The service is not available and has been deleted.
**Service has been accessed - The number of times users have accessed the site through the Winamp Client.
**Unique Users - The number of views by unique (i.e., new ip addresses) users.
**Ratings - Average user rating.
**Number of Ratings - How many users have rated the online service
**Abuse Reports - How many abuse reports have been sent against this service.

====Editing your Online Service Info====
My Profile contains an '''EDIT''' button so you can change the details that you entered when you first submitted the online service for review. This button will take you to a form where you can change these values. Changing the values will increase the version number of the online service and submit the service for review.

====Removing your Online Service====
My Profile also has a '''REMOVE''' button so the author can delete the online service. To reinstate the service you will have to resubmit it.

====Hiding your Online Service====
'''Hide from Gallery''' will prevent the online service from appearing in the Winamp client online services gallery. This can be used to temporarily prevent users from subscribing to the service.

==Style Guide==

Please reference this wiki page for optimizing how your online service looks/performs inside of Winamp

[[Winamp_Browser_Support|Winamp Browser Support]]

==JavaScript APIs==
Here is a summary of the API methods that can be called from an online service.

For more details on the methods available check out the [[complete JavaScript API technology framework]]

*Transport API
**Play
**Stop
**Pause
**Advance to next track
**Back up to previous track
**Shuffle
**Repeat
**Event Notifications - so the web page can tell when the events happen
***When the player starts playing
***When the player is stopped
***When the player is paused
***When the player reaches the end of a file
**Metadata - get metadata for currently playing song
**position - change the playback position of currently playing song

*Playqueue API
**The ability to alter the Winamp Queue of songs about to be played.
***Play - clear the queue and play a song.
***Enqueue - add a song to the queue
***Insert - add a song to the queue at a position
***Clear - clear the queue
***Metadata - get metadata for a song in the queue

*Playlists API
**Get a list of all playlists
**Open a playlist for alteration
**Save a modified playlist

*Playlist methods - once a playlist is opened these are available.
**Get and set info about individual items in the playlist
**Swap two songs
**Randomize the order of songs
**Reverse the order of songs
**Sort By Filename
**Sort By Title
**Clear (empty) the playlist

*Bookmarks API
**Add a bookmark
**TBD

*Podcasts API
**Subscribe to a Podcast
**More TBD

*Secuirty API
**In place, but not fully ready
**TBD

*LocalMedia API
**TBD

*History API
**Query the History DB - retrieve info about songs played previously

*Config API
**The ability to store JavaScript properties persistantly.

*Application API
**Launch the internal Winamp browser.
**Launch an external browser.
**Get the version of the internal browser.
**Get the language pack info

*Skins API
**Retrieve color and font information regarding the currently assigned Winamp client skin.

*MediaCore API
**Retrieve metadata for a specified file
**Determine whether a specific file format (file extension) is supported by the Winamp Client.

==User Feedback==
There are several methods by which users can provide feedback on your online service.

===Ratings by Users===
The Winamp client allows users to rate your online service. You can see the average rating and the number of times that your service has been rated using the "My Profile" link on winamp.com after logging in. This way you can tell whether thousands of people adore your service, or perhaps it was a single rating from your best friend.

===Abuse Reporting===
Users can also complain if they find something objectionable. These "abuse reports" may be forwarded to the online service developer to be resolved. So don't do bad things. And no, SlyHawk, parcour will not help you here.

==Additional Considerations==
===Security===
In order to help protect users from potential abuse by online services, Winamp has implemented a strategy to notify users that a web service is about to issue one of the online service api methods. The warning message will ask the user whether the method should proceed. Each security prompt will be applied to the action being requested as well as certain related actions of the same API. There is also a way to indicate that the selection should be used for ALL other security prompts for the current online service. This prevents the user from being bombarded with what may sound like repetitive requests. If the author of the online service upgrades their service, these choices will be carried forward to the new release.

For a more in depth discussion of the security prompts go to [[Online Service Security Prompts]].
[[http://www.example.com link title]]

Plug-in Developer

2010-05-17T19:26:48Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]

==Plug-in Overview==

===Writing A Plug-in===
Winamp plug-ins are files that extend Winamp's functionality. There are currently seven different plug-in types, each of which extends Winamp in a particular way. Winamp plug-ins are implemented as 32-bit Windows DLLs. Here are the plug-in categories:

#Input plug-ins: Input plug-ins give Winamp the ability to play additional file types that aren't supported by Nullsoft directly.
#Output plug-ins: Output plug-ins allow Winamp to manifest audio data in different ways.
#General purpose plug-ins: Anything that needs to run continuously in the background or doesn't require audio processing qualifies as a General purpose plug-in.
#DSP/effect plug-ins: DSP Plug-ins manipulate audio data before actually being sent to the speakers (or whatever the Output plug-in decides to do with it).
#Visualization plug-ins: "Vis" plug-ins display some sort of visual effect based on audio that's being decoded by Winamp.
#Language packs: Language packs are used to internationalize Winamp to the language of your choice.
#Media Library plug-ins: Media Library plug-ins extend the media library for instance, for portable devices such as iPods, accessing Media Library databases, etc.

Most of the plug-in types (with the exception of Language packs) export one function, which is used to query the plug-in of its interface. The way each plug-in is queried varies, and will be covered on a type-by-type basis.

All of the plug-ins are designed to be written in C or C++, using Microsoft Visual C++ 4.0 or later. Other people have reported success with writing some forms of plug-ins using Delphi, LCC, and Visual Basic. We don't use these alternate development platforms, so we can't really support development on them (writing this page alone took way too much time, wink). The [http://forums.winamp.com/ Winamp forums] are a good place to start.

====Basic start====
Check out the [[Beginner's Basic Plugin Guide]].

===Submitting Your Plug-in===

Once your plug-in is bug-free, the ultimate step is to share your masterpiece with the world. This is where Winamp.com steps in. Submitting your plug-in will allow people all over the world to enjoy the fruits of your labor. To do this, just follow these steps:

#Go to http://www.winamp.com/user/submit
#Click the "Submit a plug-in" button.
#Fill in the blanks:
##Name: The name of your plug-in.
##Comment: The short blurb that comes up when people browse the plug-ins page.
##Description: The longer blurb that is displayed when people view the plug-in details page.
##Categories: Choose Primary and/or Secondary (optional) categories to properly sort your plug-in.
##Thumbnail: Click on the "Browse" button to find the .gif, .jpg, or .png file on your computer. Note: the image file dimensions should be no larger than 178px by 75px.
##Screenshot: (Full-sized screenshot of your plug-in.) Click on the "Browse" button to find the .gif, .jpg, or .png file on your computer. Note: the image file dimensions should be no larger than 275px by 600px.
##Plug-in File: Click on the "Browse" button to find your PiMP-ed .EXE file on your computer.
#Click the "Submit" Button, and...
#Voila! Your plug-in is on its way to being displayed before the world.

====Submission Checklist====
Please ensure that your Plugin meets the following terms before submitting it to www.winamp.com:
*Your Plugin is tested and won't blow away other's computers due to silly bugs. For getting your plugin tested, please post it in this [http://forums.winamp.com/forumdisplay.php?s=&forumid=14 forum] first.
*You have packed the Plugin with an installer that auto-detects the Winamp installation directory (or where the plugin should go to in order to work). We recommend using [http://nsis.sourceforge.net/ NSIS]. It is free and you can find an example installer script [http://nsis.sourceforge.net/Winamp_Plugin_Installer_Scripts here].
*You havn't submitted the plugin already. If so, please use the 'edit' function for your plugin shown in your [http://www.winamp.com/user/main User Account Central].

====Plug-in Category Descriptions====
Please choose the categories thoughtfully. It will make finding your plug-in much easier if it is in the right categories.

AVS Presets: Any presets or APEs for Nullsoft's AVS plug-in.
DSP/Effect: Manipulates audio data.
Encoding: Plug-ins that encode media.
Games: Any plug-in that takes input and rewards "good" behavior.
General: Does not depend on audio data to run.
Input: Reads new audio file type.
Language Packs: Translates Winamp to a new language.
Output: Converts to new type of audio file or sends audio through alternate path.
Plug-in Skins: Plug-ins that change the look and feel of Winamp.
Portable Devices: Plug-ins that interact with removable media.
Visualizations: Visualization ... plug-ins.

==Tools==
* Visual Studio 6.0 or higher (Visual Studio 2003 is highly recommended.You can download a free copy of [http://www.microsoft.com/Express Visual Studio Express] from Microsoft. Unfortunately it is a newer version and not full-featured and we cannot guarantee that the SDK examples will work properly with this edition.
* [http://nsis.sourceforge.net Nullsoft Scriptable Install System] or other installer software for packaging your completed plug-in. Check this [http://nsis.sourceforge.net/Winamp_Plugin_Installer_Scripts example] for creating a NSIS Installer for your plugin.
* [http://www.7-zip.org 7-Zip] or other archiver for packaging your WSZ or WAL skin files.

==SDK Documentation==
The SDK includes everything you'll need to develop a Winamp plug-in. It also includes a basketful of example plug-ins to get you going. It is recommended that you create your plug-in as a subdirectory of the install path ("C:\Program Files\Winamp SDK" by default) as the #include paths of the examples assume this.

*[[SDK Contents]]
*'''[http://download.nullsoft.com/winamp/plugin-dev/WA5.55_SDK.exe Download SDK]'''

==Resources==
* [[Articles#Plug-in_Articles|Plug-in Articles]]
* [[Developers_FAQ#Plug-in_Developer_FAQ|Plug-in FAQ]]

==Community Links==
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=14 Winamp Developer Forum]
*Upload: [http://www.winamp.com/user/submit-plugin Submit Your Plug-in]
*Browse: [http://www.winamp.com/plugins Download Plug-ins]

Visual Developer

2010-05-17T19:26:33Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]
==What is a Visualization?==
Visualizers or Visualization Plugins are dynamic add-ons that produce images, colors, and textures that change based elements of the music being played. Winamp offers two primary visualization plugins ([[Visual_Developer#AVS_Unleashed | AVS]] & [[Visual_Developer#Milk_Drop_Unleashed | MilkDrop]]) allowing you to create different presets. If you’re feeling invincible, you can even attempt to create your own visualization plugin or you can stay platform. There are many [http://www.winamp.com/plugins/browse/1 visualization plugins] available which users have generated.

==What is a Preset?==
Presets are outputs of a visualization platform. You can customize the visualizers and get any effect you want. Many users have uploaded such presets in [http://www.winamp.com/plugins/browse/11 Winamp.com]

==AVS Unleashed==
AVS is the mother of all Winamp visualization plug-ins. It lets the user build a countless number of custom visualizations from an ever-expanding library of effects. AVS supports windowed/fullscreen rendering, preset customization, module stacking, skinnable windows, support for Sonique visual plug-ins, and a ton of other features. AVS is now bundled with all versions of Winamp after v2.6, so everyone can get a taste of its visual sonic goodness.

===Module References===
Below is some information on AVS modules. WVS is our codename for our global mind control device. With it we shall overtake the world. And have another excuse to take mind-altering substances.

Currently information about the superscope module is here. It uses all kinds of math stuff. Justin is so smart. You can look here for more general information about making presets.

====Superscope Reference====

The superscope allows you to create your own designs.

To have multiple statements on one line, use a semicolon (;) to delimit the statement. Use parenthesis '( and )' if you are unsure about precedence.

'''Fields:'''

{| Border="1"
!Field !! Description
|-
|init || set initial variable values here
|-
|point || This is where the shape of the superscope is defined
|-
|frame || Used to define movement and transformations
|-
|beat || Expression that gets evaluated on the beat
|-
|}

'''Operators:'''

{| Border = "1"
!Operator !! Description
|-
|= || assign
|-
|'+,-,/,*' || 'plus, minus, divide, multiply'
|-
|| || convert to integer, and do bitwise or
|-
|& || convert to integer, and do bitwise and
|-
|% || convert to integer, and get remainder
|-
|}

'''Variables:'''

{| Border = "1"
!Variables !! Description
|-
|n || number of points to render (set in Init, Beat or Frame)
|-
|x || x coordinate, between -1 and 1
|-
|y || y coordinate, between -1 and 1
|-
|i || position of the scope (0..1). The point position.
|-
|v || value at point i (-1..1)
|-
|b || 1 if beat. 0 for no beat. Used for beat changes
|-
|w || width of screen
|-
|h || height of screen
|-
|red || red value. (0..1). Set this variable to set red value.
|-
|green || green value. (0..1) Set this variable to set green value.
|-
|blue || blue value. (0..1) Set this variable to set blue value.
|-
|t, d || variables commonly used for movement
|-
|}

'''Functions:'''
{| Border = "1"
!Variables !! Description
|-
|abs(var)|| returns the absolute value of 'var'
|-
|sin(var) || returns the sine of the angle var (expressed in radians)
|-
|cos(var) || returns the cosine of the angle var
|-
|tan(var) || returns the tangent of the angle var
|-
|asin(var) || returns the arcsine of var
|-
|acos(var) || returns the arccosine of var
|-
|atan(var) || returns the arctangent of var
|-
|sqr(var) || returns the square of var
|-
|sqrt(var) || returns the square root of var
|-
|pow(var, var2)|| returns var to the power of var2
|-
|log(var) || returns the log base of var
|-
|log10(var) || returns the log base 10 of var
|-
|sign(var) || returns the sign of var or 0
|-
|min(var, var2)|| returns the smallest value
|-
|max(var, var2) || returns the greatest value
|-
|sigmoid(var, var2)|| returns sigmoid function value of x=var (var2=constraint)
|-
|rand(var) || returns a random value between 0 and var
|-
|band(var, var2)|| boolean and, returns 1 if var and var2 are != 0
|-
|bor(var, var2) || boolean or, returns 1 if var or var2 is != 0
|-
|bnot(var) || boolean not, returns 1 if var == 0 or 0 if var ! = 0
|-
|if(cond, vartrue, varfalse) || if condition is nonzero, returns valtrue, otherwise returns valfalse
|-
|equal(var, var2) || returns 1 if var=var2, else 0
|-
|above(var, var2) || returns 1 if var > var2, else 0
|-
|below(var, var2)|| returns 1 if var<var2, else 0
|-
|}
jjjjjjjj

===Making Presets===
We are going to attempt to reproduce a simple version of one of my favorite presets: Lone's "No way to go". Successful presets usually start off with one or more Render Modules, and then have a number of Trans Modules added to subtly manipulate the effect. Lone's preset is no exception. Again, before we start, make sure that you have both Winamp and AVS installed:
# Start Winamp and AVS
# Right-click in the AVS window, and select AVS Editor
# In the Editor window, click on Preset. A drop-down menu appears
# Click on New. This creates a new blank preset
# Click on Main. The option to Clear every frame should appear in the right window. If enabled, this will paint the screen black at the beginning of each frame, erasing the previous one. For this preset, leave this option unchecked
# We will now add Effect Modules to this presets. Click on +, then click on Render, then click on Moving Particle. New options should appear in the right half of the window
# Click on the white box labeled "color". A whole new color window should pop up
# Click on a basic color (it helps the effect if it isn't a "pure" color, like orange or purple). Now click OK. The color box should now be the same color that you chose
# Make sure the Onbeat Sizechange option is enabled
# A moving blob of color is a bit interesting, but it could be better. We will now alter how that Moving Particle is displayed by adding some Trans Modules
# Click +, then click Trans, then click Water
# Click +, then click Trans, then click Blur
# Click +, then click Trans, then click Movement. A new list of effects should appear in the right half of the window. Click on sunburster

Congratulations, we have replicated Lone's Preset! You can also drag an included Effect Module up or down the list to play with sequencing. I hope that you have realized by now that ANY permutation of the existing Modules or setting modification will result in a new effect! Keep experimenting!

====Advanced Tactics====

After creating a few original presets, it is natural to want even more options and control. AVS now has a very powerful tool: Effect Lists. To use an Effect List simply as an organizational tool is to squander its potential. The idea is that everything in an effect list gets rendered into a separate buffer before being added to its parent buffer. You now have the power to create completely separate effects off screen, manipulate them freely, possibly blending them together, all before finally displaying the final effect in one shot.
#Open AVS Editor#Create a new preset
#Click on Main, then disable the Clear every frame option
#Click on +, then on Effect List to add an Effect List
#In the Effect List options, make sure the Enabled and Clear every frame check boxes are checked. For the Input blend mode, select Ignore. For the Output blend mode, select Subtractive Blend 1
#Click on +, then on Trans, then on Mosaic
#Click on +, then on Render, then on Simple
#Click on Main, to stop adding to the Effect list
#Click on +, then on Trans, then Fadeout
#In the Fadeout options, Click on the Fade to Color Box, and select a nice red color#Click on +, then on Render, then on Bass Spin

If you have followed the instructions faithfully, you should get an effect tree that looks like this:

'''Main'''
* Render / Bass Spin
* Trans / Fadeout
'''Effects List'''
* Render / Simple
* Trans / Mosaic

That having been done, let's examine this preset:
A Bass Spin is placed into the main parent buffer.

Then, the Effect List creates a separate, secondary buffer.

This buffer starts out black (cleared every frame), ignores what is in its parent buffer and a Simple waveform is drawn into it. Notice that the Mosaic modifier ONLY affects the Simple effect as it is totally segregated from the parent buffer.

Now that all effects in the Effect List have been processed, the secondary buffer is blended back into the parent buffer using the blend mode specified in the Effects List options; in this case, Subtractive Blend 1.

This results in a dark colored Simple effect overlaid over the white Bass Spins.

What this means is that you can prevent Trans modifiers from affecting whole groups of modules, which in turn gives you much finer control over the visual effects. I hope this simple tutorial has shed some light on to the mystery of Effect Lists. It took me a bit of head scratching to wrap my mind around the usefulness of parent and child buffers, but now all my old presets seem so primitive. Keep playing with AVS and you will impress yourself! I guarantee it!

===Writing APEs===
BOX is a quick and dirty demonstration of basic APE structure and the utilization of AVS features. It takes advantage of AVS's built-in beat detection and easy access to the frame buffer to flash a rectangle onscreen on every beat. We also learn how to set up a configuration screen template, load and save configuration settings, and use the default color selector. There is very little fat, so you can use this as a template for future APEs. You can view the main file below.

====Box Source code====

You can check a sample [[box source code here]]

==Milk Drop Unleashed==
'''MilkDrop''' is a music visualizer - a "plug-in" to the Winamp music player. As you listen your music in Winamp, MilkDrop takes you flying through the actual soundwaves you're hearing, and uses beat detection to trigger myriad psychedelic effects, creating a rich visual journey through sound. MilkDrop can also be driven by a live audio feed (microphone or line-in)

'''MilkDrop 2''' is a major upgrade to the original MilkDrop visualizer, opening up
the power of modern graphics chips and programmable pixel shaders to the realm
of music visualization. Pixel shaders allow dozens, even hundreds of complex
instructions to be executed for every pixel on the screen, every frame.
Other new features include jpg textures, gaussian blurring, a preset "mash-up"
feature, and a prest "back" button. MilkDrop 2 is backwards-compatible with
presets from MilkDrop 1.

For a comprehensive understanding, please go through the [[MilkDrop Unleashed Guide]]

To create your own presets, check out the [[MilkDrop_Preset_Authoring]] Guide

For on-going discussions on Milk Drop, drop in the [http://forums.winamp.com/forumdisplay.php?forumid=81 Milk Drop Forums]

==Developer Resources==
* [[Articles#Visualization_Articles|Visual Developer Articles]]
* [[Developers_FAQ#Visual_Developer_FAQ|Visual Developer FAQ]]
* Rovastar's [http://www.milkdrop.co.uk/ MilkDrop Resource Website]
* Download MilkDrop [http://www.nullsoft.com/free/milkdrop/Milkdrop_1.04_Source.zip Source Code]
* [http://forums.winamp.com/forumdisplay.php?forumid=81 MilkDrop Forums]

Skin Developer

2010-05-17T19:26:09Z

Blo:

'''Breadcrumb''' -- [[Main_Page|Wiki Main]] : [[Skin Developer]] : [[Visual Developer]] : [[Plug-in Developer]] : [[Online Service Developer]] : [[SHOUTcast Broadcaster]] : [[Articles|Articles Page]] : [[Developers FAQ|FAQ]] : [[Glossary]]

== Classic Skins ==
Classic skins are skins that adhere to the Winamp 2 style model. Classic skins are easier to create than Modern skins but do not allow the author to change the form or function of the player. Classic authors may only replace a standard set of images that alter the player's visual appearance.

* '''[[Creating Classic Skins]]'''

== Modern Skins ==
Modern or Freeform skins were originally designed to work with Winamp3. What separates them from the average skin is the fact that they are not confined to the classic rectangular shape. In fact they can be any shape you want them to be and you can put the Winamp control buttons anywhere you want. Some skinners have even added extra buttons that extend the functionality of Winamp right there on the skin. Sounds too good to be true huh? Well these skins require a bit more coding to make and some of the graphics that go into them are quite large. Consequently, Freeform skins may take a bit longer to download from our site and they may take a few extra seconds to load when you switch from one skin to another. But trust me when I say that Freeform skins are worth the extra time and effort. Skin developers have done some incredible things with these skins. You have to check them out.

* '''[[Creating Modern Skins]]'''



<groupdef id="Backgrounds" name="BckElements">
<layer id="LayerID1" image="common/bck_seek.png" x="19" y="92" />
<layer id="LayerID2" image="common/bck_visualizer.png" x="22" y="25" />
<layer id="LayerID3" image="common/slider_volume_BCK.png" x="212" y="64" />
</groupdef>


<groupdef id="PlayButtons" name="Player Buttons">
<button
id="btnPlay"
action="PLAY" param=""
x="11" y="106"
image="vista/vst_btn_play_N.png"
hoverimage="vista/vst_btn_play_H.png"
downImage="vista/vst_btn_play_D.png"
tooltip="Play"
/>

<button
id="btnPause"
action="PAUSE" param=""
x="61" y="117"
image="vista/vst_btn_pause_N.png"
hoverimage="vista/vst_btn_pause_H.png"
downImage="vista/vst_btn_pause_D.png"
tooltip="Pause"
/>

<button
id="btnStop"
action="STOP" param=""
x="104" y="117"
image="vista/vst_btn_stop_N.png"
hoverimage="vista/vst_btn_stop_H.png"
downImage="vista/vst_btn_stop_D.png"
tooltip="Stop"
/>

<button
id="btnEject"
action="EJECT" param=""
x="146" y="117"
image="vista/vst_btn_open_N.png"
hoverimage="vista/vst_btn_open_H.png"
downImage="vista/vst_btn_open_D.png"
tooltip="Eject / Open"
/>

<button
id="btnPrev"
action="PREV" param=""
x="240" y="116"
image="xp/xp_btn_prev_N.png"
hoverimage="xp/xp_btn_prev_H.png"
downImage="xp/xp_btn_prev_D.png"
tooltip="Previous"
/>

<button
id="btnNext"
action="NEXT" param=""
x="288" y="116"
image="xp/xp_btn_next_N.png"
hoverimage="xp/xp_btn_next_H.png"
downImage="xp/xp_btn_next_D.png"
tooltip="Next"
/>

</groupdef>


<groupdef id="grTechButtons" name="Other Buttons">
<togglebutton
id="btnPL"
action="TOGGLE" param="guid:pl"
x="19" y="0"
image="vista/vst_btn_PL_N.png"
activeImage="vista/vst_btn_PL_H.png"
downImage="vista/vst_btn_PL_D.png"
hoverimage="vista/vst_btn_PL_H.png"
tooltip="Playlist"
/>

<togglebutton
id="btnML"
action="TOGGLE" param="guid:ml"
x="47" y="0"
image="vista/vst_btn_ML_N.png"
activeImage="vista/vst_btn_ML_H.png"
downImage="vista/vst_btn_ML_D.png"
hoverimage="vista/vst_btn_ML_H.png"
tooltip="Media library"
/>

<button
id="btnClose"
action="CLOSE" param=""
x="340" y="17"
image="xp/btn_capt_close_N.png"
hoverimage="xp/btn_capt_close_H.png"
downImage="xp/btn_capt_minimize_D.png"
tooltip="Close"
/>

<button
id="ButtonID2"
action="MINIMIZE" param=""
x="340" y="32"
image="xp/btn_capt_minimize_N.png"
hoverimage="xp/btn_capt_minimize_H.png"
downImage="xp/btn_capt_minimize_D.png"
tooltip="Minimize"
/>

</groupdef>


<groupdef id="grComponents" name="Components">
<vis id="Visualization"
x="30" y="30"
w="76" h="40"
relatx="0"
alpha="255"
gammagroup="gamma"
ColorBand1="255,255,255"
ColorBand2="255,255,255"
ColorBand3="255,255,255"
ColorBand4="255,255,255"
ColorBand5="255,255,255"
ColorBand6="255,255,255"
ColorBand7="255,255,255"
ColorBand8="255,255,255"
ColorBand9="255,255,255"
ColorBand10="255,255,255"
ColorBand11="255,255,255"
ColorBand12="255,255,255"
ColorBand13="255,255,255"
ColorBand14="255,255,255"
ColorBand15="255,255,255"
ColorBand16="255,255,255"

colorosc1="255,255,255"
colorosc2="255,255,255"
colorosc3="255,255,255"
colorosc4="255,255,255"
colorosc5="255,255,255"
colorbandpeak="255,255,255"
/>

<Text
id="SongInfo" ticker="1"
display="songname" showlen="1"
x="118" y="26"
w="210" h="17"
fontsize="16" font="" color="255,255,255"
shadowcolor="128,128,128" shadowx="1" shadowy="1"
/>

<text
id="Timer"
display="time"
x="118" y="47"
w="80" h="25"
font=""
fontsize="18"
color="255,255,255"
align="left"
antialias="1" bold="1"
shadowcolor="128,128,128" shadowx="1" shadowy="1"
timeroffstyle="1"
/>

<slider
id="Slider"
action="SEEK"
x="18" y="85"
w="317" h="20"
orientation="horizontal"
thumb="vista/vista_thumb_N.png"
hoverThumb="vista/vista_thumb_H.png"
downThumb="vista/vista_thumb_D.png"
/>

<slider
id="Slider"
action="VOLUME"
x="208" y="63"
w="115" h="12"
orientation="horizontal"
thumb="xp/xp_thumb_N.png"
hoverThumb="xp/xp_thumb_H.png"
downThumb="xp/xp_thumb_H.png"
/>

</groupdef>

<container id="main" name="Main Window" default_x="0" default_y="0" default_visible="1" w="362" h="162">
<layout id="normal" background="common/Background_player.png" w="400" h="300" desktopalpha="1" >

<group id="Backgrounds" w="362"/>
<group id="PlayButtons" w="360" />
<group id="grTechButtons" w="360" />
<group id="grComponents" w="360" />
</layout>

</container>

== ClassicPro Skins ==
ClassicPro skins is a blend of a Classic Winamp skin and a Modern Winamp skin. You don’t need to do any coding to create your skin because all the coding will be done by the ClassicPro plugin. The layout is similar to the Classic Winamp layout but also resizable using a Single-User-Interface ([[SUI]]) to display components.

[http://cpro.skinconsortium.com/ ClassicPro Official Website]

* '''[[Creating a ClassicPro Skin]]'''

==Developer Resources==
*[[Articles#Classic_Skins|Classic Skin Articles]]
*[[Articles#Modern_Skins|Modern Skin Articles]]
*[[Developers_FAQ#Skin_Developer_FAQ|Skin FAQ]]

==Community Links==
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=5 Classic Skins]
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=123 Modern Skins]
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=18 Skinning Tips and Tricks]
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=12 Arts and Design]
*Forums: [http://forums.winamp.com/forumdisplay.php?s=&forumid=119 Skin Removal Reporting]
*Upload: [http://www.winamp.com/user/submit Submit Your Skin]
**[http://www.winamp.com/user/submit-skin-classic Submit Classic Skin]
**[http://www.winamp.com/user/submit-skin-modern Submit Modern Skin]
*Browse: [http://www.winamp.com/skins Download Skins]
[[de:Hauptseite]]

2009-09-29T19:41:32Z

Blo: /* How can I detect that my page Is being loaded inside Winamp? */

This wiki page has been created to help Web developers and QA engineers optimize their web pages to be rendered within the Winamp client application.

==Where are web pages loaded within Winamp?==

Winamp has 2 primary areas that allow external web sites to be loaded within the client experience -- '''Online Services''' and the '''Bento Skin Browser'''

'''1) Online Services'''

Online Services is a feature within the Winamp Media library that allows 3rd parties to submit their web site to appear as an integrated service within the client. An Online Service is distinct in that the web pages displayed are able to interact with the Winamp Client by leveraging the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]]. Check out the [[Online_Service_Developer|Online Services Developer]] section of this wiki for more information.

[[Image:Online Services Screenshot.png]]

'''2) Bento Skin Browser'''

Winamp's default skin, named "Bento", has a built in web browser that allows users to freely surf the web, create bookmarks, etc. The Bento browser DOES NOT have access to the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]] and acts very much like a stand alone IE browser session.

[[Image:Bento Browser Screenshot.png]]

==What browser engine is embedded within Winamp?==

The Winamp Browser is powered by leveraging the version of Internet Explorer that is resident on the users local machine (IE only). As such, the browser support matrix for the Winamp client is shown in the image below.

[[Image:Winamp Browser Support Matrix.png]]

==How can I detect that my page Is being loaded inside Winamp?==

'''1) Online Services''': The easiest way to determine if the web page is being loaded within Online Services is by checking for Winamp specific strings in the user agent (see below).

Example: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.04506.648) '''omBrowser'''/1.3 ('''Winamp''' 5.57 build 2596 Beta, JSAPI2)

'''2) Bento Browser''': As stated earlier, the Bento Browser acts very much like a stand alone IE browser session and does not convey any Winamp specific hooks (e.g, no Winamp strings in user agent, no access to Winamp API's).

==What unique conditions exist as compared to a stand alone browser?==

NOTE: This section relates only to Online Services

===''Screen Size'':===
The biggest difference is the available screen real estate. The browser window that loads within Winamp is significantly smaller than a fullscreen stand alone browser window. To avoid horizontal scroll bars from appearing by default, the page grid size that designers and web page creators should target for is 660p wide (see image below).

Once a web page detects that its being loaded within Winamp, its recommended that the page modifies its CSS to accommodate the smaller dimensions (or redirect to a alternate web page that is specifically optimized to render in Winamp).

[[Image:Winamp Client Browser Default Page Grid.png]]

===''Access to Online Services API's'':===
Your web page is now inside of the Winamp media player, make the experience contextually relevant to Winamp's media centric users by leveraging the [[Complete_JavaScript_API_technology_framework#Overview |Online Servcies API's]].

For example, you might want to use the Skins API to adjust the colors of your service to blend with active color palatte of the users client. If you have on-demand media, you can use the Transport API to have Winamp natively control the playback of streaming audio/video.

The screenshot below is highlighting an example of a website using the Transport API to fetch metadata for the users currently playing asset and automatically programming a relevant experience based on that metadata.

[[Image:Example Use of Online Serivces API.png]]

==How can I unit test how my web page looks and performs within Winamp?==

'''1) Online Services'''

Winamp provides a [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe web developer plugin] to help you unit test your web page inside of the Winamp client. You can download it [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe here].

Basically this plugin works very similarly to the Online Services node in the Media library, but allows you to create "test services" with parameters you specify. The plugin also makes available a test page for our [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]].

To use it, you'd just install the latest publically available Winamp Client, version 5.56+ (http://www.winamp.com/player/ if you don't have it already), then run the installer for the web developer plugin (wa_webdev.exe). Note: Winamp.exe should be closed when you install the web developer plugin.

Once you've installed it, launch Winamp and you'll see a '''"WebDev Platform"''' item in your Media Library on the bottom left (see example image below).

[[Image:Wa webdev.png]]

The area to the right has the embedded browsing experience, where the online service would be loaded, When you click on the '''WebDev Platform''', you'll see a web page that has links to both the "JSAPI2 Test Page" which shows simple examples of available Winamp Javascript API calls, and a "Create Your Own Service" link, which allows you to enter a URL and title, and create a sub-node under the WebDev Platform Item (see image below).

Here is where you should enter the url of the web page you'd like to unit test (you can load a local file path or hosted url). Don't worry about the service ID or Icon fields. After you hit save, a sub-node under the WebDev Platform item will be created and it will behave exactly as your online service would.

[[Image:Create Test Service2.png]]

'''2) Bento Browser'''

Unit testing your web page inside of the Bento browser is very easy. Just run a recent version of Winamp and click on the Bento browser and enter the url of the web page you'd like to test (see image below). It's important to note that the Bento browser inside of the Winamp client is not where an online service would load, and does not give a webpage access to the JSAPI functions.

[[Image:Browser test.png]]

Winamp Browser Support

2009-09-29T19:41:11Z

Blo: /* How can I detect that my page Is being loaded inside Winamp? */

This wiki page has been created to help Web developers and QA engineers optimize their web pages to be rendered within the Winamp client application.

==Where are web pages loaded within Winamp?==

Winamp has 2 primary areas that allow external web sites to be loaded within the client experience -- '''Online Services''' and the '''Bento Skin Browser'''

'''1) Online Services'''

Online Services is a feature within the Winamp Media library that allows 3rd parties to submit their web site to appear as an integrated service within the client. An Online Service is distinct in that the web pages displayed are able to interact with the Winamp Client by leveraging the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]]. Check out the [[Online_Service_Developer|Online Services Developer]] section of this wiki for more information.

[[Image:Online Services Screenshot.png]]

'''2) Bento Skin Browser'''

Winamp's default skin, named "Bento", has a built in web browser that allows users to freely surf the web, create bookmarks, etc. The Bento browser DOES NOT have access to the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]] and acts very much like a stand alone IE browser session.

[[Image:Bento Browser Screenshot.png]]

==What browser engine is embedded within Winamp?==

The Winamp Browser is powered by leveraging the version of Internet Explorer that is resident on the users local machine (IE only). As such, the browser support matrix for the Winamp client is shown in the image below.

[[Image:Winamp Browser Support Matrix.png]]

==How can I detect that my page Is being loaded inside Winamp?==

'''1) Online Services''': The easiest way to determine if the web page is being loaded within the Winamp Online Services area is by checking for Winamp specific strings in the user agent (see below).

Example: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.04506.648) '''omBrowser'''/1.3 ('''Winamp''' 5.57 build 2596 Beta, JSAPI2)

'''2) Bento Browser''': As stated earlier, the Bento Browser acts very much like a stand alone IE browser session and does not convey any Winamp specific hooks (e.g, no Winamp strings in user agent, no access to Winamp API's).

==What unique conditions exist as compared to a stand alone browser?==

NOTE: This section relates only to Online Services

===''Screen Size'':===
The biggest difference is the available screen real estate. The browser window that loads within Winamp is significantly smaller than a fullscreen stand alone browser window. To avoid horizontal scroll bars from appearing by default, the page grid size that designers and web page creators should target for is 660p wide (see image below).

Once a web page detects that its being loaded within Winamp, its recommended that the page modifies its CSS to accommodate the smaller dimensions (or redirect to a alternate web page that is specifically optimized to render in Winamp).

[[Image:Winamp Client Browser Default Page Grid.png]]

===''Access to Online Services API's'':===
Your web page is now inside of the Winamp media player, make the experience contextually relevant to Winamp's media centric users by leveraging the [[Complete_JavaScript_API_technology_framework#Overview |Online Servcies API's]].

For example, you might want to use the Skins API to adjust the colors of your service to blend with active color palatte of the users client. If you have on-demand media, you can use the Transport API to have Winamp natively control the playback of streaming audio/video.

The screenshot below is highlighting an example of a website using the Transport API to fetch metadata for the users currently playing asset and automatically programming a relevant experience based on that metadata.

[[Image:Example Use of Online Serivces API.png]]

==How can I unit test how my web page looks and performs within Winamp?==

'''1) Online Services'''

Winamp provides a [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe web developer plugin] to help you unit test your web page inside of the Winamp client. You can download it [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe here].

Basically this plugin works very similarly to the Online Services node in the Media library, but allows you to create "test services" with parameters you specify. The plugin also makes available a test page for our [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]].

To use it, you'd just install the latest publically available Winamp Client, version 5.56+ (http://www.winamp.com/player/ if you don't have it already), then run the installer for the web developer plugin (wa_webdev.exe). Note: Winamp.exe should be closed when you install the web developer plugin.

Once you've installed it, launch Winamp and you'll see a '''"WebDev Platform"''' item in your Media Library on the bottom left (see example image below).

[[Image:Wa webdev.png]]

The area to the right has the embedded browsing experience, where the online service would be loaded, When you click on the '''WebDev Platform''', you'll see a web page that has links to both the "JSAPI2 Test Page" which shows simple examples of available Winamp Javascript API calls, and a "Create Your Own Service" link, which allows you to enter a URL and title, and create a sub-node under the WebDev Platform Item (see image below).

Here is where you should enter the url of the web page you'd like to unit test (you can load a local file path or hosted url). Don't worry about the service ID or Icon fields. After you hit save, a sub-node under the WebDev Platform item will be created and it will behave exactly as your online service would.

[[Image:Create Test Service2.png]]

'''2) Bento Browser'''

Unit testing your web page inside of the Bento browser is very easy. Just run a recent version of Winamp and click on the Bento browser and enter the url of the web page you'd like to test (see image below). It's important to note that the Bento browser inside of the Winamp client is not where an online service would load, and does not give a webpage access to the JSAPI functions.

[[Image:Browser test.png]]

Online Service Developer

2009-09-29T19:38:33Z

Blo: /* Style Guide */

Blo: /* How can I unit test how my web page looks and performs within Winamp? */

This wiki page has been created to help Web developers and QA engineers optimize their web pages to be rendered within the Winamp client application.

==Where are web pages loaded within Winamp?==

Winamp has 2 primary areas that allow external web sites to be loaded within the client experience -- '''Online Services''' and the '''Bento Skin Browser'''

'''1) Online Services'''

Online Services is a feature within the Winamp Media library that allows 3rd parties to submit their web site to appear as an integrated service within the client. An Online Service is distinct in that the web pages displayed are able to interact with the Winamp Client by leveraging the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]]. Check out the [[Online_Service_Developer|Online Services Developer]] section of this wiki for more information.

[[Image:Online Services Screenshot.png]]

'''2) Bento Skin Browser'''

Winamp's default skin, named "Bento", has a built in web browser that allows users to freely surf the web, create bookmarks, etc. The Bento browser DOES NOT have access to the [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]] and acts very much like a stand alone IE browser session.

[[Image:Bento Browser Screenshot.png]]

==What browser engine is embedded within Winamp?==

The Winamp Browser is powered by leveraging the version of Internet Explorer that is resident on the users local machine (IE only). As such, the browser support matrix for the Winamp client is shown in the image below.

[[Image:Winamp Browser Support Matrix.png]]

==How can I detect that my page Is being loaded inside Winamp?==

'''1) Online Services''': The easiest way to determine if the web page is being loaded within the Winamp online services is by checking for Winamp specific strings in the user agent (see below).

Example: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.04506.648) '''omBrowser'''/1.3 ('''Winamp''' 5.57 build 2596 Beta, JSAPI2)

'''2) Bento Browser''': As stated earlier, the Bento Browser acts very much like a stand alone IE browser session and does not have convey any Winamp specific hooks (e.g, no Winamp strings in user agent, no access to Winamp API's).

The remainder of this documentation page will be focused on web pages loaded within Online Services

==What unique conditions exist as compared to a stand alone browser?==

===''Screen Size'':===
The biggest difference is the available screen real estate. The browser window that loads within Winamp is significantly smaller than a fullscreen stand alone browser window. To avoid horizontal scroll bars from appearing by default, the page grid size that designers and web page creators should target for is 660p wide (see image below).

Once a web page detects that its being loaded within Winamp, its recommended that the page modifies its CSS to accommodate the smaller dimensions (or redirect to a alternate web page that is specifically optimized to render in Winamp).

[[Image:Winamp Client Browser Default Page Grid.png]]

===''Default omBrowser Settings'':===
By default, the following omBrowser settings are unchecked:

*Disable context menu filtering
*Show a notification for every script error
*Enable script debugging

To turn on any of these features you'll need to download the web_dev plug-in.

===''Access to Online Services API's'':===
Your web page is now inside of the Winamp media player, make the experience contextually relevant to Winamp's media centric users by leveraging the [[Complete_JavaScript_API_technology_framework#Overview |Online Servcies API's]].

For example, you might want to use the Skins API to adjust the colors of your service to blend with active color palatte of the users client. If you have on-demand media, you can use the Transport API to have Winamp natively control the playback of streaming audio/video.

The screenshot below is highlighting an example of a website using the Transport API to fetch metadata for the users currently playing asset and automatically programming a relevant experience based on that metadata.

[[Image:Example Use of Online Serivces API.png]]

==How can I unit test how my web page looks and performs within Winamp?==

'''1) Online Services'''

Winamp provides a [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe web developer plugin] to help you unit test your web page inside of the Winamp client. You can download it [http://download.nullsoft.com/winamp/plugin-dev/wa_webdev.exe here].

Basically this plugin works very similarly to the Online Services node in Media library, but allows you to create "test services" with parameters you specify. The plugin also makes available a test page for our [[Online_Service_Developer#JavaScript_APIs|Online Services APIs]].

To use it, you'd just install the latest publically available Winamp Client, version 5.56+ (http://www.winamp.com/player/ if you don't have it already), then run the installer for the web developer plugin (wa_webdev.exe). Note: Winamp.exe should be closed when you install the web developer plugin.

Once you've installed it, launch Winamp and you'll see a '''"WebDev Platform"''' item in your Media Library on the bottom left (see example image below).

[[Image:Wa webdev.png]]

The area to the right has the embedded browsing experience, where the online service would be loaded, When you click on the '''WebDev Platform''', you'll see a web page that has links to both the "JSAPI2 Test Page" which shows simple examples of available Winamp Javascript API calls, and a "Create Your Own Service" link, which allows you to enter a URL and title, and create a sub-node under the WebDev Platform Item (see image below).

[[Image:Create Test Service2.png]]

Here is where you should enter the url of the web page you'd like to unit test (you can load a local file path or hosted url). After you hit save, a sub-node under the WebDev Platform item will be created and will behave as your online service would.