Version | 1.56 BETA |
|---|---|
Datum | 0214.1103.20102011 |
Author | Christopher Wirtz |
Versionshistorie
Version | Author | Datum | Bemerkungen |
|---|---|---|---|
0.1 | 23.05.2005 | Christopher Wirtz | initial |
0.5 | 26.05.2005 | Christopher Wirtz | Changes |
1.0 | 02.06.2005 | Christopher Wirtz | Release |
1.1 | 12.03.2007 | Christopher Wirtz | Flash added |
1.2 | 06.07.2009 | Christopher Wirtz | Review/Changes |
1.3 | 14.07.2009 | Christopher Wirtz | Added Example to set the „duration" manually in ActionScript |
1.4 | 29.06.2010 | Christopher Wirtz | Unload delay |
1.5 | 02.11.2010 | Frank Kammann | Add Example using a NetStreamAdapter, streaming segments and parallel streams |
1.6 | 1514.03.2011 | Frank Kammannadd more | Beschreibung der grundsätzlichen Funktionsweise der API und Informationen zu den Security-Einstellungen bei Flash |
Inhaltsverzeichnis
| Table of Contents |
|---|
...
- Das System-Objekt, dass Informationen enthält wie Bildschirmauflösung, Playername und Playerversion.
Variable
Optional?
Beschreibung
sxNein
Die Bildschirmauflösung (width)
syNein
Die Bildschirmauflösung (height)
plNein
Der Name des Players
plvNein
Die Playerversion
- Die Nutzungsinformationen einer Messung
Variable
Optional?
Beschreibung
plvNein
Die Playerversion
streamNein
Der Name des Streams
dur,durationNein, wenn es kein Livestream ist.
Die Länge des Streams in Sekunden
sxNein
Die Videoauflösung (width) oder den Wert
0syNein
Die Bildschirmauflösung (height) oder den Wert
0uidNein
Die Unique Id des Nutzungsvorganges
vtNein
Die Viewtime in Sekunden. Die Viewtime wird gemessen ab dem Aufruf der Methode
SpringStreams.track(...)pstNein
Die Playstates. Die Liste mit Sichtungsintervallen auf dem Stream.
| Info |
|---|
Die Beschreibung Codierung des HTTP-Request ist nicht Bestandteil dieser Dokumentation. Der Request ist aber so gestaltet, dass bei Debugging-Tätigkeiten die Variablen trotzdem eindeutig identifizierbar sind. |
Einbau über Javascript für beliebige Player (auch proprietäre)
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
var myAdapter = {
"getMeta" : function(id) {
return {
"pl" :"own player",
"pvplv" :"version1"
"sx" : screen.width,
"sy" : screen.height
}
},
"getDuration" : function(id) {
return 0;
},
"getPosition" : function(id) {
return new Date().getTime() / 1000;
}
};
|
...
| eine kurze Beschreibung des Players |
| die Version des Players |
| die Breite des Bildschirms in Pixel |
| die Höhe des Bildschirms in Pixel |
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<html>
<head>
<title>spring sensors</title>
<script src="springstreams.js"></script>
</head>
<body onunload="unload();">
<script type="text/javascript">
var sensors = new SpringStreams("test");
var adapter = {
"getMeta" : function() {
return {
"pl" :"own player",
"pvplv" :"version1"
"sx" : screen.width,
"sy" : screen.height
}
},
"getDuration" : function() {
return 1000;
},
"getPosition" : function() {
return new Date().getTime() / 1000;
}
};
var desc = {
"stream": "videos/teststream"
}
sensors.track("someid", desc, adapter);
// uncomment for debugging
// sensors.debug = function(v) {
// window.status = v;
// }
function unload() {
sensors.unload();
// give time for submission
var start= new Date(); var now = null; do now = new Date();
while(now-start < 100);
}
</script>
</body>
|
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<body onunload="unload()">
...
function unload() {
FlexProject.SPRING_UNLOAD();
}
|
...
Wobei FlexProject die ID des Flash-Objektes ist. Sollte bereits ein unload-Mechanismus in der Flash-Applikation vorhanden sein, so kann dieser die statische Funktion SpringStreams.unload() aufrufen.
Einsatz als Embedded Player und Security Einstellungen
Wenn der Player auf einer anderen Website als Embedded Player eingesetzt werden soll, müssen die Security-Einstellungen beachtet werden.
Folgende Einstellungen sind vorzunehmen (siehe: ExternalInterface#addCallback())
- Legen Sie in der HTML-Seite im object-Tag der SWF-Datei den folgenden Parameter fest:
Code Block borderColor grey bgColor #eeeeee lang actionscript borderStyle solid <param name="allowScriptAccess" value="always" /> - Fügen Sie in der SWF-Datei den folgenden ActionScript-Code ein:
Code Block borderColor grey bgColor #eeeeee lang actionscript borderStyle solid flash.system.Security.allowDomain( sourceDomain )
Beim Fehlen dieser Einstellungen tritt in der API ein Securityfehler auf, weil der Versuch die SPRING_UNLOAD()-Funktion in der Webseite zu registrieren fehlschlägt. Dieser Fehler wird in der API behandelt und ignoriert und ist nicht zwingend erforderlich für das korrekte Funktionieren der Messung.
Des Weiteren ist für das korrekte Funktionieren auch der Eintrag des Attributes onunload="..." im body-Tag notwendig, um das Verlassen der Seite der API zu melden. Beim Fehlen dieser Einstellungen ist es möglich, dass am Ende der Messung das letzte Event nicht mehr an das Messsystem übermittel wird.
Beispiel Integration in Flash
...