TcrSdk-Windows V1.0
Public Member Functions | List of all members
Keyboard Class Referenceabstract

This interface is used to interact with the virtual Keyboard device on the server. More...

#include <keyboard.h>

Public Member Functions

virtual void OnKeyboard (int32_t keycode, bool down) const =0
 Trigger a key event of the cloud keyboard.
 
virtual void OnKeyboard (int32_t keycode, bool down, bool isLeft) const =0
 Trigger a key event of the cloud keyboard.
 
virtual void CheckKeyboardCapsLock (std::shared_ptr< AsyncCallback > callback) const =0
 Query the capitalization status of the cloud virtual keyboard.
 
virtual void ResetKeyboardCapsLock () const =0
 Reset the capitalization status (to lowercase) of the cloud virtual keyboard.
 
virtual void ResetKeyboard () const =0
 Reset the key status of the cloud keyboard.
 

Detailed Description

This interface is used to interact with the virtual Keyboard device on the server.

Member Function Documentation

◆ CheckKeyboardCapsLock()

virtual void CheckKeyboardCapsLock ( std::shared_ptr< AsyncCallback callback) const
pure virtual

Query the capitalization status of the cloud virtual keyboard.

Parameters
callbackAsynchronous callback object for returning results.

◆ OnKeyboard() [1/2]

virtual void OnKeyboard ( int32_t  keycode,
bool  down 
) const
pure virtual

Trigger a key event of the cloud keyboard.

Parameters
keycodeThe keycode
downValid values: true: Press; false: Release.

◆ OnKeyboard() [2/2]

virtual void OnKeyboard ( int32_t  keycode,
bool  down,
bool  isLeft 
) const
pure virtual

Trigger a key event of the cloud keyboard.

Differentiate between the left and right keys of the keyboard.

Parameters
keycodeThe Windows keycode.
downValid values: true: Press; false: Release.
isLeftUsed to distinguish between left and right keys of the keyboard: true: Left; false : Right.

◆ ResetKeyboard()

virtual void ResetKeyboard ( ) const
pure virtual

Reset the key status of the cloud keyboard.

This API is used to release all keys when there are stuck keys on the keyboard.

◆ ResetKeyboardCapsLock()

virtual void ResetKeyboardCapsLock ( ) const
pure virtual

Reset the capitalization status (to lowercase) of the cloud virtual keyboard.


The documentation for this class was generated from the following file: