Copyright (c) 2010-2012 by Axis Communications AB. All rights reserved. PRELIMINARY and CONFIDENTIAL - under NDA (Non-Disclosure Agreement). THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT (INCLUDING ANY LAWFUL MODIFICATIONS THEREOF) ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT (INCLUDING ANY LAWFUL MODIFICATIONS THEREOF), WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT. THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION.
2 Overview
3 Detailed Specification
3.1 Common Data Types
3.1..1 NewTrack
3.1..2 Track
3.1..3 Playlist
3.1..4 Enumeration: PlayingMode
3.1..5 Enumeration: PlayStatus
3.1..6 Enumeration: TrackType
3.1..7 Enumeration: TrackCondition
3.1.1 Play command
3.1.2 SetMode command
3.1.3 GetMode command
3.1.4 Stop command
3.1.5 Pause command
3.1.6 PlayNext command
3.1.7 PlayPrevious command
3.1.8 GetPlaylists command
3.1.9 GetTracks command
3.1.10 GetCurrentPlaylist command
3.1.11 GetCurrentTrack command
3.1.12 AddSchedule command
3.1.13 RemoveSchedule command
3.1.14 CreateTrack command
3.1.15 UploadTrack command
3.1.16 CreatePlaylist command
3.1.17 RemovePlaylist command
3.1.18 RemoveTrack command
3.1.19 SetProxy command
3.1.20 GetProxy command
3.1.21 SetPlaylist command
3.1.22 GetPlayerStatus command
Blalbla
Definition of a audio track
The following fields are available:
Definitition of a audio track.
The following fields are available:
The Playlist ...
The following fields are available:
How the music is played
The following values are available:Tralalla ...
The following values are available:The track type (ex. http, file)
The following values are available:The track type (ex. http, file)
The following values are available:Play a playlist, if no playlist, unpause from previous playing.
Table 1: Play command
Play | Access Class: ACTUATE | |
Message name | Description | |
PlayRequest | This message contains:
xs:unsignedInt TrackIndex [0][1] | |
PlayResponse | This message contains:
xs:unsignedInt TrackIndex [1][1] (extendable) | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Set playing mode.
Table 2: SetMode command
SetMode | Access Class: WRITE_SYSTEM | |
Message name | Description | |
SetModeRequest | This message contains:
| |
SetModeResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Get playing mode.
Table 3: GetMode command
GetMode | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetModeRequest | This message shall be empty. | |
GetModeResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
No more Tralalla ...
Table 4: Stop command
Stop | Access Class: ACTUATE | |
Message name | Description | |
StopRequest | This message shall be empty. | |
StopResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
No more Tralalla ...
Table 5: Pause command
Pause | Access Class: ACTUATE | |
Message name | Description | |
PauseRequest | This message shall be empty. | |
PauseResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 6: PlayNext command
PlayNext | Access Class: ACTUATE | |
Message name | Description | |
PlayNextRequest | This message shall be empty. | |
PlayNextResponse | This message contains:
xs:unsignedInt TrackIndex [1][1] | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 7: PlayPrevious command
PlayPrevious | Access Class: ACTUATE | |
Message name | Description | |
PlayPreviousRequest | This message shall be empty. | |
PlayPreviousResponse | This message contains:
xs:unsignedInt TrackIndex [1][1] | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 8: GetPlaylists command
GetPlaylists | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetPlaylistsRequest | This message contains:
| |
GetPlaylistsResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 9: GetTracks command
GetTracks | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetTracksRequest | This message contains:
| |
GetTracksResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 10: GetCurrentPlaylist command
GetCurrentPlaylist | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetCurrentPlaylistRequest | This message shall be empty. | |
GetCurrentPlaylistResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 11: GetCurrentTrack command
GetCurrentTrack | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetCurrentTrackRequest | This message shall be empty. | |
GetCurrentTrackResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Add a schedule to a playlist.
Table 12: AddSchedule command
AddSchedule | Access Class: ACTUATE | |
Message name | Description | |
AddScheduleRequest | This message contains:
axbp:ScheduleId ScheduleId [1][1] | |
AddScheduleResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Remove a schedule from playlist.
Table 13: RemoveSchedule command
RemoveSchedule | Access Class: WRITE_SYSTEM | |
Message name | Description | |
RemoveScheduleRequest | This message contains:
| |
RemoveScheduleResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 14: CreateTrack command
CreateTrack | Access Class: ACTUATE | |
Message name | Description | |
CreateTrackRequest | This message contains:
| |
CreateTrackResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 15: UploadTrack command
UploadTrack | Access Class: ACTUATE | |
Message name | Description | |
UploadTrackRequest | This message contains:
| |
UploadTrackResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 16: CreatePlaylist command
CreatePlaylist | Access Class: ACTUATE | |
Message name | Description | |
CreatePlaylistRequest | This message contains:
axbp:TrackId TrackIds [0][unbounded] | |
CreatePlaylistResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 17: RemovePlaylist command
RemovePlaylist | Access Class: WRITE_SYSTEM | |
Message name | Description | |
RemovePlaylistRequest | This message contains:
| |
RemovePlaylistResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 18: RemoveTrack command
RemoveTrack | Access Class: WRITE_SYSTEM | |
Message name | Description | |
RemoveTrackRequest | This message contains:
| |
RemoveTrackResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 19: SetProxy command
SetProxy | Access Class: WRITE_SYSTEM | |
Message name | Description | |
SetProxyRequest | This message contains:
| |
SetProxyResponse | This message shall be empty. | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 20: GetProxy command
GetProxy | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetProxyRequest | This message shall be empty. | |
GetProxyResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 21: SetPlaylist command
SetPlaylist | Access Class: WRITE_SYSTEM | |
Message name | Description | |
SetPlaylistRequest | This message contains:
axbp:Name Name [1][1] axbp:TrackId TrackIds [0][unbounded] | |
SetPlaylistResponse | This message contains:
| |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |
Tralalla ...
Table 22: GetPlayerStatus command
GetPlayerStatus | Access Class: READ_SYSTEM_SENSITIVE | |
Message name | Description | |
GetPlayerStatusRequest | This message shall be empty. | |
GetPlayerStatusResponse | This message contains:
axbp:TrackId TrackId [1][1] xs:unsignedInt TrackIndex [1][1] axbp:PlayStatus status [1][1] | |
Fault codes | Description | |
env:Receiver ter:Action ter:Failure | ... |