Client library for Zappiti Player API
npm install --save @datafire/zappiti
let zappiti = require('@datafire/zappiti').create();
.then(data => {
console.log(data);
});
Move your app forward with the Zappiti Player API. Use http://your-player-ip:8990/ as base URL for your requests.
ErrorCode.NotInstalled ErrorCode.NotRunning ErrorCode.Running
zappiti.CheckZappitiService.post({
"body": {}
}, context)
- input
object
- body required CheckZappitiServiceRequest
- output CheckZappitiServiceResult
Get user's login details
zappiti.ConnectionDetails.post({
"body": {}
}, context)
- input
object
- body required ConnectionDetailsRequest
- output ConnectionDetailsResult
Open a popup that allow the user to install Zappiti Service, if not already installed
zappiti.InstallZappitiService.post({
"body": {}
}, context)
- input
object
- body required InstallZappitiServiceRequest
- output InstallZappitiServiceResult
Get server status
zappiti.IsAlive.post({
"body": {}
}, context)
- input
object
- body required IsAliveRequest
- output IsAliveResult
Get informations about last media playback
zappiti.LastMedia.post({
"body": {}
}, context)
- input
object
- body required LastMediaRequest
- output LastMediaResult
Start the playback of the speficied video.
zappiti.StartVideo.post({
"body": {}
}, context)
- input
object
- body required StartVideoRequest
- output StartVideoResult
Start Zappiti Service if not started yet
zappiti.StartZappitiService.post({
"body": {}
}, context)
- input
object
- body required StartZappitiServiceRequest
- output StartZappitiServiceResult
- CheckZappitiServiceRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- CheckZappitiServiceResult
object
- ErrorCode ErrorCode
- ConnectionDetailsRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- ConnectionDetailsResult
object
- AuthKey
string
: User's Authentification key - Collection
string
: User's collection id - Email
string
: User's email used for the collection - ErrorCode ErrorCode
- ServerIp
string
: Server's IP - ServerPort
integer
: Port used by the server
- AuthKey
- ErrorCode
string
(values: None, Failed, Exist, NotInstalled, NotRunning, Running, FailToStart, BadApiKey)
- InstallZappitiServiceRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- InstallZappitiServiceResult
object
- ErrorCode ErrorCode
- IsAliveRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- IsAliveResult
object
- ErrorCode ErrorCode
- LastMediaRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- LastMediaResult
object
- Actors
array
- items
string
- items
- BackgroundUrl
string
- Directors
array
- items
string
- items
- Episode
integer
- ErrorCode ErrorCode
- PosterUrl
string
- Runtime
integer
- Season
integer
- Synopsis
string
- Title
string
- TvShowName
string
- Actors
- StartVideoRequest
object
- ApiKey
string
: Client API Key - AuthKey
string
: User auth key - Collection
string
: Collection id - Ip
string
: Server Ip - MediaId
string
: Id of the video to start - Port
integer
: Server Port
- ApiKey
- StartVideoResult
object
- ErrorCode ErrorCode
- StartZappitiServiceRequest
object
- ApiKey
string
: Client API Key
- ApiKey
- StartZappitiServiceResult
object
- ErrorCode ErrorCode