The Applet

The Player

CONCEPTS

WebSynth audio now comes with a default player that you may choose to use without having to program your own one.
This player may be used both on the internet and as a standard Java component for applications.
You may customize its appearance through applet parameters or through API calls.

DIRECTORIES

You will need to prepare some directories on your website to let it run correctly.

One directory will contain Java classes (let's say /applets)

One directory will contain compressed audio files (let's say /sounds/streams)

The WSPlayer applet jar file will be placed inside the /applets directory and eventually extracted with full package directory names, as found inside the jar file. What you will have is a /applets/wsplayer.jar and /applets/com/sonicle/wsaudio directory containing the class files:

THE APPLET TAG

To place WSPlayer inside a page you will have to edit the HTML source and place some TAGS like these:

<APPLET ARCHIVE=wsplayer.jar CODEBASE=/applets CODE=com.sonicle.wsaudio.WSPlayer WIDTH=2 HEIGHT=2> <PARAM NAME=xxx VALUE=yyy> ... </APPLET>

The first line will be the same for every page that will contain WSPlayer.
The PARAM lines will change from page to page, depending on the features you want to implement.
Following is the list of PARAM you need or may use.

SHOWMETAL - optional

The applet comes with a configurable look and feel. The default one shows a metal pane over the entire surface of the player.
You may choose to disable the painting of this metal pane through this parameter, forcing the applet to paint with plain colours.
You may want to disable this feature if you need to place it inside your page and make it appear contiguous with the colours of
your page.

SYNTAX: <PARAM NAME=SHOWMETAL VALUE=true/false>

METALSHIFT - optional

This parameter influences the metal appearance of the surface. If you choose to show the metal surface, the cycling of the colours
of the surface may be influenced by a double value. The default double value is 0.888888.
Play with this value to find the desired result.

SYNTAX: <PARAM NAME=METALSHIFT VALUE=double>

COLORUP and COLORDOWN - optional

Components on the player acting as buttons have two states: pressed, unpressed. Other components, such as labels, have just the
unpressed state. You may choose different background colors for this states. When in metal mode, this color influences the metal
tonality too, and this color will be the starting point for the metal shift effect. In plain mode this is just the plain color. You will usually
want the down color to be darker than the up color for the push effect to be real.
Default values are 25,65,75 for up and 5,45,55 for down.
Play with this values to find the desired result.

SYNTAX: <PARAM NAME=COLORUP VALUE=r,g,b>
SYNTAX: <PARAM NAME=COLORDOWN VALUE=r,g,b>

SHOWVOLUME - optional

With this parameter you may choose to hide the volume control component.

SYNTAX: <PARAM NAME=SHOWVOLUME VALUE=true/false>

SHOWTITLE - optional

With this parameter you may choose to hide the title information component.

SYNTAX: <PARAM NAME=SHOWTITLE VALUE=true/false>

SHOWQUALITY - optional

With this parameter you may choose to hide the quality information component.

SYNTAX: <PARAM NAME=SHOWQUALITY VALUE=true/false>

SHOWMUTEBUTTON - optional

With this parameter you may choose to hide the mute control component.

SYNTAX: <PARAM NAME=SHOWMUTEBUTTON VALUE=true/false>

SHOWDOCKBUTTON - optional

With this parameter you may choose to hide the docking control component.

SYNTAX: <PARAM NAME=SHOWDOCKBUTTON VALUE=true/false>

SHOWSESSIONS - optional

With this parameter you may choose to hide the sessions pane component.

SYNTAX: <PARAM NAME=SHOWSESSIONS VALUE=true/false>

SESSIONx - optional

With this parameter you may configure the sessions showing in the sessions pane.
Use x to number sessions starting from 0 and with no holes (SESSION0, SESSION1 ....) on separate PARAM entries.
You may specify an URL for an image (gif, jpeg), a description, the audio file URL and an optional default section id for multi section files (wsa).
With multi section wsa files, section 0 refers to the 14.4 quality, section1 to the 28.8 quality. If the wsa file contains just one quality
the unique section will be selected by default.

SYNTAX: <PARAM NAME=SESSIONx
VALUE="imageurl | description | audiofileurl [ | section] >

EXAMPLES

The following example shows how to show a general player:

<HTML> <HEAD>

</HEAD>

<BODY>

</BODY> </HTML>