package hbb

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Misc

• uint32 sample_rate = 1

• uint32 channels = 2

Used in: Message

• bytes data = 1

Used in: Misc

• string text = 1

Used in: Message

• bool compress = 1

• bytes content = 2

Used in: Message

• oneof union

  • CliprdrMonitorReady ready = 1

  • CliprdrServerFormatList format_list = 2

  • CliprdrServerFormatListResponse format_list_response = 3

  • CliprdrServerFormatDataRequest format_data_request = 4

  • CliprdrServerFormatDataResponse format_data_response = 5

  • CliprdrFileContentsRequest file_contents_request = 6

  • CliprdrFileContentsResponse file_contents_response = 7

Used in: Cliprdr

• int32 conn_id = 1

• int32 stream_id = 2

• int32 list_index = 3

• int32 dw_flags = 4

• int32 n_position_low = 5

• int32 n_position_high = 6

• int32 cb_requested = 7

• bool have_clip_data_id = 8

• int32 clip_data_id = 9

Used in: Cliprdr

• int32 conn_id = 1

• int32 msg_flags = 3

• int32 stream_id = 4

• bytes requested_data = 5

Used in: CliprdrServerFormatList

• int32 conn_id = 1

• int32 id = 2

• string format = 3

main logic from freeRDP

Used in: Cliprdr

• int32 conn_id = 1

Used in: Cliprdr

• int32 conn_id = 1

• int32 requested_format_id = 2

Used in: Cliprdr

• int32 conn_id = 1

• int32 msg_flags = 2

• bytes format_data = 3

Used in: Cliprdr

• int32 conn_id = 1

• repeated CliprdrFormat formats = 2

Used in: Cliprdr

• int32 conn_id = 1

• int32 msg_flags = 2

Used in: RendezvousMessage, TestNatResponse

• int32 serial = 1

• repeated string rendezvous_servers = 2

Used in: PunchHoleRequest, RequestRelay

• DEFAULT_CONN = 0

• FILE_TRANSFER = 1

• PORT_FORWARD = 2

• RDP = 3

Used in: KeyEvent, MouseEvent

• Unknown = 0

• Alt = 1

• Backspace = 2

• CapsLock = 3

• Control = 4

• Delete = 5

• DownArrow = 6

• End = 7

• Escape = 8

• F1 = 9

• F10 = 10

• F11 = 11

• F12 = 12

• F2 = 13

• F3 = 14

• F4 = 15

• F5 = 16

• F6 = 17

• F7 = 18

• F8 = 19

• F9 = 20

• Home = 21

• LeftArrow = 22

• Meta = 23

  / meta key (also known as "windows"; "super"; and "command")

• Option = 24

  / option key on macOS (alt key on Linux and Windows)

  deprecated, use Alt instead

• PageDown = 25

• PageUp = 26

• Return = 27

• RightArrow = 28

• Shift = 29

• Space = 30

• Tab = 31

• UpArrow = 32

• Numpad0 = 33

• Numpad1 = 34

• Numpad2 = 35

• Numpad3 = 36

• Numpad4 = 37

• Numpad5 = 38

• Numpad6 = 39

• Numpad7 = 40

• Numpad8 = 41

• Numpad9 = 42

• Cancel = 43

• Clear = 44

• Menu = 45

  deprecated, use Alt instead

• Pause = 46

• Kana = 47

• Hangul = 48

• Junja = 49

• Final = 50

• Hanja = 51

• Kanji = 52

• Convert = 53

• Select = 54

• Print = 55

• Execute = 56

• Snapshot = 57

• Insert = 58

• Help = 59

• Sleep = 60

• Separator = 61

• Scroll = 62

• NumLock = 63

• RWin = 64

• Apps = 65

• Multiply = 66

• Add = 67

• Subtract = 68

• Decimal = 69

• Divide = 70

• Equals = 71

• NumpadEnter = 72

• RShift = 73

• RControl = 74

• RAlt = 75

• CtrlAltDel = 100

• LockScreen = 101

Used in: Message

• uint64 id = 1

• sint32 hotx = 2

• sint32 hoty = 3

• int32 width = 4

• int32 height = 5

• bytes colors = 6

Used in: Message

• sint32 x = 1

• sint32 y = 2

Used in: PeerInfo

• sint32 x = 1

• sint32 y = 2

• int32 width = 3

• int32 height = 4

• string name = 5

• bool online = 6

if in same intranet, punch hole won't work both for udp and tcp, even some router has below connection error if we connect itself, { kind: Other, error: "could not resolve to any address" }, so we request local address to connect.

Used in: RendezvousMessage

• bytes socket_addr = 1

• string relay_server = 2

Used in: Message

• oneof union

  • ReadDir read_dir = 1

  • FileTransferSendRequest send = 2

  • FileTransferReceiveRequest receive = 3

  • FileDirCreate create = 4

  • FileRemoveDir remove_dir = 5

  • FileRemoveFile remove_file = 6

  • ReadAllFiles all_files = 7

  • FileTransferCancel cancel = 8

Used in: FileAction

• int32 id = 1

• string path = 2

Used in: FileResponse

• int32 id = 1

• string path = 2

• repeated FileEntry entries = 3

Used in: FileDirectory, FileTransferReceiveRequest

• FileType entry_type = 1

• string name = 2

• bool is_hidden = 3

• uint64 size = 4

• uint64 modified_time = 5

Used in: FileAction

• int32 id = 1

• string path = 2

• bool recursive = 3

Used in: FileAction

• int32 id = 1

• string path = 2

• sint32 file_num = 3

Used in: Message

• oneof union

  • FileDirectory dir = 1

  • FileTransferBlock block = 2

  • FileTransferError error = 3

  • FileTransferDone done = 4

Used in: LoginRequest

• string dir = 1

• bool show_hidden = 2

Used in: FileResponse

• int32 id = 1

• sint32 file_num = 2

• bytes data = 3

• bool compressed = 4

Used in: FileAction

• int32 id = 1

Used in: FileResponse

• int32 id = 1

• sint32 file_num = 2

Used in: FileResponse

• int32 id = 1

• string error = 2

• sint32 file_num = 3

Used in: FileAction

• int32 id = 1

• string path = 2

  path written to

• repeated FileEntry files = 3

Used in: FileAction

• int32 id = 1

• string path = 2

• bool include_hidden = 3

Used in: FileEntry

• Dir = 0

• DirLink = 2

• DirDrive = 3

• File = 4

• FileLink = 5

Used in: Message

• string salt = 1

• string challenge = 2

• string id = 1

• bytes pk = 2

Used in: OptionMessage

• NotSet = 0

• Low = 2

• Balanced = 3

• Best = 4

Used in: Message

• bool down = 1

• bool press = 2

• oneof union

  • ControlKey control_key = 3

  • uint32 chr = 4

  • uint32 unicode = 5

  • string seq = 6

• repeated ControlKey modifiers = 8

Used in: RendezvousMessage

• bytes socket_addr = 1

• bytes local_addr = 2

• string relay_server = 3

• string id = 4

• string version = 5

Used in: Message

• string username = 1

• bytes password = 2

• string my_id = 4

• string my_name = 5

• optional OptionMessage option = 6

• oneof union

  • FileTransfer file_transfer = 7

  • PortForward port_forward = 8

• bool video_ack_required = 9

Used in: Message

• oneof union

  • string error = 1

  • PeerInfo peer_info = 2

• oneof union

  • SignedId signed_id = 3

  • PublicKey public_key = 4

  • TestDelay test_delay = 5

  • VideoFrame video_frame = 6

  • LoginRequest login_request = 7

  • LoginResponse login_response = 8

  • Hash hash = 9

  • MouseEvent mouse_event = 10

  • AudioFrame audio_frame = 11

  • CursorData cursor_data = 12

  • CursorPosition cursor_position = 13

  • uint64 cursor_id = 14

  • KeyEvent key_event = 15

  • Clipboard clipboard = 16

  • FileAction file_action = 17

  • FileResponse file_response = 18

  • Misc misc = 19

  • Cliprdr cliprdr = 20

Used in: Message

• oneof union

  • ChatMessage chat_message = 4

  • SwitchDisplay switch_display = 5

  • PermissionInfo permission_info = 6

  • OptionMessage option = 7

  • AudioFormat audio_format = 8

  • string close_reason = 9

  • bool refresh_video = 10

  • OptionResponse option_response = 11

  • bool video_received = 12

Used in: Message

• int32 mask = 1

• sint32 x = 2

• sint32 y = 3

• repeated ControlKey modifiers = 4

Used in: PunchHole, PunchHoleRequest, PunchHoleResponse, PunchHoleSent

• UNKNOWN_NAT = 0

• ASYMMETRIC = 1

• SYMMETRIC = 2

Used in: RendezvousMessage

• string id = 1

• repeated string peers = 2

Used in: RendezvousMessage

• bytes states = 1

Used in: LoginRequest, Misc, OptionResponse

• ImageQuality image_quality = 1

• OptionMessage.BoolOption lock_after_session_end = 2

• OptionMessage.BoolOption show_remote_cursor = 3

• OptionMessage.BoolOption privacy_mode = 4

• OptionMessage.BoolOption block_input = 5

• int32 custom_image_quality = 6

• OptionMessage.BoolOption disable_audio = 7

• OptionMessage.BoolOption disable_clipboard = 8

• OptionMessage.BoolOption enable_file_transfer = 9

Used in: OptionMessage

• NotSet = 0

• No = 1

• Yes = 2

Used in: Misc

• optional OptionMessage opt = 1

• string error = 2

Used in: RendezvousMessage

• string cmd = 1

• string mac = 2

• string id = 3

• string username = 4

• string hostname = 5

• string platform = 6

• string misc = 7

Used in: LoginResponse

• string username = 1

• string hostname = 2

• string platform = 3

• repeated DisplayInfo displays = 4

• int32 current_display = 5

• bool sas_enabled = 6

• string version = 7

• int32 conn_id = 8

Used in: Misc

• PermissionInfo.Permission permission = 1

• bool enabled = 2

Used in: PermissionInfo

• Keyboard = 0

• Clipboard = 2

• Audio = 3

• File = 4

Used in: LoginRequest

• string host = 1

• int32 port = 2

Used in: Message

• bytes asymmetric_value = 1

• bytes symmetric_value = 2

Used in: RendezvousMessage

• bytes socket_addr = 1

• string relay_server = 2

• NatType nat_type = 3

Used in: RendezvousMessage

• string id = 1

• NatType nat_type = 2

• string licence_key = 3

• ConnType conn_type = 4

• string token = 5

Used in: RendezvousMessage

• bytes socket_addr = 1

• bytes pk = 2

• PunchHoleResponse.Failure failure = 3

• string relay_server = 4

• oneof union

  • NatType nat_type = 5

  • bool is_local = 6

• string other_failure = 7

Used in: PunchHoleResponse

• ID_NOT_EXIST = 0

• OFFLINE = 2

• LICENSE_MISMATCH = 3

• LICENSE_OVERUSE = 4

Used in: RendezvousMessage

• bytes socket_addr = 1

• string id = 2

• string relay_server = 3

• NatType nat_type = 4

• string version = 5

Used in: VideoFrame

• bool compress = 1

Used in: FileAction

• int32 id = 1

• string path = 2

• bool include_hidden = 3

Used in: FileAction

• string path = 1

• bool include_hidden = 2

Used in: RendezvousMessage

• string id = 1

• int32 serial = 2

Used in: RendezvousMessage

• bool request_pk = 2

Used in: RendezvousMessage

• string id = 1

• bytes uuid = 2

• bytes pk = 3

• string old_id = 4

Used in: RendezvousMessage

• RegisterPkResponse.Result result = 1

Used in: RegisterPkResponse

• OK = 0

• UUID_MISMATCH = 2

• ID_EXISTS = 3

• TOO_FREQUENT = 4

• INVALID_ID_FORMAT = 5

• NOT_SUPPORT = 6

• SERVER_ERROR = 7

Used in: RendezvousMessage

• bytes socket_addr = 1

• string uuid = 2

• string relay_server = 3

• oneof union

  • string id = 4

  • bytes pk = 5

• string refuse_reason = 6

• string version = 7

• oneof union

  • RegisterPeer register_peer = 6

  • RegisterPeerResponse register_peer_response = 7

  • PunchHoleRequest punch_hole_request = 8

  • PunchHole punch_hole = 9

  • PunchHoleSent punch_hole_sent = 10

  • PunchHoleResponse punch_hole_response = 11

  • FetchLocalAddr fetch_local_addr = 12

  • LocalAddr local_addr = 13

  • ConfigUpdate configure_update = 14

  • RegisterPk register_pk = 15

  • RegisterPkResponse register_pk_response = 16

  • SoftwareUpdate software_update = 17

  • RequestRelay request_relay = 18

  • RelayResponse relay_response = 19

  • TestNatRequest test_nat_request = 20

  • TestNatResponse test_nat_response = 21

  • PeerDiscovery peer_discovery = 22

  • OnlineRequest online_request = 23

  • OnlineResponse online_response = 24

Used in: RendezvousMessage

• string id = 1

• string uuid = 2

• bytes socket_addr = 3

• string relay_server = 4

• bool secure = 5

• string licence_key = 6

• ConnType conn_type = 7

• string token = 8

Used in: Message

• bytes id = 1

Used in: RendezvousMessage

• string url = 1

Used in: Misc

• int32 display = 1

• sint32 x = 2

• sint32 y = 3

• int32 width = 4

• int32 height = 5

Used in: Message

• int64 time = 1

• bool from_client = 2

Used in: RendezvousMessage

• int32 serial = 1

per my test, uint/int has no difference in encoding, int not good for negative, use sint for negative

Used in: RendezvousMessage

• int32 port = 1

• optional ConfigUpdate cu = 2

  for mobile

Used in: VP9s

• bytes data = 1

• bool key = 2

• int64 pts = 3

Used in: VideoFrame

• repeated VP9 frames = 1

Used in: Message

• oneof union

  • VP9s vp9s = 6

  • RGB rgb = 7

  • YUV yuv = 8

planes data send directly in binary for better use arraybuffer on web

Used in: VideoFrame

• bool compress = 1

• int32 stride = 2