Eleco bietet die hier beschrieben zentralen Hilfsfunktionen an, damit Sie auf Ihrer Webseite möglichst einfach den o2c-Player einsetzen können und zugleich von künftigen Weiterentwicklungen (z.B. Unterstützung anderer Betriebssysteme und Browsertypen) profitieren können, ohne Ihre Webseite anzupassen.
Voraussetzung für den Einsatz dieser Bibliothek ist ein Verweis auf die Script Datei auf Ihrer Webseite (vor der ersten Verwendung einer hier beschriebenen Funktion). Dieser Verweis sieht so aus:
<script type="text/javascript" src="http://www.o2c.de/utilities/o2c-utils.js"></script>
Funktionsbeschreibung
o2cIsInternetExplorer
Beispiel: if (o2cIsInternetExplorer()) ...
Liefert true, wenn der Browser ein Internet-Explorer ist (bzw. die ActiveX Variante des o2c-Players benutzt.)
o2cIsUsableOnThisBrowser
Beispiel: if (!o2cIsUsableOnThisBrowser()) alert("Sorry");
Liefert true, wenn der Browser (gegebenfalls nach entsprechender Plugin/ActiveX Installtion) o2c-Objekte anzeigen können wird. Liefert false, wenn für diesen Browser kein o2c-Plugin existiert.
o2cInternalHaveUniversalPlugin
Beispiel: if (o2cInternalHaveUniversalPlugin()) alert("Weiterleitung zur Update-Seite...");
Das "universal" Setup ist die manuell installierte Version des o2c-Players, durch download einer O2CSetup.EXE Datei und ausführen des Programmes werden sowohl das Plugin als auch das ActiveX Control installiert. Diese sind dann automatisch für alle unterstützten Browser verfügbar.
Im Gegensatz dazu werden bei Browser-spezifischen Installationen kleinere Installationspakete (in Browserabhängigen Formaten) runtergeladen. Diese Plugins/Controls sind dann nur für den aktuell verwendeten Browser verfügbar. Dafür ist der Installationsvorgang im wesentlichen vollautomatisch.
o2cHavePluginVersion
Beispiel: if (o2cHavePluginVersion('2.0.0.53')) ....
Liefert true, wenn die angegebene Plugin-Version bereits installiert ist. Falls nicht, wird hierbei kein automatisches Update ausgelöst. Diese Funktion funktioniert nicht für die ActiveX Variante!
o2cIinstallPlugin
Beispiel: o2cIinstallPlugin('2.0.0.53')
Versucht das Plugin zu installieren, falls nicht mindestens die angegebene Version bereits verfügbar ist. Falls eine ältere Version gefunden wird, wird automatisch das enstprechende Update-Verfahren gewählt (Browser-spezifisch oder Universal-Setup).
o2cInsertPlayerActiveX
Beispiel: o2cInsertPlayerActiveX(id, pluginObj, '2,0,0,53', width, height, params)
Generiert dynamisch einen object-Eintrag für die ActiveX Version. Dies ist nötig, damit der Internet Explorer nicht nach der Aktivierung des Controls fragt. Ein Beispiel für die Anwendung finden Sie im Beispiel unten. Die Funktionsargumente sind:
id = Die ID des erzeugten ActiveX Object Elements.
pluginObj = Die ID des alternativen Plugin Elements, oder null. Wenn ein (jetzt nicht mehr benötigtes) Plugin Element angegeben wird, wird dieses unsichtbar gemacht, damit nur die ActiveX Version sichtbar ist.
version = Die minimal benötigte o2c Player Version. Hier ist die gleiche (Punkt-separierte) schreibweise erlaubt, die für die oben genannten Versionstestroutinen und alle Plugin-Funktionen verwendet werden, aber auch die komma-separierte Schreibweise wie sie üblicherweise in ActiveX CODEBASE Angaben verwendet wird.
width = Breite (in Pixel oder Prozent), als String.
height = Höhe (in Pixel oder Prozent), als String.
param = Ein String mit allen param-Angaben zum Object-Element.
o2cRegisterEvent(id, Event, func);
Beispiel: o2cRegisterEvent('thePlayer', 'Click', 'onClick');
Meldet einen Event-Handler an. Diese Funktion muss für alle gewünschten Events aufgerufen werden, bevor das eigentliche o2c-Objekt eingefügt wird (o2cInsertObject). Die Parameter sind:
id = Die HTML-id des o2c-Objektes (muss mit dem ersten Argument des o2cInsertObject Aufrufes übereinstimmen).
Event = Der Name des o2c Events (Click, SubObjectPicked, AnimationDone, AnimationStarted, ObjectLoaded, ThumbnailDone, TextureChanged, MaterialChanged, ObjectMove, ObjectMoving, MouseReleased, ClickWithKeys, MouseDown).
func = Die aufzurufende Event-Handler Funktion. Die Argumente müssen zum Event passen.
o2cEnableAllEvents()
Muss einmal pro Seite aufgerufen werden, um alle Eventhandler aller eingebundenen o2c-Objekte zu aktivieren. Dies darf erst nach dem Laden des Plugins (bzw. ActiveX Controlls) geschehen. Typischerweise geschieht dieser Aufruf im window.onload Event des Browsers.
Anwendungsbeispiel - Einfache Einbindung eines einzelnen o2c-Objektes
<!-- the plugin version is created statically
<script type="text/javascript"
src="http://www.o2c.de/utilities/o2c-utils.js"></script><!-- the plugin version is created statically -->
<!-- frühere statische Einbindung des Players-->
<object type="application/x-o2c-object" id="o2cPlugin"
width="952" height="688">
<param name="AnimPlaying" value="true" />
<param name="Phi" value="203.308670" />
<param name="Psi" value="32.111439" />
<param name="ObjectURL" value="engine.o2c" />
</object>
<script type="text/javascript">
// Neue Einbindung des Player
// Prüfung, ob der Player auf dem PC verfügbar ist
// trigger the installation if we use the
// plugin but it is not yet available
o2cIinstallPlugin('2.0.0.53');
// Einbindung des Players mit Prüfung der Verfügbarkeit
// same again, for the ActiveX controll, inserted
// dynamically to avoid prompting the user
o2cInsertPlayerActiveX('o2cCtrl',o2cPlugin,'2.0.0.53',952,688,
'<param name="AnimPlaying" value="true" />'+
'<param name="Phi" value="203.308670" />'+
'<param name="Psi" value="32.111439" />'+
'<param name="ObjectURL" value="engine.o2c" />');
</script> <!-- frühere statische Einbindung des Players-->
