philtv-js

Appearance

philtv-js / PhilTVApiParams

Type Alias: PhilTVApiParams ​

PhilTVApiParams: object

Parameters required to initialize the PhilTVApiBase class.

This object includes the API connection details and optional configuration settings.

Type declaration ​

apiUrl ​

apiUrl: string

The URL of the Philips TV API to connect to. Include the protocol, IP address, port number and API version.

Example ​

ts
https://192.168.0.22:1926/6

options? ​

optional options: object

Optional parameters for API configuration.

options.cacheStructure? ​

optional cacheStructure: boolean

Indicates whether to cache the menu structure locally. If set to true, the retrieved menu structure will be stored in a file using the unstorage library. On subsequent requests, the cached version will be checked before making a network call, which can improve performance by reducing unnecessary API requests. If not required, this option can be omitted or set to false.

password ​

password: string

The password for authentication with the API.

user ​

user: string

The username for authentication with the API.