{"id":14969989,"url":"https://github.com/xtravision-ai/xtravision-react","last_synced_at":"2025-09-01T01:34:15.665Z","repository":{"id":56717959,"uuid":"462505417","full_name":"xtravision-ai/xtravision-react","owner":"xtravision-ai","description":"A React SDK for XtraVision API","archived":false,"fork":false,"pushed_at":"2024-02-21T05:11:40.000Z","size":3690,"stargazers_count":3,"open_issues_count":4,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-09T00:39:57.606Z","etag":null,"topics":["reactjs","websocket"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xtravision-ai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-22T23:07:28.000Z","updated_at":"2023-08-03T07:48:26.000Z","dependencies_parsed_at":"2023-02-09T03:01:09.933Z","dependency_job_id":"779c58ed-4358-4721-8d96-26295536ebf8","html_url":"https://github.com/xtravision-ai/xtravision-react","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/xtravision-ai/xtravision-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtravision-ai%2Fxtravision-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtravision-ai%2Fxtravision-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtravision-ai%2Fxtravision-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtravision-ai%2Fxtravision-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xtravision-ai","download_url":"https://codeload.github.com/xtravision-ai/xtravision-react/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtravision-ai%2Fxtravision-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273064444,"owners_count":25039261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["reactjs","websocket"],"created_at":"2024-09-24T13:42:48.839Z","updated_at":"2025-09-01T01:34:15.642Z","avatar_url":"https://github.com/xtravision-ai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xtravision-react\n\nA React SDK for XtraVision API\n\n# What is xtraVision-react?\n\nIt is an sdk for fitness related data assessments like calories, rep-count, yoga pose-matching etc\n\n# How to install\n\n``npm install @xtravision/xtravision-react``  \nor  \n``yarn add @xtravision/xtravision-react``\n\n# Example\n\n[Demo](https://github.com/xtravision-ai/xtravision-react/tree/main/demo)\n\n# API Reference\n\n- import the relevant features you want:\n\n```javascript\nimport {\n    ClassCategory,\n    Features,\n    Assessment,\n    XtraVisionOnDemandProvider,\n    useXtraVisionOnDemandContext,\n    useXtraVisionAssessmentContext,\n    XtraVisionAssessmentProvider,\n    XtraVisionEventEmitter, // optional\n} from \"@xtravision/xtravision-react\";\n```\n\n- use the context to get the values:\n\n```javascript\nconst { lastJsonMessage, isCamOn, setIsCamOn } = useXtraVisionAssessmentContext();\n  const videoElementRef = useRef\u003cany\u003e(null);\n  // use for draw skeleton\n  const canvasRef = useRef\u003cany\u003e(null);\n\n  const isEduScreen = false;\n  // assessment name you want\n  const assessment_name = 'SQUATS';\n  const auth_token =\"__AUTH_TOKEN__\";\n\n  const connectionData = {\n    assessment_name,\n    auth_token,\n  }\n\n  const requestData = {\n    isPreJoin\n  }\n\n```\n\n- wrap the component in the context provider and pass the results from the previous context:\n\n```javascript\n    \u003cXtraVisionAssessmentProvider\n      videoElementRef={videoElementRef}\n      connectionData={connectionData}\n      requestData={requestData}\n      canvasElementRef={canvasRef}\n    \u003e\n      {children}\n    \u003c/XtraVisionAssessmentProvider\u003e\n```\n\n- `{children}` elements must have below code and need to connected media input devices using `navigator.mediaDevices`. Please take further reference from demo app. \n```javascript\n        \u003cvideo ref={videoElementRef} \u003e\u003c/video\u003e\n        \u003c!-- \u003ccanvas ref={canvasElementRef}\u003e\u003c/canvas\u003e  // use canvas if you need skeleton --\u003e\n  ```\n\n\n  - If you need live user key-points then you can use `XtraVisionEventEmitter`\n  ```javascript\n      XtraVisionEventEmitter.on('onUserKeyPoints', (data: any) =\u003e {console.log('data.toString()');})\n\n  ```\n\n**NOTE:** For the full detailed code refer demo app\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtravision-ai%2Fxtravision-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxtravision-ai%2Fxtravision-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtravision-ai%2Fxtravision-react/lists"}