Class WebsocketKodiClient

WebSocket client for communicating with Kodi Currently does not handle reconnecting or disconnects

Hierarchy

  • BaseKodiClient
    • WebsocketKodiClient

Constructors

constructor

Properties

Addons Application AudioLibrary Favourites Files GUI Input isOpen JSONRPC Player Playlist Profiles PVR sendMessage Settings System Textures url VideoLibrary webSocket XBMC

Methods

init

Constructors

constructor

  • new WebsocketKodiClient(url: string): WebsocketKodiClient

  • Sets all the event listeners and properties

    Parameters

    • url: string

      full url for the WebSocket connection e.g. "ws://192.168.0.124:9090"

    Returns WebsocketKodiClient

Properties

Addons

Addons: KodiAddonsNamespace

Application

Application: KodiApplicationNamespace

AudioLibrary

AudioLibrary: KodiAudioLibraryNamespace

Favourites

Favourites: KodiFavouritesNamespace

Files

Files: KodiFilesNamespace

GUI

GUI: KodiGUINamespace

Input

Input: KodiInputNamespace

isOpen

isOpen: boolean

JSONRPC

JSONRPC: KodiJSONRPCNamespace

Player

Player: KodiPlayerNamespace

Playlist

Playlist: KodiPlaylistNamespace

Profiles

Profiles: KodiProfilesNamespace

PVR

PVR: KodiPVRNamespace

sendMessage

sendMessage: ISendMessage = ...

The sendMessage method, the actual JSON sent to Kodi

Param: method

name of the method e.g. "Addons.ExecuteAddon"

Param: params

string, number, object, array, whatever the method accepts

Returns

Promise containing the result, or rejects with an error

Settings

Settings: KodiSettingsNamespace

System

System: KodiSystemNamespace

Textures

Textures: KodiTexturesNamespace

url

url: string

VideoLibrary

VideoLibrary: KodiVideoLibraryNamespace

webSocket

webSocket: ReconnectingWebSocket

XBMC

XBMC: KodiXBMCNamespace

Methods

init

  • init(sendMessage: ISendMessage): void

  • Initializing all namespaces MAKE SURE THIS IS CALLED IF YOU'RE EXTENDING THE BaseKodiClient class

    Parameters

    • sendMessage: ISendMessage

      the function used to communicate with Kodi

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods