package proto

uint32 flags = 1
We use only the first byte in this field. If bit 7 is set to 1, then bits 0-4 contain the cursor index in the cache. If bit 7 is not set, then the cursor image is received. If bit 6 is set to 1, then the command to reset the contents of the cache is received, and bits 0-4 contain a new cache size. Bit 5 is reserved.
int32 width = 2
Width, height (in screen pixels) of the cursor.
int32 height = 3
int32 hotspot_x = 4
X,Y coordinates (relative to upper-left corner) of the cursor hotspot.
int32 hotspot_y = 5
bytes data = 6
Cursor pixmap data in 32-bit BGRA format compressed with Zstd.
int32 dpi_x = 7
Screen DPI for current cursor.
int32 dpi_y = 8

UNKNOWN = 0
RESET_CACHE = 64
CACHE = 128

Used in: HostToClient

string extensions = 1
uint32 video_encodings = 2
uint32 audio_encodings = 3
DesktopCapabilities.OsType os_type = 4
repeated DesktopCapabilities.Flag flag = 5

Used in: DesktopCapabilities

string name = 1
bool value = 2

Used in: DesktopCapabilities

OS_TYPE_WINDOWS = 0
OS_TYPE_LINUX = 1
OS_TYPE_MACOSX = 2

Used in: ClientToHost, address_book.SessionConfig

uint32 flags = 1
VideoEncoding video_encoding = 2
optional PixelFormat pixel_format = 3
uint32 update_interval = 4
Deprecated. Must be equal to 30.
uint32 compress_ratio = 5
uint32 scale_factor = 6
Deprecated. Must be equal to 100.
AudioEncoding audio_encoding = 7

Used in: ClientToHost, HostToClient

string name = 1
bytes data = 2

NO_FLAGS = 0
ENABLE_CURSOR_SHAPE = 1
ENABLE_CLIPBOARD = 2
DISABLE_DESKTOP_EFFECTS = 4
DISABLE_DESKTOP_WALLPAPER = 8
DISABLE_FONT_SMOOTHING = 16
BLOCK_REMOTE_INPUT = 32
LOCK_AT_DISCONNECT = 64
CURSOR_POSITION = 128
CLEAR_CLIPBOARD = 256

Used in: FileRequest

string path = 1

Used in: FileReply

repeated DriveList.Item item = 1

Used in: DriveList

Item.Type type = 1
string path = 2
Fields 3-5 deprecated.

Used in: Item

TYPE_UNKNOWN = 0
TYPE_CDROM = 1
TYPE_REMOVABLE = 2
TYPE_FIXED = 3
TYPE_REMOTE = 4
TYPE_RAM = 5
TYPE_HOME_FOLDER = 6
TYPE_DESKTOP_FOLDER = 7
TYPE_ROOT_DIRECTORY = 8

Used in: FileRequest

uint32 dummy = 1

Used in: ServerHello

ENCRYPTION_UNKNOWN = 0
ENCRYPTION_CHACHA20_POLY1305 = 1
ENCRYPTION_AES256_GCM = 2

Used in: FileReply

FILE_ERROR_UNKNOWN = 0
FILE_ERROR_SUCCESS = 1
FILE_ERROR_NO_LOGGED_ON_USER = 2
FILE_ERROR_INVALID_REQUEST = 3
FILE_ERROR_INVALID_PATH_NAME = 4
FILE_ERROR_PATH_NOT_FOUND = 5
FILE_ERROR_PATH_ALREADY_EXISTS = 6
FILE_ERROR_NO_DRIVES_FOUND = 7
FILE_ERROR_DISK_FULL = 8
FILE_ERROR_ACCESS_DENIED = 9
FILE_ERROR_FILE_OPEN_ERROR = 10
FILE_ERROR_FILE_CREATE_ERROR = 11
FILE_ERROR_FILE_WRITE_ERROR = 12
FILE_ERROR_FILE_READ_ERROR = 13
FILE_ERROR_DISK_NOT_READY = 14

Used in: FileReply

repeated FileList.Item item = 1

Used in: FileList

string name = 1
uint64 size = 2
int64 modification_time = 3
bool is_directory = 4

Used in: FileRequest

string path = 1

Used in: FileReply, FileRequest

uint32 flags = 1
uint64 file_size = 2
bytes data = 3

NO_FLAGS = 0
FIRST_PACKET = 1
LAST_PACKET = 2

Used in: FileRequest

uint32 flags = 1

NO_FLAGS = 0
CANCEL = 1

FileError error_code = 1
optional DriveList drive_list = 2
optional FileList file_list = 3
optional FilePacket packet = 4

optional DriveListRequest drive_list_request = 1
optional FileListRequest file_list_request = 2
optional CreateDirectoryRequest create_directory_request = 3
optional RenameRequest rename_request = 4
optional RemoveRequest remove_request = 5
optional DownloadRequest download_request = 6
optional UploadRequest upload_request = 7
optional FilePacketRequest packet_request = 8
optional FilePacket packet = 9

HOST_CHANNEL_ID_SESSION = 0
HOST_CHANNEL_ID_SERVICE = 1

Used in: PeerToRouter

HostIdRequest.Type type = 1
bytes key = 2

Used in: HostIdRequest

UNKNOWN = 0
NEW_ID = 1
EXISTING_ID = 2

Used in: RouterToPeer

fixed64 host_id = 1
bytes key = 2
HostIdResponse.ErrorCode error_code = 3

Used in: HostIdResponse

SUCCESS = 0
UNKNOWN = 1
NO_HOST_FOUND = 2

Used in: ConnectionOffer

fixed64 host_id = 1
ID to which the client will connect.

repeated fixed64 host_id = 1

Used in: RouterToPeer

HostStatus.Status status = 1

Used in: HostStatus

STATUS_UNKNOWN = 0
STATUS_OFFLINE = 1
STATUS_ONLINE = 2

optional VideoPacket video_packet = 1
optional AudioPacket audio_packet = 2
optional CursorShape cursor_shape = 3
optional ClipboardEvent clipboard_event = 4
optional DesktopExtension extension = 5
optional DesktopCapabilities capabilities = 6
optional CursorPosition cursor_position = 7

Used in: ClientHello

IDENTIFY_SRP = 0
IDENTIFY_ANONYMOUS = 1

Used in: ClientToHost, internal.ServiceToDesktop

uint32 usb_keycode = 1
uint32 flags = 2

The keyboard (Caps/Num) lock states.

UNKNOWN = 0
CAPSLOCK = 1
NUMLOCK = 2
PRESSED = 4

Used in: ClientToHost, internal.ServiceToDesktop

uint32 mask = 1
Button mask.
int32 x = 2
x position.
int32 y = 3
y position.

EMPTY = 0
LEFT_BUTTON = 1
MIDDLE_BUTTON = 2
RIGHT_BUTTON = 4
WHEEL_UP = 8
WHEEL_DOWN = 16
BACK_BUTTON = 32
FORWARD_BUTTON = 64

Extension name: "video_pause", "audio_pause" Sent by client to host.

bool enable = 1

Used in: RelaySessionData.RelayStat, RelayStat

uint64 session_id = 1
PeerConnection.PeerStatus status = 2
string client_address = 3
string client_user_name = 4
string host_address = 5
fixed64 host_id = 6
int64 bytes_transferred = 7
int64 duration = 8
int64 idle_time = 9

Used in: PeerConnection

PEER_STATUS_UNKNOWN = 0
PEER_STATUS_ACTIVE = 1
PEER_STATUS_FINISHED = 2

Used in: AdminToRouter, RouterToRelay

int64 relay_session_id = 1
PeerConnectionRequestType type = 2
uint64 peer_session_id = 3

Used in: PeerConnectionRequest

PEER_CONNECTION_REQUEST_UNKNOWN = 0
PEER_CONNECTION_REQUEST_DISCONNECT = 1

Sent from peer to relay for authentication. If the authentication failed, then the connection should be dropped.

uint32 key_id = 1
Unique key identifier in the relay pool.
bytes public_key = 2
Public key of the peer.
bytes data = 3
Encrypted secret.

bytes random_data = 1
string client_address = 2
string client_user_name = 3
string host_address = 4
fixed64 host_id = 5

optional ConnectionRequest connection_request = 1
optional HostIdRequest host_id_request = 2
optional ResetHostId reset_host_id = 3
optional CheckHostStatus check_host_status = 4

Used in: DesktopConfig, VideoPacketFormat

uint32 bits_per_pixel = 1
uint32 red_max = 2
uint32 green_max = 3
uint32 blue_max = 4
uint32 red_shift = 5
uint32 green_shift = 6
uint32 blue_shift = 7

Used in: Screen

int32 x = 1
int32 y = 2

Extension name: "power_control" Sent by client to host.

PowerControl.Action action = 1

Used in: PowerControl

ACTION_UNKNOWN = 0
ACTION_SHUTDOWN = 1
ACTION_REBOOT = 2
ACTION_LOGOFF = 3
ACTION_LOCK = 4
ACTION_REBOOT_SAFE_MODE = 5

Extension name: "preferred_size" Sent by client to host.

