Web SDK - IPointerData

Home > rainway-sdk > IPointerData

IPointerData interface

A packet describing the position and appearance of the remote mouse pointer.

A guest receiving such a packet must draw the pointer locally at locally-computed mouse coordinates, as the mouse pointer is not part of the video stream.

See: https://www.notion.so/rainway/Pointer-Data-788741724ec9440bbe8c9d3cb785b3f2

Signature:

export interface IPointerData 

Properties

PropertyTypeDescription
dataUint8ArrayA PNG image depicting the mouse pointer.
monitorHeightnumber
monitorWidthnumber
positionXnumberThe X pixel coordinate of the "tip" of the pointer within the screen.
positionYnumberThe Y pixel coordinate of the "tip" of the pointer within the screen.
shapeHeightnumber
shapeWidthnumber
spotXnumberThe X pixel coordinate of the "tip" of the pointer within the supplied mouse pointer image.
spotYnumberThe Y pixel coordinate of the "tip" of the pointer within the supplied mouse pointer image.
streamIdnumber
visibleboolean