Skip to content

⚠️ This documentation is still work in progress. If you can't find what you're looking for, please contact us.

PLUME

Installation

Initializing search

Home
Get started
Recorder
Viewer
Python API
Contributing
About

PLUME

Home
Get started
Recorder
Recorder
- Index
- Installation
- Global Settings
- Recorded data
  Recorded data
  - Audio
  - Inputs (controllers, eye-gaze, etc.)
  - Markers
  - Physiological signals
  - Frame-based data
    Frame-based data
    
    Frame-based data
    
    Camera
    
    Game Object
    
    Light
    
    Line Renderer
    
    Mesh Filter
    
    Mesh Renderer
    
    Scene
    
    Skinned Mesh Renderer
    
    Terrain
    
    Transform
    
    UI
    UI
    
    Canvas renderer
    
    Canvas scaler
    
    Canvas
    
    Content size fitter
    
    Graphic
    
    Image
    
    Rect transform
    
    Text
    
    Text mesh pro
    Text mesh pro
    
    Text
    
    XRITK
    XRITK
    
    Interactions
  - Metadata
    Metadata
    
    Index
- Advanced
  Advanced
  - Asset bundle
  - Hooks injection
  - Recording custom data
  - Timestamps
  - Unique identification
  - Format specifications
    Format specifications
    
    Index
    
    packed_sample.proto
    
    record.proto
    
    Common
    Common
    
    common/animation_curve.proto
    
    common/bounds.proto
    
    common/color.proto
    
    common/marker.proto
    
    common/matrix4x4.proto
    
    common/quaternion.proto
    
    common/rect.proto
    
    common/spherical_harmonics_l1.proto
    
    common/spherical_harmonics_l2.proto
    
    common/vector2.proto
    
    common/vector3.proto
    
    common/vector4.proto
    
    LabStreamingLayer
    LabStreamingLayer
    
    lsl/lsl_stream.proto
    
    Unity
    Unity
    
    unity/audio_source.proto
    
    unity/camera.proto
    
    unity/frame.proto
    
    unity/game_object.proto
    
    unity/identifiers.proto
    
    unity/light.proto
    
    unity/lightmap.proto
    
    unity/line_renderer.proto
    
    unity/mesh_filter.proto
    
    unity/mesh_renderer.proto
    
    unity/reflection_probe.proto
    
    unity/renderer.proto
    
    unity/rendering.proto
    
    unity/scene.proto
    
    unity/skinned_mesh_renderer.proto
    
    unity/terrain.proto
    
    unity/terrain_collider.proto
    
    unity/transform.proto
    
    Settings
    Settings
    
    unity/settings/audio_settings.proto
    
    unity/settings/graphics_settings.proto
    
    unity/settings/quality_settings.proto
    
    unity/settings/urp_global_settings.proto
    
    UI
    UI
    
    unity/ui/canvas.proto
    
    unity/ui/canvas_renderer.proto
    
    unity/ui/canvas_scaler.proto
    
    unity/ui/content_size_fitter.proto
    
    unity/ui/graphic.proto
    
    unity/ui/image.proto
    
    unity/ui/rect_transform.proto
    
    unity/ui/text.proto
    
    unity/ui/tmp_text.proto
    
    URP
    URP
    
    unity/urp/additional_camera_data.proto
    
    unity/urp/rendering.proto
    
    unity/urp/volume.proto
    
    XRITK
    XRITK
    
    unity/xritk/input_action.proto
    
    unity/xritk/xr_base_interactable.proto
    
    unity/xritk/xr_base_interactor.proto
Viewer
Viewer
- Index
- Installation
- Replay a record
- In-situ analysis
  In-situ analysis
- Advanced
  Advanced
  - Tutorials
    Tutorials
    
    Create a custom analysis module
Python API
Python API
- Index
- Installation
- Usage
- Ex-situ analysis
  Ex-situ analysis
  - Index
- Advanced
  Advanced
  - Reading custom data
Contributing
About

Installation

PLUME Python can be installed using pip using the following command:

pip install plume-python

GNU General Public License v3.0

Made with Material for MkDocs