int32 width = 1
int32 height = 2

Used in: VideoPacket, VideoPacketFormat, internal.DesktopFrame

int32 x = 1
int32 y = 2
int32 width = 3
int32 height = 4

Used in: ConnectionOffer

string host = 1
uint32 port = 2
optional RelayKey key = 3
bytes secret = 4

Used in: RelayCredentials, RelayKeyPool

uint32 key_id = 1
Unique key identifier in the proxy pool.
RelayKey.Type type = 2
Key type.
RelayKey.Encryption encryption = 3
Encryption algorithm.
bytes public_key = 4
Public key of the proxy.
bytes iv = 5
Initialization vector.

Used in: RelayKey

ENCRYPTION_UNKNOWN = 0
ENCRYPTION_CHACHA20_POLY1305 = 1

Used in: RelayKey

TYPE_UNKNOWN = 0
TYPE_X25519 = 1

Used in: RelayToRouter

string peer_host = 1
uint32 peer_port = 2
repeated RelayKey key = 3
A pool of one time keys.

Used in: RouterToRelay

uint32 key_id = 1

uint64 pool_size = 1
optional RelaySessionData.RelayStat relay_stat = 2

Used in: RelaySessionData

repeated PeerConnection peer_connection = 1
int64 uptime = 2

Sent from relay to router.

Used in: RelayToRouter

repeated PeerConnection peer_connection = 1
int64 uptime = 2

Sent from relay to router.

optional RelayKeyPool key_pool = 1
optional RelayStat relay_stat = 2

Used in: FileRequest

string path = 1

Used in: FileRequest

string old_name = 1
string new_name = 2

Used in: PeerToRouter

fixed64 host_id = 1

Used in: Screen, ScreenList

int32 width = 1
int32 height = 2

ROUTER_CHANNEL_ID_SESSION = 0

Used in: Session

ROUTER_SESSION_UNKNOWN = 0
ROUTER_SESSION_ADMIN = 1
ROUTER_SESSION_CLIENT = 2
ROUTER_SESSION_HOST = 4
ROUTER_SESSION_RELAY = 8

optional SessionList session_list = 1
optional SessionResult session_result = 2
optional UserList user_list = 3
optional UserResult user_result = 4

optional HostIdResponse host_id_response = 1
optional ConnectionOffer connection_offer = 2
optional HostStatus host_status = 3

Sent from router to relay.

optional RelayKeyUsed key_used = 1
optional PeerConnectionRequest peer_connection_request = 2

Extension name: "select_screen" Sent by client to host for screen or screen resolution selection.

Used in: ScreenList, internal.SelectSource

int64 id = 1
string title = 2
optional Point position = 3
optional Resolution resolution = 4
optional Point dpi = 5

Extension name: "select_screen" Sent by host to client. Contains a list of screens on the host.

Used in: internal.DesktopToService

repeated Screen screen = 1
List of screens on the remote computer.
int64 current_screen = 2
ID of current screen.
int64 primary_screen = 3
ID of primary screen.
repeated Resolution resolution = 4
List of resolutions for current screen.

Extension name: "screen_type" Sent by host to client.

Used in: internal.DesktopToService

ScreenType.Type type = 1
string name = 2

Used in: ScreenType

TYPE_UNKNOWN = 0
TYPE_DESKTOP = 1
TYPE_LOCK = 2
TYPE_LOGIN = 3
TYPE_OTHER = 4

Server to client.

Encryption encryption = 1
bytes iv = 2
optional Version version = 3

Used in: SessionList

int64 session_id = 1
RouterSession session_type = 2
bytes session_data = 3
fixed64 timepoint = 4
string ip_address = 5
optional Version version = 6
string os_name = 7
string computer_name = 8
string architecture = 9

Server to client.

optional Version version = 1
Deprecated since version 2.7.0. For backward compatibility only.
uint32 session_types = 2
uint32 cpu_cores = 3
string os_name = 4
string computer_name = 5
string arch = 6
string display_name = 7

Used in: RouterToAdmin

SessionList.ErrorCode error_code = 1
repeated Session session = 2

Used in: SessionList

SUCCESS = 0
UNKNOWN_ERROR = 1

Used in: AdminToRouter

int64 dummy = 1

Used in: AdminToRouter

SessionRequestType type = 1
int64 session_id = 2

Used in: SessionRequest, SessionResult

SESSION_REQUEST_UNKNOWN = 0
SESSION_REQUEST_DISCONNECT = 1

Client to server.

optional Version version = 1
Deprecated since version 2.7.0. For backward compatibility only.
uint32 session_type = 2
uint32 cpu_cores = 3
string os_name = 4
string computer_name = 5
string arch = 6
string display_name = 7

Used in: RouterToAdmin

SessionRequestType type = 1
SessionResult.ErrorCode error_code = 2

Used in: SessionResult

SUCCESS = 0
INVALID_REQUEST = 1
INTERNAL_ERROR = 2
INVALID_SESSION_ID = 3

Used in: address_book.Computer, internal.ConnectConfirmationRequest, internal.ConnectEvent

SESSION_TYPE_UNKNOWN = 0
SESSION_TYPE_DESKTOP_MANAGE = 1
SESSION_TYPE_DESKTOP_VIEW = 2
SESSION_TYPE_FILE_TRANSFER = 4
SESSION_TYPE_SYSTEM_INFO = 8
SESSION_TYPE_TEXT_CHAT = 16
SESSION_TYPE_PORT_FORWARDING = 32
SESSION_TYPE_ALL = 63
When adding or removing session types, you need to recalculate this value.

Used in: VideoPacketFormat

int32 width = 1
int32 height = 2

Client to server.

bytes A = 1
bytes iv = 2

Client to server.

string username = 1

Server to client.

bytes number = 1
bytes generator = 2
bytes salt = 3
bytes B = 4
bytes iv = 5

Used in: internal.ServiceToUi, internal.UiToService

optional TextChatStatus chat_status = 1
optional TextChatMessage chat_message = 2

Used in: TextChat

int64 timestamp = 1
string source = 2
string target = 3
string text = 4

Used in: TextChat

int64 timestamp = 1
string source = 2
string target = 3
TextChatStatus.Status status = 4

Used in: TextChatStatus

STATUS_UNKNOWN = 0
STATUS_STARTED = 1
STATUS_STOPPED = 2
STATUS_TYPING = 3
STATUS_USER_DISCONNECTED = 4
STATUS_USER_CONNECTED = 5

Used in: ClientToHost, internal.ServiceToDesktop

string text = 1

Used in: ClientToHost, internal.ServiceToDesktop

TouchEvent.TouchEventType event_type = 1
repeated TouchEventPoint touch_points = 2
Only the changed touch points are added to this field. Given the existing touch point APIs (e.g. Android and PPAPI) for START, END, and CANCEL events the size of this field will typically be 1, but for MOVE events it is likely to have multiple points.

A START event means that this event reports all the touch points that were just added, e.g. a finger started touching the display. A MOVE event means that the touch points that have been STARTed moved, e.g. multiple fingers on the screen moved. An END event means that the touch points that have been STARTed ended. e.g. a finger went off the screen. A CANCEL event means that the touch points that have been STARTed were canceled, e.g. a finger went off the screen. Cancel event is simlar to END but slighly different. For example, Android MotionEvent's ACTION_CANCEL documentation mentions that a cancel should be treated as an ACTION_UP (END) event but might not perform the exact same actions as a normal ACTION_UP event.

Used in: TouchEvent

TOUCH_POINT_UNKNOWN = 0
TOUCH_POINT_START = 1
TOUCH_POINT_MOVE = 2
TOUCH_POINT_END = 3
TOUCH_POINT_CANCEL = 4

Used in: TouchEvent

uint32 id = 1
The ID for the touch point.
float x = 2
The absolute position of the touch point. These values on-the-wire are host physical pixel coordinates: the top-left monitor on the system always starts from (0, 0).
float y = 3
float radius_x = 4
The size of the touch point, used to aid hit-testing. Scaled to match the size on host.
float radius_y = 5
float angle = 6
Angle in degrees from the y-axis of the touch point.
float pressure = 7
The pressure of the touch point. The value should be in [0.0, 1.0].

Used in: FileRequest

string path = 1
bool overwrite = 2

Used in: UserList, UserRequest

int64 entry_id = 1
string name = 2
string group = 3
bytes salt = 4
bytes verifier = 5
uint32 sessions = 6
uint32 flags = 7

Used in: RouterToAdmin

UserList.ErrorCode error_code = 1
repeated User user = 2

Used in: UserList

SUCCESS = 0
UNKNOWN_ERROR = 1

Used in: AdminToRouter

uint32 dummy = 1

Used in: AdminToRouter

UserRequestType type = 1
optional User user = 2

Used in: UserRequest, UserResult

USER_REQUEST_UNKNOWN = 0
USER_REQUEST_ADD = 1
USER_REQUEST_MODIFY = 2
USER_REQUEST_DELETE = 3

Used in: RouterToAdmin

UserRequestType type = 1
UserResult.ErrorCode error_code = 2

Used in: UserResult

