@datafire/zappiti v6.0.0

@datafire/zappiti

Client library for Zappiti Player API

Installation and Usage

npm install --save @datafire/zappiti

let zappiti = require('@datafire/zappiti').create();

.then(data => {
  console.log(data);
});

Description

Move your app forward with the Zappiti Player API. Use http://your-player-ip:8990/ as base URL for your requests.

Actions

CheckZappitiService.post

ErrorCode.NotInstalled ErrorCode.NotRunning ErrorCode.Running

zappiti.CheckZappitiService.post({
  "body": {}
}, context)

Input

• input object
  • body required CheckZappitiServiceRequest

Output

• output CheckZappitiServiceResult

ConnectionDetails.post

Get user's login details

zappiti.ConnectionDetails.post({
  "body": {}
}, context)

Input

• input object
  • body required ConnectionDetailsRequest

Output

• output ConnectionDetailsResult

InstallZappitiService.post

Open a popup that allow the user to install Zappiti Service, if not already installed

zappiti.InstallZappitiService.post({
  "body": {}
}, context)

Input

• input object
  • body required InstallZappitiServiceRequest

Output

• output InstallZappitiServiceResult

IsAlive.post

Get server status

zappiti.IsAlive.post({
  "body": {}
}, context)

Input

• input object
  • body required IsAliveRequest

Output

• output IsAliveResult

LastMedia.post

Get informations about last media playback

zappiti.LastMedia.post({
  "body": {}
}, context)

Input

• input object
  • body required LastMediaRequest

Output

• output LastMediaResult

StartVideo.post

Start the playback of the speficied video.

zappiti.StartVideo.post({
  "body": {}
}, context)

Input

• input object
  • body required StartVideoRequest

Output

• output StartVideoResult

StartZappitiService.post

Start Zappiti Service if not started yet

zappiti.StartZappitiService.post({
  "body": {}
}, context)

Input

• input object
  • body required StartZappitiServiceRequest

Output

• output StartZappitiServiceResult

Definitions

CheckZappitiServiceRequest

• CheckZappitiServiceRequest object
  • ApiKey string: Client API Key

CheckZappitiServiceResult

• CheckZappitiServiceResult object
  • ErrorCode ErrorCode

ConnectionDetailsRequest

• ConnectionDetailsRequest object
  • ApiKey string: Client API Key

ConnectionDetailsResult

• 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

ErrorCode

• ErrorCode string (values: None, Failed, Exist, NotInstalled, NotRunning, Running, FailToStart, BadApiKey)

InstallZappitiServiceRequest

• InstallZappitiServiceRequest object
  • ApiKey string: Client API Key

InstallZappitiServiceResult

• InstallZappitiServiceResult object
  • ErrorCode ErrorCode

IsAliveRequest

• IsAliveRequest object
  • ApiKey string: Client API Key

IsAliveResult

• IsAliveResult object
  • ErrorCode ErrorCode

LastMediaRequest

• LastMediaRequest object
  • ApiKey string: Client API Key

LastMediaResult

• LastMediaResult object
  • Actors array
    • items string
  • BackgroundUrl string
  • Directors array
    • items string
  • Episode integer
  • ErrorCode ErrorCode
  • PosterUrl string
  • Runtime integer
  • Season integer
  • Synopsis string
  • Title string
  • TvShowName string

StartVideoRequest

• 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

StartVideoResult

• StartVideoResult object
  • ErrorCode ErrorCode

StartZappitiServiceRequest

• StartZappitiServiceRequest object
  • ApiKey string: Client API Key

StartZappitiServiceResult

• StartZappitiServiceResult object
  • ErrorCode ErrorCode