KinesteX

Camera Component Parameters

Parameters that are only consumed by the standalone Camera component (createCameraComponent / IntegrationOption.CAMERA, route /camera). Passing them to any other integration option has no effect. For the full Camera component guide — including events and control commands — see Camera Component.


ParameterTypeDefaultWhat it does internally
exercisesstring[]The allowlist of exercise models to download at launch. Only exercises in this list (plus any added later via load_models) can be activated with currentExercise — switching to an unlisted exercise posts error_occurred
currentExercisestringThe active exercise. Can be updated at runtime (postMessage / changeExercise / updateCurrentExercise) to switch tracking instantly. Also accepts control commands ("Pause Exercise", "Pause Audio", "Resume Audio", "Workout Overview", "Stop Camera")
exerciseFetchTypestring"model_id"How the backend should interpret each value in exercises (and in load_models requests): "model_id", "exercise_id", or "exercise_title". Invalid values silently fall back to the backend default
restSpeechesstring[]Speech audio IDs (from the exercise's rest_speech field) to pre-download so they can be played instantly later
currentRestSpeechstringPlays the given pre-loaded speech ID immediately. Send the special value "Stop audio" to stop playback. Update it at runtime the same way as currentExercise

Loading more exercises at runtime: send the load_models action ({ workout_activity_action: "load_models", exercises: [...], exerciseFetchType?: "..." }) to fetch and cache additional models mid-session without re-mounting. The SDK replies with models_loaded (listing the IDs that resolved) and speech_fetch_complete; failures arrive as error_occurred. Successfully loaded IDs are automatically added to the exercises allowlist so currentExercise can switch to them.


Related parameters that also work here: videoURL (Testing & Simulation), includePoseData, includeRealtimeAccuracy, landmarkColor, showSilhouette, videoFit (Camera & Pose Detection).