philtv-js / PhilTVApi
Class: PhilTVApi
Extends
PhilTVApiBase
Constructors
Constructor
new PhilTVApi(
params):PhilTVApi
Parameters
params
Returns
PhilTVApi
Inherited from
PhilTVApiBase.constructor
Methods
changeAmbilightBrightness()
changeAmbilightBrightness(
move):Promise<readonly [Error|undefined,unknown]>
Parameters
move
0 | "0" | "1" | 7 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | "increase" | "decrease" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10"
Returns
Promise<readonly [Error | undefined, unknown]>
decreaseAmbilightBrightness()
decreaseAmbilightBrightness():
Promise<readonly [Error|undefined,unknown]>
Returns
Promise<readonly [Error | undefined, unknown]>
getAmbiHue()
getAmbiHue():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getAmbilightBrightnessInformation()
getAmbilightBrightnessInformation():
Promise<readonly [Error|undefined,unknown]>
Returns
Promise<readonly [Error | undefined, unknown]>
getAmbilightBrightnessValue()
getAmbilightBrightnessValue():
Promise<readonly [Error|undefined,number]>
Returns
Promise<readonly [Error | undefined, number]>
getAmbilightCached()
getAmbilightCached():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getAmbilightConfiguration()
getAmbilightConfiguration():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getAmbilightFullInformation()
getAmbilightFullInformation():
Promise<readonly [Error|undefined, {ambiHue:any;brightness:unknown;cached:any;configuration:any;mode:any; }]>
Returns
Promise<readonly [Error | undefined, { ambiHue: any; brightness: unknown; cached: any; configuration: any; mode: any; }]>
getAmbilightMode()
getAmbilightMode():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getApplications()
getApplications():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getCurrentActivity()
getCurrentActivity():
Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
getCurrentSetting()
getCurrentSetting(
nodeId):Promise<readonly [Error,undefined] | readonly [undefined,any[]]>
Parameters
nodeId
number
Returns
Promise<readonly [Error, undefined] | readonly [undefined, any[]]>
getDigestClient()
getDigestClient():
object
Gets the digest client instance.
Returns
object
The digest client instance used for API requests.
client
client:
HttpClient
request()
request: (
url,reqOptions) =>Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Parameters
url
string
reqOptions
RequestOptions = {}
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
Inherited from
PhilTVApiBase.getDigestClient
getMenuStructure()
getMenuStructure(
opts):Promise<readonly [undefined,any, {data:any;ok:true; }] | readonly [Error,undefined]>
Parameters
opts
flat?
boolean
Returns
Promise<readonly [undefined, any, { data: any; ok: true; }] | readonly [Error, undefined]>
Inherited from
PhilTVApiBase.getMenuStructure
getMenuStructureItem()
getMenuStructureItem(
context,nodeId):Promise<[Error,undefined] | [undefined,FlatNode]>
Parameters
context
string | undefined
nodeId
number | undefined
Returns
Promise<[Error, undefined] | [undefined, FlatNode]>
Inherited from
PhilTVApiBase.getMenuStructureItem
getMenuStructureItemByContext()
getMenuStructureItemByContext(
context):Promise<[Error,undefined] | [undefined,FlatNode]>
Parameters
context
string
Returns
Promise<[Error, undefined] | [undefined, FlatNode]>
Inherited from
PhilTVApiBase.getMenuStructureItemByContext
getMenuStructureItemByNodeId()
getMenuStructureItemByNodeId(
nodeId):Promise<[Error,undefined] | [undefined,FlatNode]>
Parameters
nodeId
number
Returns
Promise<[Error, undefined] | [undefined, FlatNode]>
Inherited from
PhilTVApiBase.getMenuStructureItemByNodeId
getSystem()
getSystem():
Promise<readonly [Error|undefined,unknown] | readonly [undefined,any]>
Returns
Promise<readonly [Error | undefined, unknown] | readonly [undefined, any]>
increaseAmbilightBrightness()
increaseAmbilightBrightness():
Promise<readonly [Error|undefined,unknown]>
Returns
Promise<readonly [Error | undefined, unknown]>
sendKey()
sendKey(
key):Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Parameters
key
"Adjust" | "AmbilightOnOff" | "Back" | "BlueColour" | "ChannelStepDown" | "ChannelStepUp" | "Confirm" | "CursorDown" | "CursorLeft" | "CursorRight" | "CursorUp" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "Dot" | "FastForward" | "Find" | "GreenColour" | "Home" | "Info" | "Mute" | "Next" | "Online" | "Options" | "Pause" | "PlayPause" | "Previous" | "Record" | "RedColour" | "Rewind" | "Source" | "Standby" | "Stop" | "Subtitle" | "Teletext" | "Viewmode" | "VolumeDown" | "VolumeUp" | "WatchTV" | "YellowColour"
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
setAmbilightBrightness()
setAmbilightBrightness(
brightness):Promise<readonly [Error|undefined,unknown]>
Parameters
brightness
0 | "0" | "1" | 7 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10"
Returns
Promise<readonly [Error | undefined, unknown]>
setAmbilightFollowAudioMode()
setAmbilightFollowAudioMode(
mode):Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }] | readonly [Error|undefined,unknown]>
Parameters
mode
"ENERGY_ADAPTIVE_BRIGHTNESS" | "ENERGY_ADAPTIVE_COLORS" | "KNIGHT_RIDER_ALTERNATING" | "MODE_RANDOM" | "RANDOM_PIXEL_FLASH" | "SPECTRUM_ANALYSER" | "VU_METER"
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }] | readonly [Error | undefined, unknown]>
setAmbilightFollowVideoMode()
setAmbilightFollowVideoMode(
mode):Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }] | readonly [Error|undefined,unknown]>
Parameters
mode
string
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }] | readonly [Error | undefined, unknown]>
setAmbilightMode()
setAmbilightMode(
mode):Promise<readonly [Error,undefined,HttpClientResponse<any>] | readonly [Error,undefined,undefined] | readonly [undefined,any, {data:any;ok:true; }]>
Parameters
mode
"manual" | "internal" | "expert"
Returns
Promise<readonly [Error, undefined, HttpClientResponse<any>] | readonly [Error, undefined, undefined] | readonly [undefined, any, { data: any; ok: true; }]>
setMenuItemSetting()
setMenuItemSetting(
item,value):Promise<readonly [Error,undefined] | readonly [Error|undefined, {body:any;item:FlatNode;originalResponse:HttpClientResponse<any> | {data:any;ok:true; } |undefined;status:number|undefined;statusText:string|undefined; }]>
Parameters
item
FlatNode | undefined
value
any
Returns
Promise<readonly [Error, undefined] | readonly [Error | undefined, { body: any; item: FlatNode; originalResponse: HttpClientResponse<any> | { data: any; ok: true; } | undefined; status: number | undefined; statusText: string | undefined; }]>
Inherited from
PhilTVApiBase.setMenuItemSetting