Editor Scripting API
    Preparing search index...

    Class WebSocket

    WebSocket client for establishing and communicating over WebSocket connections in Lens Studio plugins.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    localAddress onConnect onData onEnd onError remoteAddress

    Methods

    close connect create destroy getTypeName isOfType isSame send

    Constructors

    Properties

    localAddress: Address

    The local address bound to this socket.

    onConnect: signal0<void>

    Signal fired when the socket successfully establishes a connection.

    onData: signal1<Buffer, void>

    Signal fired when data is received on the socket, carrying the received buffer.

    onEnd: signal0<void>

    Signal fired when the remote end signals the end of transmission.

    onError: signal1<number, void>

    Signal fired when a socket error occurs.

    remoteAddress: Address

    The remote address this socket is connected to.

    Methods

    • Closes the socket connection gracefully.

      Returns void

    • Connects to a remote address using the WebSocket protocol.

      Parameters

      Returns void

    • Destroys the socket and releases all associated resources immediately.

      Returns void

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Sends binary or text data over the WebSocket connection, returning the number of bytes sent.

      Parameters

      • data: string | Uint8Array

      Returns number

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods