View source

A-SMIL players can report on various events happening to a player, including

<dl>
<dt>Download failure (event FETCH_FAILED): 
<dd>occurs when a file cannot be downloaded due to network failure or URL not found.

<dt>File not found error (event MEDIA_NOT_AVAILABLE): 
<dd>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).

<dt>Media format error (event MEDIA_OPEN_ERROR): 
<dd>occurs when the header information of the media file describes a format not supported by the player.

<dt>Media contents error (event MEDIA_PLAYBACK_ERROR): 
<dd>occurs during playback of a media file, most likely due to a corrupt media stream.
</dl>

== Designating a URL for Reporting ==

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

<source lang="smil">
<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>
</source>

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

A log file named in the format <TT>event-{time-based-uuid}.xml</TT> 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.

<source lang="xml">
<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>
</source>

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

=== MEDIA_NOT_AVAILABLE Event ===
<dl>
<dt>eventType: 
<dd><tt>error</tt>
<dt>meta "resourceURI":
<dd>URI for the file that is not available
</dl>

=== MEDIA_OPEN_ERROR Event ===
<dl>
<dt>eventType: 
<dd><tt>error</tt>
<dt>meta "resourceURI":
<dd>URI for the file that fails to open
</dl>

=== MEDIA_PLAYBACK_ERROR Event ===
<dl>
<dt>eventType: 
<dd><tt>error</tt>
<dt>meta "resourceURI":
<dd>URI for the file that fails to play
</dl>

== Related ==

* [[Inventory reporting]]
* [[Play logs]]