Lens Scripting API
    Preparing search index...

    Class StreamingSessionExposes User Data

    Continuous-frame camera session for Spectacles. Created via CameraModule#createStreamingSession. After CameraModule.StreamingSession#start, frames are delivered via CameraModule.StreamingSession#onNewFrame until CameraModule.StreamingSession#stop is called.

    Sessions are restartable: stop() releases the camera, start() can be called again with a new (or the same) StreamConfig.

    let cameraModule = require('LensStudio:CameraModule');
    let streams = cameraModule.getSupportedStreams();

    let session = cameraModule.createStreamingSession();
    let config = new CameraModule.StreamConfig();
    config.stream = streams[0];
    config.setConfig(CameraModule.ConfigKey.Iso, [400]);

    session.onNewFrame.add((frame) => {
        mesh.mainPass.baseTex = frame.texture;
    });
    session.onStatusChanged.add((status) => {
        if (status == CameraModule.StreamStatus.Disconnected) print("Camera disconnected");
    });

    session.start(config);
    // Later: session.setConfig(CameraModule.ConfigKey.Iso, [800]);
    // Later: session.stop();  // Restartable.

    Hierarchy (View Summary)

    Index

    Properties

    onNewFrame onStatusChanged

    Methods

    getTypeName getTypeName isOfType isSame setConfig start stop

    Properties

    onNewFrame: event1<CameraModule.Frame, void>

    Event triggered when a new camera frame is available.

    onStatusChanged: event1<StreamStatus, void>

    Event triggered when session status changes (interruption, disconnection).

    Methods

    • Exposes User Data

      Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

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

      Parameters

      • type: string

      Returns 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

    • Exposes User Data

      Reconfigure a dynamic parameter on a live streaming session. Only dynamic ConfigKeys (Iso, ExposureTimeNs, AeRoi) can be changed mid-stream. Static keys return Result.InvalidConfig.

      Parameters

      • key: ConfigKey

        Configuration key.

      • values: number[]

        Configuration values array.

      Returns Result

      Result code.

    • Exposes User Data

      Start continuous frame delivery. The configured stream is opened and frames begin flowing to onNewFrame.

      Parameters

      • config: StreamConfig

        Stream configuration. Required on every start().

      Returns Result

      Result code. Success if the session is now running.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods