package proto.desktop

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: ClientToHost, HostToClient

string name = 1
bytes data = 2

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

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: Config, 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

Used in: VideoPacket, VideoPacketFormat, internal.DesktopFrame

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

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 Size 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 Size 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

Used in: Screen, ScreenList, VideoPacketFormat

int32 width = 1
int32 height = 2

message TextEvent

desktop.proto:73

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].

Identifies how the image was encoded.

Used in: Config, 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.desktop

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 Capabilities

string extensions = 1

uint32 video_encodings = 2

uint32 audio_encodings = 3

Capabilities.OsType os_type = 4

repeated Capabilities.Flag flag = 5

message Capabilities.Flag

string name = 1

bool value = 2

enum Capabilities.OsType

OS_TYPE_WINDOWS = 0

OS_TYPE_LINUX = 1

OS_TYPE_MACOSX = 2

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 Extension extension = 6

optional Config config = 7

optional AudioPacket audio_packet = 8

message ClipboardEvent

string mime_type = 1

bytes data = 2

message ClipboardEvent.FileList

repeated FileList.File file = 1

message ClipboardEvent.FileList.File

string path = 1

bool is_dir = 2

int64 file_size = 3

int64 create_time = 4

int64 access_time = 5

int64 modify_time = 6

message Config

uint32 flags = 1

VideoEncoding video_encoding = 2

optional PixelFormat pixel_format = 3

uint32 compress_ratio = 5

AudioEncoding audio_encoding = 7

enum ConfigFlags

NO_FLAGS = 0

ENABLE_CURSOR_SHAPE = 1

ENABLE_CLIPBOARD = 2

DISABLE_EFFECTS = 4

DISABLE_WALLPAPER = 8

DISABLE_FONT_SMOOTHING = 16

BLOCK_REMOTE_INPUT = 32