Class ConnectedLensModule

Enables the creation and management of networked Lens experiences, allowing for real-time communication and interaction between users through Connected Lenses.

Remarks

Allows use of networked Lens communication capabilities such as real-time communication, co-located session creation and joining, and shared persistent storage. It's recommended to only use one ConnectedLensModule per Lens.

See

Connected Lenses Overview.

Example

function createSession() {
    var options = ConnectedLensSessionOptions.create();

    options.onSessionCreated = onSessionCreated;
    options.onConnected = onConnected;
    options.onDisconnected = onDisconnected;
    options.onMessageReceived = onMessageReceived;
    options.onUserJoinedSession = onUserJoinedSession;
    options.onUserLeftSession = onUserLeftSession;
    options.onError = onError;

    script.connectedLensModule.createSession(options);
}

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

name uniqueIdentifier

Methods

createSession getTypeName isOfType isSame shareSession

Constructors

Protectedconstructor

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

createSession

  • createSession(sessionOptions: ConnectedLensSessionOptions): void

    Create session with the provided options. Will also check if there is a session that can be created from a session sharetype received from other users.

    Parameters

    Returns void

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

shareSession

  • shareSession(
        sessionShareType: SessionShareType,
        onSessionShared: (session: MultiplayerSession, snapcode: Texture) => void,
    ): void

    Share the session with other users, specified by the SessionShareType. Note that if shared via Invitation, a new session will be created. Expect a new onConnected callback with the new session being passed in.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR