Data Model¶

XRXPManager.Recorder.AddUserProperties(new Dictionary<string, string> {
    { "age", "25" },
    { "experience_level", "beginner" },
    { "dominant_hand", "right" },
    { "group", "control" }
});

// Overall participation session
string mainSession = XRXPManager.Recorder.StartSession(
    comments: "Full experiment participation",
    userId: "participant-001"
);

// Exercise 1 (sub-session of the main session)
string exercise1 = XRXPManager.Recorder.StartSession(
    comments: "Exercise 1 - Navigation task"
);
// ... record events for exercise 1 ...
XRXPManager.Recorder.StopSession(); // stops exercise 1

// Exercise 2 (another sub-session)
string exercise2 = XRXPManager.Recorder.StartSession(
    comments: "Exercise 2 - Object manipulation"
);
// ... record events for exercise 2 ...
XRXPManager.Recorder.StopSession(); // stops exercise 2

// End the overall session
XRXPManager.Recorder.StopSession(); // stops main session

// Host creates the session
string sessionId = XRXPManager.Recorder.StartSession(
    comments: "Surgeon role",
    userId: "surgeon-001"
);

// On another device, a second user joins
XRXPManager.Recorder.JoinSession(
    sessionId: sessionId,
    comments: "Assistant role",
    userId: "assistant-001"
);

// At session start
XRXPManager.Recorder.StartSession(
    comments: "Participant 001",
    environmentProperties: new Dictionary<string, string> {
        { "application_version", "2.1.0" },
        { "difficulty", "hard" },
        { "scene", "OperatingRoom" },
        { "haptic_feedback", "enabled" }
    }
);

// Add more properties later
XRXPManager.Recorder.AddEnvironmentProperties(new Dictionary<string, string> {
    { "lighting_condition", "dim" },
    { "noise_level", "low" }
});

// Simple action
XRXPManager.Recorder.AddLogEvent("User", "clicked", "StartButton");

// With properties
XRXPManager.Recorder.AddLogEvent(
    "Bob", "eats", "apple",
    new Dictionary<string, string> {
        { "apple_color", "red" },
        { "location", "kitchen" }
    }
);

// System event
XRXPManager.Recorder.AddLogEvent(
    "System", "loaded", "Level_3",
    new Dictionary<string, string> {
        { "load_time_ms", "1250" }
    }
);

// Task milestone
XRXPManager.Recorder.AddLogEvent(
    "User", "completed", "NavigationTask",
    new Dictionary<string, string> {
        { "errors", "2" },
        { "time_seconds", "45.3" }
    }
);

// A photo the participant took during a task
XRXPManager.Recorder.AddMediaEvent(
    filePath: "/storage/photos/task1_capture.png",
    mimeType: "image/png",
    name: "Task1_Photo",
    duration: 0
);

// An audio recording
XRXPManager.Recorder.AddMediaEvent(
    filePath: "/storage/audio/participant_response.wav",
    mimeType: "audio/wav",
    name: "Verbal_Response_Q3",
    duration: 12000  // 12 seconds in ms
);

// From a byte array (auto-saved to disk and uploaded to file server)
byte[] screenshot = CaptureScreenshot();
XRXPManager.Recorder.AddMediaEvent(
    bytes: screenshot,
    mimeType: "image/png",
    name: "Environment_Overview",
    duration: 0              // optional, in ms for audio/video
);

using XRXP.Recorder.Models;

// Track body position — all events go under the same "BodyTracking" system
XRXPManager.Recorder.AddInternalEvent(
    SystemType.WorldPosition, "BodyTracking", "Head",
    new WorldPosition(head.position, head.rotation)
);
XRXPManager.Recorder.AddInternalEvent(
    SystemType.WorldPosition, "BodyTracking", "LeftHand",
    new WorldPosition(leftHand.position, leftHand.rotation)
);
XRXPManager.Recorder.AddInternalEvent(
    SystemType.WorldPosition, "BodyTracking", "RightHand",
    new WorldPosition(rightHand.position, rightHand.rotation)
);

using XRXP;
using XRXP.Recorder.Models;
using System.Collections.Generic;

public class SurgeryExperiment : UnityEngine.MonoBehaviour
{
    void Start()
    {
        // 1. Start the overall participation session
        string mainSession = XRXPManager.Recorder.StartSession(
            comments: "Surgeon trainee",
            userId: "trainee-007",
            environmentProperties: new Dictionary<string, string> {
                { "application_version", "3.0.1" },
                { "scenario", "appendectomy" },
                { "difficulty", "intermediate" },
                { "haptic_feedback", "enabled" }
            }
        );

        // 2. Add user properties
        XRXPManager.Recorder.AddUserProperties(new Dictionary<string, string> {
            { "experience_years", "2" },
            { "dominant_hand", "right" },
            { "group", "experimental" }
        });

        // 3. Start first exercise (sub-session)
        XRXPManager.Recorder.StartSession(comments: "Exercise 1 - Incision");
    }

    void LateUpdate()
    {
        if (!XRXPManager.IsReady || !XRXPManager.Recorder.IsRecording()) return;

        // 4. Track tool position (internal system events)
        XRXPManager.Recorder.AddInternalEvent(
            SystemType.WorldPosition, "ToolTracking", "Scalpel",
            new WorldPosition(scalpel.position, scalpel.rotation)
        );
    }

    public void OnIncisionMade()
    {
        // 5. Log a discrete event
        XRXPManager.Recorder.AddLogEvent(
            "User", "performed", "incision",
            new Dictionary<string, string> {
                { "accuracy_mm", "2.3" },
                { "tissue_layer", "dermis" }
            }
        );
    }

    public void OnScreenshot(byte[] imageData)
    {
        // 6. Record a media event
        XRXPManager.Recorder.AddMediaEvent(
            imageData, "image/png", "Incision_Result"
        );
    }

    public void OnExerciseComplete()
    {
        // 7. Record a questionnaire answer
        XRXPManager.Recorder.AddQuestion(
            "Confidence_Level", "4",
            new Dictionary<string, string> { { "scale", "1-5" } }
        );

        // 8. Stop exercise sub-session, start next one
        XRXPManager.Recorder.StopSession();
        XRXPManager.Recorder.StartSession(comments: "Exercise 2 - Suturing");
    }

    void OnApplicationQuit()
    {
        // 9. Clean up
        while (XRXPManager.Recorder.IsRecording())
            XRXPManager.Recorder.StopSession();

        XRXPManager.Recorder.EndTracing();
    }
}