Skip to content

Commit

Permalink
docs: add several undocumented url parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Nov 22, 2024
1 parent db7059f commit 0e88f81
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions content/interface/params.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For **advanced** users, the ARENA accepts URL parameters to override some intern

## URL Beginner

The `Scenes` page includes a set of easy checkboxes to change more common URL parameters you may want to use: [https://arenaxr.org/scenes](https://arenaxr.org/scenes).
The `Scenes` page includes a Override of easy checkboxes to change more common URL parameters you may want to use: [https://arenaxr.org/scenes](https://arenaxr.org/scenes).

1. Click `My Scenes` and select your scene name.
1. Click `Scene URL Options` and check the boxes you need.
Expand All @@ -29,24 +29,30 @@ The following URL parameters are accepted, beginner or **advanced**. The **advan
| -- | -- | -- | -- |
| armode | bool | beginner | Instantly enter AR mode, *and* Do not load models with hide-on-enter-ar (allows opening scenes with large models that are not visible in AR). |
| ATLASurl | string | **advanced** | URL of ATLAS (e.g. `ATLASurl=//atlas.conix.io`) |
| atw | bool | **advanced** | Enable Asynchronous Time Warping for remote rendering **(default=true)**. |
| auth | string | beginner | Save the authentication method for the browser session (e.g. `auth=anonymous`, or `auth=google`) |
| build3d | bool | **advanced** | Load A-Frame Inspector with MQTT publish support. |
| build3d | bool | **advanced** | Load Build3d, which is A-Frame Inspector with MQTT publish support. |
| camFollow | string | **advanced** | Force camera pose to the same as a named object-id (e.g. `camFollow=Box123ObjectName`) |
| camUpdateIntervalMs | string | **advanced** | Minimum camera update interval in milliseconds (e.g. `camUpdateIntervalMs=100`) |
| confstats | bool | **advanced** | Enable logging to MQTT of conference quality stats. |
| debug | bool | **advanced** | Replace console log with our MQTT logging, same as `devInstance`. |
| debugUI | bool | **advanced** | Creates an `arenaui-card` object for debugging. |
| demoMode | bool | beginner | Removal of screen settings and chat buttons overlay from scene. |
| fixedCamera | string | **advanced** | Sets the camera name to the given value **and** enables VIO output to `realm/vio/scene-name/camera-name` ; `fixedCamera=iPhone` will set the camera name **exactly** to the given value (not add any prefix/suffix) |
| fixedCamera | string | **advanced** | Sets the camera name to the given value **and** enables VIO output to `realm/vio/scene-name/camera-name` ; `fixedCamera=iPhone` will Override the camera name **exactly** to the given value (not add any prefix/suffix) |
| hudstats | bool | **advanced** | Render a HUD of performance/memory stats. |
| lat | float | **advanced** | Override device location; (e.g. `lat=40.4427`) |
| long | float | **advanced** | Override device location; (e.g. `long=79.9430`) |
| lat | float | **advanced** | Override device latitude location; (e.g. `lat=40.4427`) |
| locOnce | bool | **advanced** | Only use AR camera capture once to localize AprilTag, then ignore AprilTags. |
| long | float | **advanced** | Override device longitude location; (e.g. `long=79.9430`) |
| mqttHost | string | **advanced** | Override MQTT host address (e.g. `mqttHost=arenaxr.org`) |
| name | string | **advanced** | Set user name (e.g. `name=MyName`) |
| name | string | **advanced** | Override user name (e.g. `name=MyName`) |
| noav | bool | beginner | Disables videoconferencing for this browser only. |
| noname | bool | beginner | Handles display of user name on the screen. False: (default) display the user name. True: Do not display the user name. |
| noreticle | bool | beginner | In AR, change the reticle ring to transparent when true, gray when false (default). |
| objectId | string | **advanced** | Used with `build3d` param to focus Inspector omn the named object-id. |
| scene | string | **advanced** | Set scene name (e.g. `scene=AScene`) |
| realm | string | **advanced** | Override realm name (e.g. `realm=MyRealm`) |
| reprojectMovement | bool | **advanced** | Do translation warping for remote rendering. |
| scene | string | **advanced** | Override scene name (e.g. `scene=AScene`) |
| skipav | bool | beginner | Skips the webcam, speaker, microphone setup modal. Attempts to use previously selected devices, or system defaults |
| startCoords | string | **advanced** | User starting x, y, z coordinates in the 3D environment (e.g. `startCoords=0,1.6,0`) |
| startLastPos | bool | beginner | User starts at the last position recorded on this browser (saved per heartbeat in localStorage) |
| vr | bool | beginner | Do not load models with hide-on-enter-vr (allows opening scenes with large models that are not visible in VR). |
| vrmode | bool | beginner | Do not load models with hide-on-enter-vr (allows opening scenes with large models that are not visible in VR). |

0 comments on commit 0e88f81

Please sign in to comment.