Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KodiClient

Class for dynamically calling the Kodi JSON-RPC api, regardless of api version.

Hierarchy

  • KodiClient

Index

Constructors

constructor

Properties

Optional Addons

Addons: KodiMethodNamespace

Optional Application

Application: KodiMethodNamespace

Optional AudioLibrary

AudioLibrary: KodiMethodNamespace

Optional Favourites

Favourites: KodiMethodNamespace

Optional Files

Files: KodiMethodNamespace

Optional GUI

GUI: KodiMethodNamespace

Optional Input

Input: KodiMethodNamespace

Optional JSONRPC

JSONRPC: KodiMethodNamespace

Optional PVR

PVR: KodiMethodNamespace

Optional Player

Player: KodiMethodNamespace

Optional Playlist

Playlist: KodiMethodNamespace

Optional Profiles

Profiles: KodiMethodNamespace

Optional Settings

Settings: KodiMethodNamespace

Optional System

System: KodiMethodNamespace

Optional Textures

Textures: KodiMethodNamespace

Optional VideoLibrary

VideoLibrary: KodiMethodNamespace

Optional XBMC

XBMC: KodiMethodNamespace

clientType

clientType: ClientType

Optional introspectionCache

introspectionCache: KodiIntrospect

jsonRpcClient

jsonRpcClient: JaysonClient

throwValidationError

throwValidationError: boolean

Methods

connect

  • connect(): Promise<void>
  • Method to manually connect to the defined web socket; silently returns for any other client type.

    Returns Promise<void>

disconnect

  • disconnect(): Promise<void>
  • Method to manually disconnect from the defined web socket; silently returns for any other client type.

    Returns Promise<void>

getIntrospectionCache

listMethods

  • listMethods(): Promise<string[]>
  • listMethods(group: false): Promise<string[]>
  • listMethods(group: true): Promise<Record<string, string[]>>

Static http

Static https

  • Construct an HTTPS instance with Kodi defaults. NOTE: Kodi does not natively or officially support HTTPS; some users have unofficially found a way, though.

    Returns KodiClient

Static tcp

Static ws

Generated using TypeDoc