Class KodiInputNamespace

Index

Constructors

Methods

Back ButtonEvent ContextMenu Down ExecuteAction Home Info Left Right Select SendText ShowCodec ShowOSD ShowPlayerProcessInfo Up

Constructors

constructor

new KodiInputNamespace(sendMessage: ISendMessage): KodiInputNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiInputNamespace
- Defined in namespaces/input.ts:44

Methods

Back

Back(): Promise<string>
Navigates back in the current context.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:53

ButtonEvent

ButtonEvent(
    button: string,
    keymap: InputButtonEventType,
    holdtime?: number,
): Promise<string>
Sends a button event to the player.
Parameters
- button: string
  The name of the button event.
- keymap: InputButtonEventType
- Optionalholdtime: number
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:64

ContextMenu

ContextMenu(): Promise<string>
Opens the context menu.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:78

Down

Down(): Promise<string>
Navigates down in the current context.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:87

ExecuteAction

ExecuteAction(action: InputAction): Promise<string>
Executes a specific action.
Parameters
- action: InputAction
  The action to execute.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:97

Home

Home(): Promise<string>
Navigates to the home screen.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:109

Info

Info(): Promise<string>
Displays the info dialog.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:118

Left

Left(): Promise<string>
Navigates left in the current context.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:127

Right

Right(): Promise<string>
Navigates right in the current context.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:136

Select

Select(): Promise<string>
Selects the currently highlighted item.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:145

SendText

SendText(text: string, done?: boolean): Promise<string>
Sends text input to the player.
Parameters
- text: string
  The text to send.
- done: boolean = true
  Whether the input is complete (default: true).
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:156

ShowCodec

ShowCodec(): Promise<string>
Shows or hides the codec information.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:169

ShowOSD

ShowOSD(): Promise<string>
Shows or hides the On-Screen Display (OSD).

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:179

ShowPlayerProcessInfo

ShowPlayerProcessInfo(): Promise<string>
Shows or hides the player process information.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:190

Up

Up(): Promise<string>
Navigates up in the current context.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/input.ts:199