Öffentliche Methoden | Öffentliche, statische Methoden

i2bpro.player.Player Klassenreferenz

Klassendiagramm für i2bpro.player.Player:
Inheritance graph
[Legende]
Zusammengehörigkeiten von i2bpro.player.Player:
Collaboration graph
[Legende]

Aufstellung aller Elemente

Öffentliche Methoden

void play (int id) throws MalformedURLException, IOException, NoPlayerException
void stop ()
void pause ()
TimeInterface getPosition ()
void setPosition (int position)
void setVolume (int vol)
int getVolume ()
void toggleMute ()
boolean isMute ()
synchronized void controllerUpdate (ControllerEvent event)
TimeInterface getDuration ()
int getState ()

Öffentliche, statische Methoden

static Player getInstance ()

Ausführliche Beschreibung

Projektarbeit Informatik IIb - Audioplayer
Klasse: Player

Die Klasse Player beinhaltet alle Methoden die für den Audioplayer notwendig sind, um Audiodateien abzuspielen. Dafür werden Methoden zur Verfügung gestellt, welche eine Verbindung zum Java Media Framework herstellen. Die Klasse wurde nach der Singleton Pattern Methode geschrieben. Somit kann immer nur eine Instanz der Klasse erzeugt werden. Das Grundgerüst für das Singleton Pattern wurde dem Buch "Handbuch der Java Programmierung" von Guido Krüger und Thomas Stark entnommen.

Version:
1.0.0
Datum:
02.01.2010
Autor:
Jürgen Döffinger
Fehler:
Es weren einige mp3-Dateien nicht abgespielt. Der Fehler scheint im Java Media Framework zu liegen.

Definiert in Zeile 57 der Datei Player.java.


Dokumentation der Elementfunktionen

synchronized void i2bpro.player.Player.controllerUpdate ( ControllerEvent  event )

Die Methode controllerUpdate reagiert auf Events vom Controller des Players.

Definiert in Zeile 437 der Datei Player.java.

TimeInterface i2bpro.player.Player.getDuration (  )

Die Methode getDuration gibt die Gesamtspieldauer des Audiotitels zurück.

Rückgabe:
TimeInterface

Die MEthode getSeconds gibt die Gesamtspielzeit in Sekunden zurück.

Rückgabe:
Gesamtabspieldauer in Sekunden

Die Methode getString gibt die Gesamtspieldauer als String in der Form hh:mm:ss zurück.

Rückgabe:
Gesamtabspieldauer des Audiotitels in Form hh:mm:ss

Definiert in Zeile 541 der Datei Player.java.

static Player i2bpro.player.Player.getInstance (  ) [static]

Mit der Methode getInstance wird die nach dem Singleton Pattern Verfahren erzeugte Instanz an die aufrufende Methode zurückgegeben.

Rückgabe:
Einzigste Instanz der Klasse Player.

Definiert in Zeile 105 der Datei Player.java.

TimeInterface i2bpro.player.Player.getPosition (  )

Mit der MEthode getPosition kann die aktuelle Abspielposition erfragt werden.

Rückgabe:
TimerInterface

Die Methode getSeconds gibt die aktuelle Abspielposition in Sekunden zurück

Rückgabe:
Abspielposition in Sekunden

Die Methode getString gibt die aktuelle Abspielposition als String in der Form hh:mm:ss zurück.

Rückgabe:
Abspielpostion in Form hh:mm:ss

Definiert in Zeile 267 der Datei Player.java.

int i2bpro.player.Player.getState (  )

Die Methode getState gibt den Status des Players zurück.

Rückgabe:
0 = Stop 1 = Play 2 = Pause

Definiert in Zeile 616 der Datei Player.java.

int i2bpro.player.Player.getVolume (  )

Die Methode getVolume gibt die aktuell eingestellte Lautstärke zurück.

Rückgabe:
Wert der aktuellen Lautstärke zwischen 0 und 100.
Warnung:
Der im Status Stop zurückgegebene Wert muss nicht dem tatsächlichen Wert entsprechen. Allerdings wird der Player beim starten einer Wiedergabe auf, den im Status Stop, ausgelesenen Lautstärkewert gesetzt.

Definiert in Zeile 394 der Datei Player.java.

boolean i2bpro.player.Player.isMute (  )

Die Methode isMute gibt den Wert des Attributs mute zurück. Somit kann festgestellt werden, ob Mute eingeschalten ist oder nicht.

Rückgabe:
booleascher Ausdruck über den Zustand von Mute

Definiert in Zeile 428 der Datei Player.java.

void i2bpro.player.Player.pause (  )

Die Methode pause unterbricht das Abspielen des Audiotitels. Dabei wird auf die Methode stop zurückgegriffen. Vorher wird allerdings das Attribute position auf die aktuelle Abspielposition gesetzt. Somit kann mithilfe der Methode play bzw. StartPlayer, die Wiedergabe an der entsprechenden Position fortgesetzt werden.

Definiert in Zeile 237 der Datei Player.java.

void i2bpro.player.Player.play ( int  id ) throws MalformedURLException, IOException, NoPlayerException

Mit der Methode play wird das Abspielen eines Audiotitels gestartet. Die Methode prüft dabei den Status des Players und entscheidet daraufhin, ob eine Wiedergabe, welche pausiert, einfach nur fortgesetzt wird oder ob eine Wiedergabe im Status Stop neu gestartet wird. Die Entscheidung liegt auch bei der übergebenen Identifikationsnummer (id). Ist der Player im Status Pause,aber wird nicht die gleiche id, wie zum Zeitpunkt als der Player in den Status Pause ging, übergeben, so wird nicht fortgesetzt, sondern der Player wird in den Status Stop gebracht und der neue Audiotitel gestartet.

Parameter:
Identifikationsnummerdes Audiotitels

Definiert in Zeile 123 der Datei Player.java.

void i2bpro.player.Player.setPosition ( int  position )

Die Methode setPosition setzt den derzeit abgespielten Audiotrack auf die übergebene Position. Dabei wird natürlich der Status des Players berücksichtigt. Ist der Player im Status Stop wird keine Positionierung vorgenommen. Im Status Play wird hingegen die Abspielposition entsprechend geändert und im Status Pause wird die übergebene Position im Attribut position gespeichert.

Parameter:
newAbspielposition in Sekunden

Definiert in Zeile 327 der Datei Player.java.

void i2bpro.player.Player.setVolume ( int  vol )

Mit der Methode setVolume wird die Lautstärke des Players eingestellt. Dazu ist ein Wert zwischen 0 und 100 zu übergeben. Dieser wird dann der logarithmischen Lautstärkekurve angepasst. Diese Anpassung wurde experimantell ermittelt.

Parameter:
volLautstärkewert zwischen 0 und 100.

Definiert in Zeile 350 der Datei Player.java.

void i2bpro.player.Player.stop (  )

Mit der Methode stop kann das Abspielen eines Audiotitels abgebrochen werden. Dabei wird der Player geschlossen und in den Status 0=STOP versetzt.

Definiert in Zeile 218 der Datei Player.java.

void i2bpro.player.Player.toggleMute (  )

Die Methode toogleMute schaltet Mute ein oder aus. Ist das Attribute mute false, so wird die Lautstärke auf 0 gesetzt und das Attribut mute auf true. Ist das Attribute hingegen true, wird die Lautstärke auf den Wert des Attributs volume und das Attribut mute auf false gesetzt.

Definiert in Zeile 406 der Datei Player.java.


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
 Alle Klassen Funktionen