Player API (during actual playback) for better smarthome integration support

Zappiti API extension

Queries
1. Extend respond of status: add play, queue, power tag:
Get status
http://your-player-ip:8990/zpt?q=status

Respond:
<zpt:query xmlns:zpt="http://your-player-ip:8990" zpt:count="" zpt:created="time:date" zpt:version=".">
<results>

&lt;play status=””&gt;

  &lt;type&gt;&lt;/type&gt;

  &lt;url&gt;&lt;/url&gt;

  &lt;position current=”” total=”” /&gt;

  &lt;title current=”” total=”” /&gt;

  &lt;chapter current=”” total=”” start=”” end=”” /&gt;

  &lt;position current=”” total=”” /&gt;

&lt;/play&gt;

&lt;queue&gt;

  &lt;total&gt;&lt;/total&gt;

  &lt;current&gt;&lt;/current&gt;

  &lt;mode&gt;&lt;/mode&gt;

&lt;/queue&gt;

&lt;power status=”” /&gt;

</results>
</zpt:query>

play section:
status is none (nothing playing) | pause | play
type is audio|video|picture
url - see command start_playing
position:
current returns position in seconds. If content contain title/chapter information, position is current time on title. For type=pictures nothing returns
total returns total time of content in seconds. If title/chapter information is available, returns а total time of title.
chapter:
current is a current chapter number on title
total is a number of chapters on title
start is a time of chapter’s begin on title (in seconds)
end is a time of chapter’s end on title (in seconds)
title:
current is a current title number
total is a number of titles on content

If nothing playing, nested tags of play is not present.
If the information on the titles/chapters is not available, title/chapter tag is not present.

queue section:
total - total count of queue
current - current position on queue list
mode - mode of queue normal | repeatall | repeatonce | shuffle

power section:
status is on|sleep|off

Get play infos
http://your-player-ip:8990/zpt?q=play_info

Respond:
<zpt:query xmlns:zpt="http://your-player-ip:8990" zpt:count="" zpt:created="time:date" zpt:version=".">
<results>

&lt;type&gt;audio|video|picture&lt;/type&gt;

&lt;audios&gt;

  &lt;track id=0 title=”Russian” selected=”yes”&gt;

    &lt;name&gt;MKV - Track Name&lt;/name&gt;

    &lt;lang&gt;MKV/M2TS/M2TS-3DISO - Language&lt;/lang&gt;

    &lt;format&gt;AC3|EAC3|DTS|DTS-HD|TrueHD&lt;/format&gt;

    &lt;channels&gt;1.0|2.0|5.1|7.2&lt;/channels&gt;

    &lt;bitrate&gt;192/256/384&lt;/bitrate&gt;

  &lt;/track&gt;

…

  &lt;track id=6 title=”Maguar” selected=”no” /&gt;

&lt;/audios&gt;

&lt;subs&gt;

  &lt;subtitle id=0 title=”Russian” selected=”yes”&gt;

    &lt;name&gt;MKV - Subtitle name&lt;/name&gt;

    &lt;lang&gt;MKV/M2TS/M2TS-3DISO - Subtitle language&lt;/lang&gt;

  &lt;/subtitle&gt;

…

  &lt;subtitle id=6 title=”Japan” selected=”no”/&gt;

&lt;/subs&gt;

&lt;chapters&gt;

  &lt;!-- see below --&gt;

&lt;/chapters&gt;

</results>
</zpt:query>

Chapters information if present on content, shows on http://chapterdb.org/Home/Download/18?type=xml format

If content contain title information, tags audios, subs, chapters wrap in title tag
title tag attributes:
id - index number of title
name of title
duration of title in seconds
chaptercount - a number of chapters on title

Get volume level
http://your-player-ip:8990/zpt?q=volume

Respond:
<zpt:query xmlns:zpt="http://your-player-ip:8990" zpt:count="" zpt:created="time:date" zpt:version=".">
<results>

&lt;volume level=”%d” mute=”%s” /&gt;

</results>
</zpt:query>

level is 0-31
mute is on|off

Get 3D status
http://your-player-ip:8990/zpt?q=video3d

Respond:
<zpt:query xmlns:zpt="http://your-player-ip:8990" zpt:count="" zpt:created="time:date" zpt:version=".">
<results>

&lt;video3d avaiable=”yes|no” state=”on|off” /&gt;

</results>
</zpt:query>

Get queue list
http://your-player-ip:8990/zpt?q=queue

Respond:
<zpt:query xmlns:zpt="http://your-player-ip:8990" zpt:count="" zpt:created="time:date" zpt:version=".">
<results>

&lt;queue mode=”” current=””&gt;

  &lt;item id=”” type=””&gt;

    &lt;url&gt;&lt;/url&gt;

    &lt;options&gt;&lt;/options&gt;

  &lt;/item&gt;

…

&lt;/queue&gt;

</results>
</zpt:query>

queue mode is audio|video|picture
queue current is id of current list item

item type, url, options see below in start_playing

Commands
6. Start playing
http://your-player-ip:8990/zpt?cmd=start_playing&type=%s&url=%s[&options=%s]
type is audio|video|picture
url is a urlencoded link to a content:
- path to local file (maybe file://<path>)
- http link (e.g. http://server/path/file.avi or http://user:passwd@server/path/file.avi )
- smb:// or nfs:// share and path on this share, divided tab symbol
examples:
smb://server/share /path/file.avi
nfs://share /path/file.avi

for Samba and nfs protocols can define additional mount options in options parameter
About parameters see nfs and cifs manuals.