SUCCESS = 0
INTERNAL_ERROR = 1
INVALID_DATA = 2
ALREADY_EXISTS = 3

Used in: ClientHello, ServerHello, Session, SessionChallenge, SessionResponse

uint32 major = 1
uint32 minor = 2
uint32 patch = 3
uint32 revision = 4

Identifies how the image was encoded.

Used in: DesktopConfig, VideoPacket

VIDEO_ENCODING_UNKNOWN = 0
VIDEO_ENCODING_ZSTD = 1
VIDEO_ENCODING_VP8 = 2
VIDEO_ENCODING_VP9 = 4

Used in: VideoPacket, internal.ScreenCaptured

VIDEO_ERROR_CODE_OK = 0
VIDEO_ERROR_CODE_PAUSED = 1
VIDEO_ERROR_CODE_TEMPORARY = 2
VIDEO_ERROR_CODE_PERMANENT = 3

Used in: HostToClient

VideoEncoding encoding = 1
optional VideoPacketFormat format = 2
If the screen size or the pixel format has changed, the field must be filled.
repeated Rect dirty_rect = 3
The list of changed rectangles (areas) of the screen.
bytes data = 4
Video packet data.
VideoErrorCode error_code = 5
If there is no error, then it takes the value VIDEO_ERROR_CODE_OK. If the field has any other value, then all other fields are ignored.

Used in: VideoPacket

optional Rect video_rect = 1
optional PixelFormat pixel_format = 2
optional Size screen_size = 3
uint32 capturer_type = 4

Extension name: "video_recording" Sent by host to client and by client to host.

VideoRecording.Action action = 1

Used in: VideoRecording

ACTION_UNKNOWN = 0
ACTION_STARTED = 1
ACTION_STOPPED = 2

package proto

message AdminToRouter

optional SessionListRequest session_list_request = 1

optional SessionRequest session_request = 2

optional UserListRequest user_list_request = 3

optional UserRequest user_request = 4

optional PeerConnectionRequest peer_connection_request = 5

enum AudioEncoding

AUDIO_ENCODING_UNKNOWN = 0

AUDIO_ENCODING_DEFAULT = 1

AUDIO_ENCODING_RAW = 2

AUDIO_ENCODING_OPUS = 3

message AudioPacket

int32 timestamp = 1

repeated bytes data = 2

AudioEncoding encoding = 3

AudioPacket.SamplingRate sampling_rate = 4

AudioPacket.BytesPerSample bytes_per_sample = 5

AudioPacket.Channels channels = 6

enum AudioPacket.BytesPerSample

BYTES_PER_SAMPLE_INVALID = 0

BYTES_PER_SAMPLE_2 = 2

enum AudioPacket.Channels

CHANNELS_INVALID = 0

CHANNELS_MONO = 1

CHANNELS_STEREO = 2

CHANNELS_SURROUND = 3

CHANNELS_4_0 = 4

CHANNELS_4_1 = 5

CHANNELS_5_1 = 6

CHANNELS_6_1 = 7

CHANNELS_7_1 = 8

enum AudioPacket.SamplingRate

SAMPLING_RATE_INVALID = 0

SAMPLING_RATE_44100 = 44100

SAMPLING_RATE_48000 = 48000

SAMPLING_RATE_96000 = 96000

SAMPLING_RATE_192000 = 192000

message CheckHostStatus

fixed64 host_id = 1

message ClientHello

uint32 encryption = 1

Identify identify = 2

bytes public_key = 3

bytes iv = 4

optional Version version = 5

message ClientToHost

optional MouseEvent mouse_event = 1

optional KeyEvent key_event = 2

optional TouchEvent touch_event = 3

optional TextEvent text_event = 4

optional ClipboardEvent clipboard_event = 5

optional DesktopExtension extension = 6

optional DesktopConfig config = 7

optional AudioPacket audio_packet = 8

message ClipboardEvent

string mime_type = 1

bytes data = 2

message ConnectionOffer

ConnectionOffer.PeerRole peer_role = 1

ConnectionOffer.ErrorCode error_code = 2

optional RelayCredentials relay = 3

optional HostOfferData host_data = 4

enum ConnectionOffer.ErrorCode

SUCCESS = 0

UNKNOWN_ERROR = 1

PEER_NOT_FOUND = 2

ACCESS_DENIED = 3

KEY_POOL_EMPTY = 4

enum ConnectionOffer.PeerRole

HOST = 0

CLIENT = 1

message ConnectionRequest

fixed64 host_id = 1

message CreateDirectoryRequest

string path = 1

message CursorPosition

int32 x = 1

int32 y = 2

message CursorShape