Lens Scripting API
    Preparing search index...

    Class StreamConfigExposes User Data

    Stream configuration for creating a camera session.

    The stream descriptor (from getSupportedStreams) defines the camera, resolution, format, and frame rate. Tuning parameters (ISO, exposure, AE ROI) are set via CameraModule.StreamConfig#setConfig; a snapshot crop region is set via CameraModule.StreamConfig#crop.

    let cameraModule = require('LensStudio:CameraModule');
    let config = new CameraModule.StreamConfig();
    config.stream = streams[0];
    config.setConfig(CameraModule.ConfigKey.Iso, [400]);

    // Centered 50% crop in [-1, 1] normalized image space (full image = -1..1 on each axis).
    config.crop = Rect.create(-0.5, 0.5, -0.5, 0.5);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    crop stream

    Methods

    getTypeName getTypeName isOfType isSame setConfig

    Constructors

    Properties

    crop: Rect

    Snapshot crop region in [-1, 1] normalized image space. The full image spans [-1, 1] on each axis (so a centered 50% crop is left=-0.5, right=0.5, bottom=-0.5, top=0.5). Null means "no crop / full image".

    Bounds are normalized by the native side so the order of bottom/top (or Y-up vs Y-down) does not affect the result — the smaller and larger Y are auto-detected.

    Applies to capture sessions (and per-shot overrides) only — ignored on streaming sessions.

    null
    @exposesUserData
    stream: StreamInfo

    Stream descriptor from getSupportedStreams(). Defines camera, resolution, format, and frame rate.

    null
    @exposesUserData

    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

      Set a tuning parameter.

      Parameters

      • key: ConfigKey

        Config key (e.g. CameraModule.ConfigKey.Iso).

      • values: number[]

        Values array (e.g. [400] for ISO).

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods