Player events

From A-SMIL.org
Revision as of 14:33, 1 November 2011 by SMIL T.A. (Talk | contribs)

Jump to: navigation, search

A-SMIL players can report on various events happening to a player, such as :

Download failure (event FETCH_FAILED):
occurs when a file cannot be downloaded due to network failure or URL not found.
File not found error (event MEDIA_NOT_AVAILABLE):
occurs when file does not exist in player's storage. This can happen due to insufficient space which causes the player's storage "garbage collector" erasing files least-recently-used (LRU).
Media format error (event MEDIA_OPEN_ERROR):
occurs when the header information of the media file describes a format not supported by the player.
Media contents error (event MEDIA_PLAYBACK_ERROR):
occurs during playback of a media file, most likely due to a corrupt media stream.

Designating a URL for Reporting

In your SMIL script, you need to add a section to your head section to define where the media player should upload its logs. For event reporting it should looks like this. 

<head>
  <metadata>
    <x-server xmlns="http://schemas.adfotain.org/adapi-1.0">
      <subscriptionList>
        <subscription>
          <type>EventlogCollection</type>
          <action>http://server/webdav_path</action>
          <method>put</method> 
        </subscription>
      </subscriptionList>
    </x-server>
  </metadata>
</head>

Here "http://server/webdav_path" is the path to the WebDAV-enabled direction on your log server.

A log file named in the format event-{time-based-uuid}.xml will be placed in the server path by the player.

Event Report Format

The A-SMIL event report uploaded to the server looks like this. 

<report xmlns="http://schemas.adfotain.org/adapi-1.0">
   <date>{createDate}</date>
   <version>1.0</version>
   <player id="{playerId}">
     <playerEventLog>
       <event>
         <eventType>informational|warning|error|critical</eventType>
         <eventTime>{eventTime}</eventTime>
         <eventSource>{moduleName}</eventSource>
         <eventName>{eventEnumName}</eventName>
         <metadata>
           <meta name="{meta1-name}" content="{meta1-content}"/>
           <meta .../>
         </metadata>
       </event>
     </playerEventLog>
  </player>
</report>


Player Event Listed by Event Source

Player events listed by different event sources as below :

Source : ContentManager

event:
LRU_OBJECT_REMOVED
eventType:
informational if lastAccessTime is before 30 days
meta "resourceURI":
URI for the object that removed
meta "lastAccessTime":
object last access time


event:
OBJECT_REMOVED
eventType:
informational
meta "resourceURI":
URI for the object that removed


event:
OBJECT_UPDATED
eventType:
informational
meta "resourceURI":
URI for the object that updated
meta "contentLength":
content length in bytes
meta "lastModifiedTime":
object last modified time


event:
FETCH_FAILED
eventType:
error if no other versions available in cache; warning if an earlier version exists
meta "resourceURI":
URI for the file that failed to transfer
meta "transferLength":
Number of bytes transferred so far
meta "lastCachedLength":
If a previous version exists, its length in bytes
meta "lastCachedModifiedTime":
If a previous version exists, its modified time


event:
BROKEN_OBJECT_REMOVED
eventType:
warning
meta "resourceURI":
URI for the object that removed
meta "lastModifiedTime":
object last modified time
meta "contentLength":
content length in bytes
meta "transferLength":
actual file size; -1 means file not found


Source : MediaPlayer

event:
MEDIA_NOT_AVAILABLE
eventType:
error
meta "resourceURI":
URI for the object that not available


event:
MEDIA_OPEN_ERROR
eventType:
error
meta "resourceURI":
URI for the object that fails to open


event:
MEDIA_PLAYBACK_ERROR
eventType:
error
meta "resourceURI":
URI for the object that fails to play


Source : MediaControl

event:
SMIL_LOADED
eventType:
informational
meta "instanceId":
n/a
meta "resourceURI":
URI for the object that loaded
meta "contentLength":
object length in bytes
meta "lastModifiedTime":
object last modified time


event:
SMIL_NOT_AVAILABLE
eventType:
informational
meta "instanceId":
n/a
meta "resourceURI":
URI for the object that not available


event:
SMIL_OPEN_ERROR
eventType:
error document error (too large, syntax error, other errors), other internal errors
meta "instanceId":
n/a
meta "resourceURI":
URI for the object that loaded
meta "contentLength":
object length in bytes
meta "lastModifiedTime":
object last modified time


Source : System

event:
STORAGE_FORMATTED
eventType:
warning


event:
STORAGE_TRUNCATED
eventType:
warning


Source : TimeService

event:
TIME_SYNCHRONIZED
eventType:
informational
meta "protocol":
Time synchornization protocol ( http | rdate )
meta "server":
URI for the time server
meta "adjustment":
the time being adjusted after syhchronization


event:
TIME_SYNCHRONIZATION_ERROR
eventType:
warning
meta "protocol":
Time synchornization protocol ( http | rdate )
meta "server":
URI for the time server


Related

Retrieved from "https://www.a-smil.org/index.php?title=Player_events&oldid=326"