Class KodiGUINamespace

Index

Constructors

Methods

ActivateScreenSaver ActivateWindow GetProperties GetStereoscopicModes SetFullscreen SetStereoscopicMode ShowNotification

Constructors

constructor

new KodiGUINamespace(sendMessage: ISendMessage): KodiGUINamespace
Parameters
- sendMessage: ISendMessage
Returns KodiGUINamespace
- Defined in generated/namespaces/gui.ts:20

Methods

ActivateScreenSaver

ActivateScreenSaver(): Promise<string>
Activates currently used screensaver

Returns Promise<string>
string
- Defined in generated/namespaces/gui.ts:28

ActivateWindow

ActivateWindow(params: GUIActivateWindowParams): Promise<string>
Activates the given window
Parameters
- params: GUIActivateWindowParams
Returns Promise<string>
string
- Defined in generated/namespaces/gui.ts:38

GetProperties

GetProperties<P extends readonly (keyof GUIPropertyValue)[]>(
params: { properties: P },
): Promise<
Pick<GUIPropertyValue, Extract<P[number], keyof GUIPropertyValue>>,
>
Type Parameters
- P extends readonly (keyof GUIPropertyValue)[]
Parameters
- params: { properties: P }
Returns Promise<Pick<GUIPropertyValue, Extract<P[number], keyof GUIPropertyValue>>>
- Defined in generated/namespaces/gui.ts:42
GetProperties(params: GUIGetPropertiesParams): Promise<GUIPropertyValue>
Retrieves the values of the given properties
Parameters
- params: GUIGetPropertiesParams
Returns Promise<GUIPropertyValue>
GUIPropertyValue
- Defined in generated/namespaces/gui.ts:48

GetStereoscopicModes

GetStereoscopicModes(): Promise<GUIGetStereoscopicModesResponse>
Returns the supported stereoscopic modes of the GUI

Returns Promise<GUIGetStereoscopicModesResponse>
GUIGetStereoscopicModesResponse
- Defined in generated/namespaces/gui.ts:57

SetFullscreen

SetFullscreen(params: GUISetFullscreenParams): Promise<boolean>
Toggle fullscreen/GUI
Parameters
- params: GUISetFullscreenParams
Returns Promise<boolean>
boolean
- Defined in generated/namespaces/gui.ts:66

SetStereoscopicMode

SetStereoscopicMode(params: GUISetStereoscopicModeParams): Promise<string>
Sets the stereoscopic mode of the GUI to the given mode
Parameters
- params: GUISetStereoscopicModeParams
Returns Promise<string>
string
- Defined in generated/namespaces/gui.ts:75

ShowNotification

ShowNotification(params: GUIShowNotificationParams): Promise<string>
Shows a GUI notification
Parameters
- params: GUIShowNotificationParams
Returns Promise<string>
string
- Defined in generated/namespaces/gui.ts:87