Deutsch Deutsch

Zanmantou Javascript API Reference

WARNUNG: Sie haben die Ausführung von Javascript in ihrem Browser deaktiviert. A3non.org benötigt zur korrekten Funktion jedoch Javascript - Bitte aktivieren Sie es um den vollen Funktionsumfang der Website nutzen zu können. Was ist Javascript.

Methoden

Achtung: Die Beispiele sind für das Mootools Framework
  • Einige Methoden sind mit dem Vermerk "LOWLEVEL" gekennzeichnet - hierbei handelt es sich um Methoden, die in die unterste Steuerungsebene des Players eingreifen. Bei falscher Verwendung ist es möglich, dass ein Fehlverhalten des Players auftritt.
  • Die Funktion console.log wird vom Firebug-Plugin für Firefox zur Verfügung gestellt. Sollten Sie einen anderen Browser ohne das Plugin verwenden, so ersetzten Sie die Ausgabe zum Beispiel durch alert().

start

Startet den Player - äquivalent zum Start-Button

Syntax

start();

Example

$('mybutton').addEvent('click', function(){
	player1.start();
});

jumpAndStart

Springt zur angegebenen Position des Medialist (beginnend mit 0) und startet das jeweilige Video/Track.

Syntax

jumpAndStart(index)

Arguments

  1. index INTEGER [0...n-1] - Position des Items, beginnend mit 0

Returns

  • (null)

Example

$('mybutton').addEvent('click', function(){
	player1.jumpAndStart(3);
});

seek

Setzt die Position des aktuellen Tracks/Videos.

Syntax

seek(position);

Arguments

  1. position INTEGER - neue Position in Sekunden

Example

$('mybutton').addEvent('click', function(){
	player1.seek(16);
});

play

LOWLEVEL: Gibt eine Resource direkt wieder und übergeht dabei die Medialist. Nach dem Ende des Tracks/Videos wird die Medialist normal fortgesetzt.

Syntax

play(url, type, position);

Arguments

  1. url STRING - die URL des wiederzugebenden Tracks/Videos, der mediapath wird jeweils berücksichtig !
  2. type ENUM[video, audio] -  der Medientyp
  3. position INTEGER - gibt die Stelle in Sekunden an aber der mit der Wiedergabe begonnen werden soll

Example

$('mybutton').addEvent('click', function(){
	player1.play('http://www.a3non.org/media/demo.f4v', 'video', 0);
});

stop

Stoppt die Wiedergabe - äquivalent zum Stop-Button

Syntax

stop();

Example

$('mybutton').addEvent('click', function(){
	player1.stop();
});

pause

Pausiert den aktuellen Track/Video - äquivalent zum Pause-Button

Syntax

pause();

Example

$('mybutton').addEvent('click', function(){
	player1.pause();
});

next

Springt zum nächsten Track - äquivalent zum Next-Button

Syntax

next();

Example

$('mybutton').addEvent('click', function(){
	player1.next();
});

prev

Springt zum vorherigen Track - äquivalent zum Prev-Button

Syntax

prev();

Example

$('mybutton').addEvent('click', function(){
	player1.prev();
});

shuffle

Aktiviert/deaktiviert die Zufallswiedergabe

Syntax

shuffle(enable)

Arguments

  1. enable BOOLEAN

Example

$('mybutton').addEvent('click', function(){
	player1.shuffle(false);
});

repeat

Aktiviert/deaktiviert die Einzel-Wiederholung des Tracks

Syntax

repeat(enable)

Arguments

  1. enable BOOLEAN

Example

$('mybutton').addEvent('click', function(){
	player1.repeat(false);
});

repeatall

Aktiviert/deaktiviert die Wiederholung der Medialist

Syntax

repeatall(enable)

Arguments

  1. enable BOOLEAN

Example

$('mybutton').addEvent('click', function(){
	player1.repeatall(true);
});

mute

Setzt den Wert der Lautstärke auf 0 - äquivalent zum Mute-Button

Syntax

mute();

Example

$('mybutton').addEvent('click', function(){
	player1.mute();
});

unmute

Setzt den Wert der Lautstärke auf den vorheringen - äquivalent zum Unmute-Button

Syntax

unmute();

Example

$('mybutton').addEvent('click', function(){
	player1.unmute();
});

setVolume

Setzt die Lautstärke

Syntax

setVolume(value)

Arguments

  1. value DOUBLE [0.0 .. 1.0] Lautstärke normiert auf 1

Example

$('mybutton').addEvent('click', function(){
	player1.setVolume(0.75);
});

getVolume

Gibt den aktuellen Wert der Lautstärke zurück

Syntax

getVolume();

Returns

  • value DOUBLE - Lautstärke normiert auf 1

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getVolume());
});

setPan

Setzt die Balance zwischen linkem und rechtem Kanal

Syntax

setPan(value)

Arguments

  1. value DOUBLE [-1.0 ... 0.0 ... 1.0] - -1.0 entspricht ganz links, +1.0 ganz rechts, 0.0 mittig

Example

$('mybutton').addEvent('click', function(){
	player1.setPan(-0.5);
});

getPan

Holt den aktuellen Balance Wert

Syntax

getPan()

Returns

  • value DOUBLE - aktuellen Balance Wert

Example

$('mybutton').addEvent('click', function(){
	player1.getPan();
});

setLRTransform

LOWLEVEL - setzt das Mischungsverhältnis zwischen linkem und rechtem Audiokanal auf die Ausgabe, siehe AS3 API

Syntax

setLRTransform(ll, lr, rr, rl)

Arguments

  1. ll DOUBLE - left to left
  2. lr DOUBLE - left to right
  3. rr DOUBLE - right to right
  4. rl DOUBLE - right ro left

Example

$('mybutton').addEvent('click', function(){
	// linken und rechten audiokanal vertauschen
	player1.setLRTransform(0.0, 1, 0.0, 1);
});

getWave

LOWLEVEL: erstellt einen Snapshot des aktuellen Audiosignals -  siehe AS3 API FFT=false

Syntax

getWave()

Returns

  • value ARRAY

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getWave());
});

getSpectrum

LOWLEVEL: Berechnet das aktuelle Spektrum des Audiosignals -  siehe AS3 API - FFT=true

Syntax

getSpectrum()

Returns

  • value ARRAY

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getSpectrum());
});

getMediaList

Gibt die aktuelle verwendete MediaList des players zurück, inklusive aller Parameter

Syntax

getMediaList()

Returns

  • value ARRAY : javascript Array im MediaList Format

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaList());
});

setMediaList

LOWLEVEL: Setzt die interne Medialist des Players neu

Syntax

setMediaList(list)

Arguments

  1. list ARRAY : javascript Array im MediaList Format

Example

$('mybutton').addEvent('click', function(){
	// zanmantou javascript medialist format
	var medialist = [
		{
		source: 'mytrack.mp3',
		streaming: false,
		type: 'audio',
		params: {
			title: 'Jamtoo - Sunshine',
			author: 'Jamtoo',
			album: "unknown
		},

		{
		source: 'demovideo.f4v',
		streaming: false,
		type: 'video',
		params: {
			title: 'Zanmantou Demo Video'
		}
	];

	player1.setMediaList();
});

setMediaIndex

LOWLEVEL: setzt die aktuelle Position des internen Zeigers des aktuellen MediaItems

Syntax

setMediaIndex(index)

Arguments

  1. index INTEGER [0 ... n-1] - Index der Medialist

Example

$('mybutton').addEvent('click', function(){
	// zeiger auf den 5ten (n-1) track setzen
	player1.setMediaIndex(4);
});

getMediaIndex

LOWLEVEL: Gibt den aktuellen Index der Medialist zurück

Syntax

getMediaIndex()

Returns

  • value INTEGER - aktuellen Index der Medialist

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaIndex());
});

addMediaItem

LOWLEVEL: fügt der internen MediaList ein neues Item im Zanmantou JS MediaFormat hinzu

Syntax

addMediaItem(index, item)

Arguments

  1. index INTEGER - Position des Items in der Medialist
  2. item OBJECT - hinzuzufügendes Item

Example

$('mybutton').addEvent('click', function(){
	var item = {
		source: 'demovideo.f4v',
		streaming: false,
		type: 'video',
		params: {
			title: 'Zanmantou Demo Video'
	};
	// neues item an die position3 (Track 4) hinzufügen
	player1.addMediaItem(3, item);
});

removeMediaItem

LOWLEVEL: entfernt ein MediaItem aus der internen MediaList

Syntax

removeMediaItem(index)

Arguments

  1. index INTEGER - Position des zu entfernenden Tracks

Example

$('mybutton').addEvent('click', function(){
	// item 5 entfernen
	player1.removeMediaItem(4);
});

isPlaying

Gibt zurück, ob zur Zeit die Wiedergabe aktiv ist

Syntax

isPlaying()

Returns

  • value INTEGER

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.isPlaying());
});

getMediaLength

Gibt die absolute Länge des aktuellen Tracks in Sekunden zurück

Syntax

getMediaLength()

Returns

  • length INTEGER - Länge des aktuellen Tracks in Sekunden

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaLength());
});

getMediaTime

Gibt die aktuelle Position des Spielkopfes in Sekunden zurück

Syntax

getMediaTime()

Returns

  • time INTEGER - aktuelle Position des Spielkopfes in Sekunden

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaTime());
});

getMediaProgress

Gibt den aktuellen Wiedergabefortschritt des Tracks an

Syntax

getMediaProgress()

Returns

  • value DOUBLE [0.0 ... 1.0] - Fortschritt normiert auf 1

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaProgress());
});

getMediaLoadingProgress

Gibt den aktuellen Ladefortschritt des Tracks an.

Syntax

getMediaLoadingProgress()

Returns

  • value DOUBLE [0.0 ... 1.0] - Ladefortschritt normiert auf 1

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getMediaLoadingProgress());
});

getFPS

Gibt die aktuellen FrameProSekunde des aktiven Videos zurück

Syntax

getFPS()

Returns

  • value INTEGER

Example

$('mybutton').addEvent('click', function(){
	console.log(player1.getFPS());
});

Events

xmlready

Wird getriggert sobald die config.xml und medialist.xml geladen wurden. Ab diesem Zeitpunkt kann die Medialist ausgelesen oder manipuliert werden.

Example

player1.addEvent('xmlready', function(){
	console.log("Event: ", "xmlready");
});

guiready

Wird getriggert sobald alle Images geladen wurden und das UserInterface bereit ist (Ladeanzeige veschwindet).

Example

player1.addEvent('guiready', function(){
	console.log("Event: ", "guiready");
});

start

Wird getriggert sobald der start-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('start', function(){
	console.log("Event: ", "start");
});

play

Wird getriggert sobald der play-Button gedrückt wurde bzw. durch die Javascript API.

Arguments

  1. index INTEGER - gibt den aktuellen MediaIndex des Items an

Example

player1.addEvent('play', function(index){
	console.log("Event: ", "play", "mediaindex:", index );
});

stop

Wird getriggert sobald der stop-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('stop', function(){
	console.log("Event: ", "stop");
});

pause

Wird getriggert sobald der pause-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('pause', function(){
	console.log("Event: ", "pause");
});

prev

Wird getriggert sobald der prev-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('prev', function(){
	console.log("Event: ", "prev");
});

next

Wird getriggert sobald der next-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('next', function(){
	console.log("Event: ", "next");
});

mute

Wird getriggert sobald der mute-Button gedrückt wurde bzw. durch die Javascript API

Example

player1.addEvent('mute', function(){
	console.log("Event: ", "mute");
});

unmute

Wird getriggert sobald der unmute-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('unmute', function(){
	console.log("Event: ", "unmute");
});

repeatallon

Wird getriggert sobald der repeatallon-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('repeatallon', function(){
	console.log("Event: ", "repeatallon");
});

repeatalloff

Wird getriggert sobald der repeatalloff-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('repeatalloff', function(){
	console.log("Event: ", "repeatalloff");
});

repeaton

Wird getriggert sobald der repeaton-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('repeaton', function(){
	console.log("Event: ", "repeaton");
});

repeatoff

Wird getriggert sobald der repeatoff-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('repeatoff', function(){
	console.log("Event: ", "repeatoff");
});

shuffleon

Wird getriggert sobald der shuffleon-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('shuffleon', function(){
	console.log("Event: ", "shuffleon");
});

shuffleoff

Wird getriggert sobald der shuffleoff-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('shuffleoff', function(){
	console.log("Event: ", "shuffleoff");
});

fullscreenon

Wird getriggert sobald der fullscreenon-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('fullscreenon', function(){
	console.log("Event: ", "fullscreenon");
});

fullscreenoff

Wird getriggert sobald der fullscreenoff-Button gedrückt wurde bzw. durch die Javascript API.

Example

player1.addEvent('fullscreenoff', function(){
	console.log("Event: ", "fullscreenoff");
});

extern

Wird getriggert sobald der extern-Button gedrückt wurde bzw. durch die Javascript API. Dieses Event dient dazu, Buttons mit eignen Fumktionen zu erstellen.

Arguments

  1. type STRING - den in der config.xml typen des extern Buttons (Attribut type="")

Example

player1.addEvent('extern', function(type){
	console.log("Event: ", "extern", "type: ", type);

	// fallunterscheidung anhand des button-types
	if (type=='customevent1'){
		console.log('button customevent1 wurde gedrückt');
	}
});

volumestart

Wird getriggert sobald der Volumeslider bewegt wird wurde bzw. durch die Javascript API.

Example

player1.addEvent('volumestart', function(){
	console.log("Event: ", "volumestart");
});

volumecomplete

Wird getriggert sobald der Volumeslider losgelassen wurde (neuer Wert) bzw. durch die Javascript API.

Arguments

  1. value DOUBLE - aktuellen Wert des Sliders beim loslassen, normiert auf 1

Example

player1.addEvent('volumecomplete', function(value){
	console.log("Event: ", "volumecomplete", value);
});

progressstart

Wird getriggert sobald der Progressslider bewegt wird wurde bzw. durch die Javascript API.

Arguments

  1. args

Example

player1.addEvent('progressstart', function(){
	console.log("Event: ", "progressstart");
});

progresscomplete

Wird getriggert sobald der Progressslider losgelassen wurde (neuer Wert) bzw. durch die Javascript API.

Arguments

  1. value DOUBLE - aktuellen Wert des Sliders beim loslassen, normiert auf 1

Example

player1.addEvent('progresscomplete', function(value){
	console.log("Event: ", "progresscomplete", value);
});

panstart

Wird getriggert sobald der Panslider bewegt wird wurde bzw. durch die Javascript API.

Arguments

  1. args

Example

player1.addEvent('panstart', function(){
	console.log("Event: ", "panstart");
});

pancomplete

Wird getriggert sobald der Panslider losgelassen wurde (neuer Wert) bzw. durch die Javascript API.

Arguments

  1. value DOUBLE - aktuellen Wert des Sliders beim loslassen, normiert auf 1

Example

player1.addEvent('pancomplete', function(value){
	console.log("Event: ", "pancomplete", value);
});

mediacomplete

Wird getriggert sobald das aktuelle Video/Track zuende ist.

Example

player1.addEvent('mediacomplete', function(){
	console.log("Event: ", "mediacomplete");
});

mediaerror

Wird getriggert wenn ein Fehler beim Abspielen oder Laden der externen Video/Audio Datei auftritt

Example

player1.addEvent('mediaerror', function(){
	console.log("Event: ", "mediaerror");
});

A3non Tree Navigation System

show/hideHide

HilfeHilfe

Copyright 2010 A3non.org - Alle Rechte vorbehalten

Alle verwendeten Inhalte, Grafiken, Medien unterliegen dem Urheberrecht. Eine Verwendung dieser für Private und/oder kommerzielle Zwecke ist ohne eine schriftliche Genehmigung durch Andi Dittrich untersagt.

WHITE-SANDBOX 1.3 | Optimiert für eine Auflösung > 1400px. Firefox 3.6, InternetExplorer 8, Opera 10