VirtualLens2

https://vlens2.logilabo.dev/ja/docs
Admin
VirtualLens2 is a camera extension for VRChat that provides advanced camera controls including zoom,...
Tokens:49,130
Snippets:245
Trust Score:4.5
Update:10 months ago
Show doc for...
Tokens:
Raw
### VirtualLens2 Version

Source: https://vlens2.logilabo.dev/ja/docs/_print

Retrieves the installed version of VirtualLens2 as an integer (X*10000 + Y*100 + Z).

```APIDOC
## GET /websites/vlens2_logilabo_dev_ja/VirtualLens2 Version

### Description
Retrieves the installed version of VirtualLens2. The version is represented as an integer calculated by the formula: X * 10000 + Y * 100 + Z, where vX.Y.Z is the version number.

### Method
GET

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Version

### Response
#### Success Response (200)
- **version_code** (integer) - The encoded version number of VirtualLens2.
```

--------------------------------

### VirtualLens2 Position and Orientation Control Parameters

Source: https://vlens2.logilabo.dev/ja/docs/development

Manage camera positioning, leveling, stabilization, and scaling using dedicated parameters.

```APIDOC
## GET /parameters/positional

### Description
Retrieves the current settings for camera position and orientation control.

### Method
GET

### Endpoint
`/parameters/positional`

### Parameters
None

### Response
#### Success Response (200)
- **VirtualLens2 PositionMode** (integer) - Non-synchronized, Read only. Represents the current position adjustment mode:
    - `0`: Camera is held directly by hand.
    - `1`: Camera is fixed in world space.
    - `2`: Camera pose is controlled by the Reposition function.
    - `3`: Camera pose is controlled by the Drone function.
- **VirtualLens2 AutoLeveler** (integer) - Non-synchronized, Read/Write. Represents the current auto-leveling mode:
    - `0`: Auto-leveling is disabled.
    - `1`: Maintains horizontal level.
    - `2`: Maintains vertical level.
    - `3`: Snaps camera rotation in 30-degree increments.
- **VirtualLens2 Stabilizer** (integer) - Non-synchronized, Read/Write. Represents the current anti-shake mode:
    - `0`: Disabled
    - `1`: Weak
    - `2`: Medium
    - `3`: Strong
- **VirtualLens2 RepositionScale** (integer) - Non-synchronized, Read/Write. Sets the scaling factor for movement when using the Reposition function:
    - `0`: 1x
    - `1`: 3x
    - `2`: 10x
    - `3`: 30x
- **VirtualLens2 LoadPin** (integer) - Non-synchronized, Write only. Writing a value from 1 to 4 moves the camera to the corresponding pin position.

#### Response Example
```json
{
  "VirtualLens2 PositionMode": 1,
  "VirtualLens2 AutoLeveler": 0,
  "VirtualLens2 Stabilizer": 2,
  "VirtualLens2 RepositionScale": 0,
  "VirtualLens2 LoadPin": 0 
}
```
```

--------------------------------

### Information Display

Source: https://vlens2.logilabo.dev/ja/docs/_print

Toggles the display of information (e.g., focal length, F-number) on the preview screen. 1 to show, 0 to hide.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 Information

### Description
Controls whether information such as focal length and F-number is displayed on the preview screen. Set to '1' to display, '0' to hide.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Information

### Parameters
#### Query Parameters (for PUT)
- **show_info** (integer) - Required - Set to '1' to show information, '0' to hide.

### Response
#### Success Response (200)
- **current_state** (integer) - The current state of information display (1 for shown, 0 for hidden).
```

--------------------------------

### Grid Display Settings

Source: https://vlens2.logilabo.dev/ja/docs/_print

Configures the type of grid displayed on the preview screen. Options range from 0 (None) to 7 (Custom Grid 4).

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 Grid

### Description
Sets the type of grid to be displayed on the preview screen. Available options are:
- 0: None
- 1: 3x3
- 2: 3x3 + Diagonals
- 3: 6x4
- 4-7: Custom Grids 1-4

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Grid

### Parameters
#### Query Parameters (for PUT)
- **grid_type** (integer) - Required - The desired grid type (0-7).

### Response
#### Success Response (200)
- **current_grid_type** (integer) - The currently configured grid type.
```

--------------------------------

### VirtualLens2 State Parameters

Source: https://vlens2.logilabo.dev/ja/docs/development

Read the current state of VirtualLens2 features, such as whether it is enabled, if an alt mesh is being used, or the current settings for zoom, aperture, and exposure.

```APIDOC
## GET /parameters

### Description
Retrieves the current values of various VirtualLens2 parameters.

### Method
GET

### Endpoint
`/parameters`

### Parameters
None

### Response
#### Success Response (200)
- **VirtualLens2 Enable** (integer) - Synchronized, Read/Write. `1` if VirtualLens2 is enabled, `0` otherwise.
- **VirtualLens2 AltMesh** (integer) - Synchronized, Read only. `1` if an alternative mesh is displayed, `0` otherwise. Note: This may differ between local and remote players if hand tracking and anti-shake are enabled.
- **VirtualLens2 Zoom** (float) - Optional-synchronized, Read/Write. Value between `0.0` and `1.0` representing focal length. Formula for focal length (f): `f = f_min * exp(x * log(f_max / f_min))`.
- **VirtualLens2 Aperture** (float) - Optional-synchronized, Read/Write. Value between `0.0` and `1.0` representing the aperture (F-number). Formula for F-number (F): `F = F_min * exp(x * log(F_max / F_min))`.
- **VirtualLens2 Exposure** (float) - Optional-synchronized, Read/Write. Value between `0.0` and `1.0` representing exposure compensation. Formula for exposure (E) in EV: `E = (2x - 1) * Exposure Range`.

#### Response Example
```json
{
  "VirtualLens2 Enable": 1,
  "VirtualLens2 AltMesh": 0,
  "VirtualLens2 Zoom": 0.5,
  "VirtualLens2 Aperture": 0.7,
  "VirtualLens2 Exposure": 0.6
}
```
```

--------------------------------

### Preview HUD Control

Source: https://vlens2.logilabo.dev/ja/docs/_print

Controls the display of the preview HUD. 1 to show, 0 to hide.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 PreviewHUD

### Description
Manages the visibility of the preview Heads-Up Display (HUD). Set to '1' to display the HUD, '0' to hide it.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 PreviewHUD

### Parameters
#### Query Parameters (for PUT)
- **show_hud** (integer) - Required - Set to '1' to show the preview HUD, '0' to hide.

### Response
#### Success Response (200)
- **current_state** (integer) - The current state of the preview HUD display (1 for shown, 0 for hidden).
```

--------------------------------

### Output Resolution

Source: https://vlens2.logilabo.dev/ja/docs/_print

Retrieves the expected image resolution (width and height) from VirtualLens2.

```APIDOC
## GET /websites/vlens2_logilabo_dev_ja/VirtualLens2 Resolution X, /websites/vlens2_logilabo_dev_ja/VirtualLens2 Resolution Y

### Description
Retrieves the expected output image resolution (width and height) from VirtualLens2 as integer values.

### Method
GET

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Resolution X
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Resolution Y

### Response
#### Success Response (200)
- **resolution_width** (integer) - The expected output image width.
- **resolution_height** (integer) - The expected output image height.
```

--------------------------------

### Touch Override Control

Source: https://vlens2.logilabo.dev/ja/docs/_print

Enables simulating touch screen input via avatar parameters. When enabled (1), TouchOverrideX and TouchOverrideY define the touch coordinates.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 TouchOverride

### Description
This flag allows simulating touch screen interactions using avatar parameters. When set to '1', the coordinates specified by `TouchOverrideX` and `TouchOverrideY` are registered as touched.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 TouchOverride

### Parameters
#### Query Parameters (for PUT)
- **override_state** (integer) - Required - Set to '1' to enable touch override, '0' to disable.

### Response
#### Success Response (200)
- **current_state** (integer) - The current state of touch override (1 for enabled, 0 for disabled).
```

--------------------------------

### VirtualLens2 TouchOverride

Source: https://vlens2.logilabo.dev/ja/docs/development

Enables simulating touch screen input via avatar parameters. When enabled (1), TouchOverrideX and TouchOverrideY define the touch coordinates.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/TouchOverride

### Description
Enables or disables simulating touch screen input via avatar parameters.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/TouchOverride

### Parameters
#### Query Parameters (for PUT)
- **enabled** (integer) - Required - 1 to enable touch simulation, 0 to disable.

### Request Example (PUT)
```json
{
  "enabled": 1
}
```

### Response
#### Success Response (200)
- **enabled** (integer) - The current state of touch override (1 for enabled, 0 for disabled).
```

--------------------------------

### VirtualLens2 Peaking

Source: https://vlens2.logilabo.dev/ja/docs/development

Configures the condition for highlighting in-focus areas on the preview screen. Options are Always Off (0), Manual Focus Only (1), and Always On (2).

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/Peaking

### Description
Configures the condition for highlighting in-focus areas (peaking).

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/Peaking

### Parameters
#### Query Parameters (for PUT)
- **condition** (integer) - Required - The peaking condition: 0 (Always Off), 1 (Manual Focus Only), 2 (Always On).

### Request Example (PUT)
```json
{
  "condition": 1
}
```

### Response
#### Success Response (200)
- **condition** (integer) - The current peaking condition setting.
```

--------------------------------

### VirtualLens2 Grid

Source: https://vlens2.logilabo.dev/ja/docs/development

Configures the type of grid displayed on the preview screen. Options include None (0), 3x3 (1), 3x3 + Diagonal (2), 6x4 (3), and custom grids (4-7).

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/Grid

### Description
Sets the type of grid to be displayed on the preview screen.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/Grid

### Parameters
#### Query Parameters (for PUT)
- **grid_type** (integer) - Required - The grid type: 0 (None), 1 (3x3), 2 (3x3 + Diagonal), 3 (6x4), 4-7 (Custom Grids 1-4).

### Request Example (PUT)
```json
{
  "grid_type": 1
}
```

### Response
#### Success Response (200)
- **grid_type** (integer) - The currently configured grid type.
```

--------------------------------

### VirtualLens2 PreviewHUD

Source: https://vlens2.logilabo.dev/ja/docs/development

Controls the visibility of the preview HUD. 1 shows the HUD, 0 hides it.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/PreviewHUD

### Description
Controls the visibility of the preview HUD.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/PreviewHUD

### Parameters
#### Query Parameters (for PUT)
- **show_hud** (integer) - Required - 1 to show the preview HUD, 0 to hide it.

### Request Example (PUT)
```json
{
  "show_hud": 1
}
```

### Response
#### Success Response (200)
- **show_hud** (integer) - The current state of the preview HUD display (1 for shown, 0 for hidden).
```

--------------------------------

### VirtualLens2 Information

Source: https://vlens2.logilabo.dev/ja/docs/development

Toggles the display of information such as focal length and F-value on the preview screen. 1 shows information, 0 hides it.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/Information

### Description
Controls the display of information (focal length, F-value, etc.) on the preview screen.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/Information

### Parameters
#### Query Parameters (for PUT)
- **show_info** (integer) - Required - 1 to display information, 0 to hide it.

### Request Example (PUT)
```json
{
  "show_info": 1
}
```

### Response
#### Success Response (200)
- **show_info** (integer) - The current state of information display (1 for shown, 0 for hidden).
```

--------------------------------

### Peaking Display Conditions

Source: https://vlens2.logilabo.dev/ja/docs/_print

Sets the conditions for highlighting the in-focus range on the preview screen. Options: 0 (Always Off), 1 (Manual Focus Only), 2 (Always On).

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 Peaking

### Description
Configures the conditions under which the in-focus range is highlighted on the preview screen (peaking). Options:
- 0: Always disabled
- 1: Enabled only during manual focus
- 2: Always enabled

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 Peaking

### Parameters
#### Query Parameters (for PUT)
- **peaking_condition** (integer) - Required - The desired peaking condition (0, 1, or 2).

### Response
#### Success Response (200)
- **current_condition** (integer) - The currently set peaking condition.
```

--------------------------------

### VirtualLens2 StorePin

Source: https://vlens2.logilabo.dev/ja/docs/development

Registers the current camera position as a pin location by writing a value between 1 and 4.

```APIDOC
## POST /websites/vlens2_logilabo_dev_ja/StorePin

### Description
Registers the current camera position as a pin location.

### Method
POST

### Endpoint
/websites/vlens2_logilabo_dev_ja/StorePin

### Parameters
#### Query Parameters
- **pin_number** (integer) - Required - A value between 1 and 4 representing the pin location.

### Request Example
```json
{
  "pin_number": 1
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.
```

--------------------------------

### VirtualLens2 Control Commands

Source: https://vlens2.logilabo.dev/ja/docs/development

Control various VirtualLens2 functionalities by writing specific values to the 'VirtualLens2 Control' parameter. This is useful for applications that cannot directly manipulate VRCExpressionParameters.

```APIDOC
## POST /osc/command/send

### Description
Sends control commands to VirtualLens2 via OSC. This endpoint allows indirect manipulation of parameters that are not directly exposed or synchronized.

### Method
POST

### Endpoint
`/osc/command/send`

### Parameters
#### Request Body
- **parameter** (string) - Required - The name of the parameter to control. For OSC, replace spaces in parameter names with underscores (e.g., `VirtualLens2_Control`).
- **value** (integer) - Required - The command value to send. See the command list below for specific values and their meanings.

### Request Example
```json
{
  "oscMethod": "setParam",
  "parameter": "VirtualLens2_Control",
  "value": 3 
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the command execution (e.g., "success").

#### Response Example
```json
{
  "status": "success"
}
```

### Command List for VirtualLens2 Control

| Value | Description |
|---|---|
| 1 | (Reserved) |
| 2 | Disable |
| 3 | Enable |
| 4 | Auto Leveler: Disable |
| 5 | Auto Leveler: Horizontal |
| 6 | Auto Leveler: Vertical |
| 7 | (Reserved) |
| 8 | Stabilizer: Disable |
| 9 | Stabilizer: Weak |
| 10 | Stabilizer: Medium |
| 11 | Stabilizer: Strong |
| 12 | Pickup |
| 13 | Drop |
| 14 | Reposition |
| 15 | (Reserved) |
| 16 | Reposition Scale: 1x |
| 17 | Reposition Scale: 3x |
| 18 | Reposition Scale: 10x |
| 19 | Reposition Scale: 30x |
| 20 | Pin: Store 1 |
| 21 | Pin: Store 2 |
| 22 | Pin: Store 3 |
| 23 | Pin: Store 4 |
| 24 | Pin: Load 1 |
| 25 | Pin: Load 2 |
| 26 | Pin: Load 3 |
| 27 | Pin: Load 4 |
| 28 | External Pose: Disabled |
| 29 | External Pose: Enabled |
| 30 | Focus Lock: Disabled |
| 31 | Focus Lock: Enabled |
| 32 | AF Mode: Point AF |
| 33 | AF Mode: Face AF |
| 34 | AF Mode: Selfie AF |
| 35 | (Reserved) |
| 36 | Tracking Speed: Immediate |
| 37 | Tracking Speed: Fast |
| 38 | Tracking Speed: Medium |
| 39 | Tracking Speed: Slow |
| 40 | Focusing Speed: Immediate |
| 41 | Focusing Speed: Fast |
| 42 | Focusing Speed: Medium |
| 43 | Focusing Speed: Slow |
| 44 | Mesh Visibility: Show |
| 45 | Mesh Visibility: Hide |
| 46 | Grid: None |
| 47 | Grid: 3x3 |
| 48 | Grid: 3x3+Diagonal |
| 49 | Grid: 6x4 |
| 50 | (Reserved) |
| 51 | (Reserved) |
| 52 | Information: Hide |
| 53 | Information: Show |
| 54 | Leveler: Hide |
| 55 | Leveler: Show |
| 56 | Peaking: Disable |
| 57 | Peaking: MF Only |
| 58 | Peaking: Always |
| 59 | (Reserved) |
| 60 | Far Plane: Default |
| 61 | Far Plane: 10x |
| 62 | Far Plane: 100x |
| 63 | (Reserved) |
| 64 | Transfer Mode Permissive |
| 65 | Transfer Mode: Strict |
| 66 | Depth Enabler: Disable |
| 67 | Depth Enabler: Enable |
```

--------------------------------

### UI Mask

Source: https://vlens2.logilabo.dev/ja/docs/_print

Determines whether UI elements are displayed. 1 to display, 0 not to display.

```APIDOC
## GET/PUT /websites/vlens2_logilabo_dev_ja/VirtualLens2 UIMask

### Description
Selects whether UI elements should be rendered. Set to '1' to display, '0' to hide.

### Method
GET/PUT

### Endpoint
/websites/vlens2_logilabo_dev_ja/VirtualLens2 UIMask

### Parameters
#### Query Parameters (for PUT)
- **render_ui** (integer) - Required - Set to '1' to render UI elements, '0' to hide.

### Response
#### Success Response (200)
- **current_state** (integer) - The current state of UI element rendering (1 for displayed, 0 for hidden).
```

--------------------------------

### VirtualLens2 Aperture Min, VirtualLens2 Aperture Max

Source: https://vlens2.logilabo.dev/ja/docs/development

Read-only parameters for the minimum and maximum aperture values (F-stop) as floating-point numbers.

```APIDOC
## GET /websites/vlens2_logilabo_dev_ja/ApertureRange

### Description
Retrieves the minimum and maximum aperture values (F-stop).

### Method
GET

### Endpoint
/websites/vlens2_logilabo_dev_ja/ApertureRange

### Response
#### Success Response (200)
- **min_aperture** (float) - The minimum aperture value (F-stop).
- **max_aperture** (float) - The maximum aperture value (F-stop).
```
Tokens:
Raw