package hypercards

Get desktop application:
View/edit binary Protocol Buffers messages

ScreenSharing is a HyperCard that allows sending/receiving screen data. Note: all calls MUST be done with a "user-id" header.

• rpc SendScreen (SendScreenReq, SendScreenRep)

  whiteboard.proto:34

  SendScreen sends the drawable canvas as it changes.

  message SendScreenReq

  whiteboard.proto:49

  • string room_id = 1

    The room this screenshot is from.

  • bytes screen_png = 2

    Whole screenshot, encoded in PNG.

  message SendScreenRep

  whiteboard.proto:54

  (message has no fields)

• rpc RecvScreen (RecvScreenReq, RecvScreenRep)

  whiteboard.proto:37

  RecvScreen gets the most recent screenshot of a room.

  message RecvScreenReq

  whiteboard.proto:41

  • string room_id = 1

    The room to receive canvas from.

  message RecvScreenRep

  whiteboard.proto:45

  • bytes canvas_png = 1

    The screenshot as a PNG image.

Whiteboard is a shared drawing canvas HyperCard. Note: all calls MUST be done with a "user-id" header.

• rpc RecvEvents (RecvEventsReq, stream Event)

  whiteboard.proto:16

  RecvEvents listens to new events from others for a given room. Events are sent using the SendEvent call. A user never receives their own events. When stream is closed, other users of the room should receive a disconnection event.

  message RecvEventsReq

  whiteboard.proto:82

  • string room_id = 1

    Room to receive events from.

• rpc SendEvent (SendEventReq, SendEventRep)

  whiteboard.proto:19

  SendEvent publishes a user's event, which then gets routed to zero or more rooms.

  message SendEventReq

  whiteboard.proto:86

  • optional Event event = 1

  • repeated string room_ids = 2

    Rooms to send event to.

  message SendEventRep

  whiteboard.proto:90

  (message has no fields)

• rpc ListRooms (ListRoomsReq, ListRoomsRep)

  whiteboard.proto:22

  ListRooms returns a paginated list of rooms.

  message ListRoomsReq

  whiteboard.proto:93

  TODO: cursor with direction+offset+limit

  (message has no fields)

  message ListRoomsRep

  whiteboard.proto:96

  • repeated Event events = 1

    TODO: cursor

• rpc ListRoomMembers (ListRoomMembersReq, ListRoomMembersRep)

  whiteboard.proto:25

  ListRoomMembers returns a paginated list of room members.

  message ListRoomMembersReq

  whiteboard.proto:103

  • string room_id = 1

    TODO: cursor with direction+offset+limit

  message ListRoomMembersRep

  whiteboard.proto:107

  • repeated RoomMember members = 1

    TODO: cursor

Used in: Event

• repeated float xs = 1

• repeated float ys = 2

• repeated int32 pressures = 3

• repeated uint32 widths = 4

• Drawing.Color color = 5

Used in: Drawing

• invisible = 0

• BLACK = 1

• WHITE = 2

Used as response type in: Whiteboard.RecvEvents

Used as field type in: ListRoomsRep, SendEventReq

• int64 created_at = 1

  Unset when publishing

• string by_user_id = 2

  Unset when publishing

• string in_room_id = 3

  Unset when publishing

• oneof event

  • Drawing drawing = 4

  • bool user_left_the_room = 5

  • bool user_joined_the_room = 6

  • uint32 users_in_the_room = 7

Used in: ListRoomMembersRep

(message has no fields)