fk:Blog – Fabians Weblog

fkShoutcast Status Panel

Durch ein Projekt das ich zusammen mit einem bekannten am Planen nud erstellen bin, durchsuchte ich das Plugin Directory von WordPress.org nach einen geeignetem Plugin um mir den Aktuellen Status eines Shoutcast-Servers ausgibt. Schnell merkte ich, das es nicht viele Plugins gibt (Ich find nur 2 Stück im Plugin Directory).

Beide Plugins schaute ich mir an und muss sagend as es nicht das war, das ich gesucht habe. Ich suchte ein Shoutcast Plugin das mir den Aktuellen Status anzeigt, sich Automatisch alle X Sekunden Aktualisiert und Links enthält womit man den Stream direkt in seinen Player öffnen kann.

Daher ist in meinen Editor ein kleines Plugin entstanden das meinen Anforderrung entspricht. Das fkShoutcast Status Panel ist ein kleines WordPress Plugin, das den Aktuellen Shoutcast Stream Status in deinen WordPress Blog einbindet.

Das Plugin

Das fkShoutcast Status Panel zeigt den Aktuellen Status des Angegeben Shoutcast Servers an und Aktualisiert sich dabei, dank Ajax, alle 1800sek. Automatisch um Besuchern immer den Aktuellsten Status oder Titel Anzuzeigen.

Neben drei Player Icons, für Winamp, Windows Media Player und dem RealPlayer, einer readme.txt enthält das Plugin Packer 5 Dateien die für das Ausführen des Plugins zuständig sind.

sc_ajax.js
die JavaScript Datei erzeugt die Automatische Aktualisierung durch Ajax.

sc_status.php (Nicht Editieren)
diese PHP datei enthält die PHP Informationen zum auslesen eines Shoutcast Status. Wichtig für die funktionalität der Ausgabe spielen hierbei die Shoutcast Daten die ihr in der “sc_data.php” einfügen müsst.

shoutcast_panel.php
In dieser Datei finden sich neben den Stylesheet Angaben für die Status Box (siehe “Gestalltung per CSS” auch die PHP Funktion zum einbinden des Plugins in euer Box (siehe Installation).

sc_output.php
Diese Datei dient dem Plugin als Template Basis. Ihr habt hier die möglichkeit das Plugin-Template euren wünschen Anzupassen.
Nutzt dazu folgende Funktionen für die Ausgabe der einzelnen Shoutcast Infos.

• $sc_server_title – gibt den Titel des Aktuellen Shoutcast Status aus. *
• $sc_current_song – gibt den Aktuellen Titel des Shoutcast Status aus. *
• $sc_listeners_cur – Anzahl der momentanigen zuhörer auf dem Shoutcast Stream.
• $sc_listeners_max – Maximale Zuhörer die der Shoutcast Server verfügbar hat.
• $sc_listeners_peak – Höchste Max. Anzahl gleichzeitiger Höhrer seit Server Start.
• $hf_winamplink – Link zur Winamp Playlist (Link wird in sc_data.php eingestellt)
• $hf_wmplink – Link zur Windows Media Player Playlist (Link wird in sc_data.php eingestellt)
• $hf_reallink – Link zur RealPlayer Playlist (Link wird in sc_data.php eingestellt)
• $hf_offmeldung – Offline Meldung, wird ebenfalls in der sc_data.php angegeben.

* Der Text wird von der Streaming Software an dem Shoutcast Server gesendet.

sc_data.php
In dieser Datei werden alle Wichtigen Daten für das Plugin Angeben. In einer späteren Version des Plugins sollen diese Angaben direkt über den WordPress Administrations Bereich eingetragenw erden können.

Wichtig ist das ihr alle Angaben die in der Datei gefordert werden Anpasst. Daher hier ein Überblick inkl. erklärung.

• $plugin_url – Hier musst der Vollständige Pfad zum WordPress Plugin Verzeichniss angegeben werden.
  Beispiel: http://yourdomain.de/wp-content/plugins
• $scast_host – Die URL oder IP zum Shoutcast Server. (ohne Port)
• $scast_name – Name des Shoutcast Servers.
• $scast_port – Hier müsst ihr die Port Nummer eintragen auf der eurer Shoutcast Sendet.
• $scast_pass – Das Shoutcast Passwort muss hier eingetragen werden.
• $hf_server – URL zu eurem Radio.
• $hf_offmeldung – Hier gebt ihr euren Text für die Offline Meldung des Plugins ein.
• $hf_winamplink – Link zur Winamp Playlist.
• $hf_wmplink – Link zur Windows Media Player Playlist
• $hf_reallink – Links zur RealPlayer Playlist

Wenn ihr euren Besuchern nur einen Player anbieten möchtet, Kommentiert die Zeilen im Plugin aus. Ebenfalls müssen die Player Links dann in der sc_output.php” entfernt werden.

Gestalltung per CSS

Um die Statusbox des fkShoutcas Status Panels mit CSS zu gestallten, gibt es folgende CSS Klassen.

#shoutcast_info
#shoutcast_info h3
#shoutcast_info p
#shoutcast_info p strong
#shoutcast_info .player
#shoutcast_info .player img

Um das Aussehen auf eure Wünsche Anzupassen könnt ihr die CSS Formatierung in der “shoutcast_status.php” Editieren (Zeile 20 bis 42) oder ihr CSS Klassen in eurem Externen Stylesheet.

Installation des Plugins

Nach dem Herrunterladen des Plugins müsst ihr folgende Schritte durchführen.

1. Entpackt die Zip Datei auf euren Computer
2. Öffnet die sc_data.php und gebt eure Daten an. Anschließend Speichern.
3. Ladet den Plugin Ordner in eurer Plugin Verzeichniss.
4. Aktiviert das Plugin im Administrations Bereich von WordPress.
5. Öffne die Theme-Template Datei und fügt folgenden Code an gewünschter Stelle hin:
   <?php shoutcast_panel() ?>

History

27.12.2009 Version 0.0.1 – fkShoutcast Status Panel wird veröffentlicht.

Was ist noch geplant?

Für eine spätere Version ist geplant, das die Dateneingabe für den Shoutcast Stream über das WordPress Administrationsbereich getätigt wird um das Editieren der Plugin Datein zu vermeiden.

---