{"id":29835219,"url":"https://github.com/livekit/track-processors-js","last_synced_at":"2025-07-29T12:17:32.782Z","repository":{"id":173016171,"uuid":"467147938","full_name":"livekit/track-processors-js","owner":"livekit","description":"Pre-built track processors for background images, blur, etc for use with the LiveKit JS Client SDK","archived":false,"fork":false,"pushed_at":"2025-07-21T18:02:19.000Z","size":1762,"stargazers_count":56,"open_issues_count":7,"forks_count":21,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-07-21T20:19:25.703Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://livekit.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/livekit.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,"zenodo":null}},"created_at":"2022-03-07T15:19:57.000Z","updated_at":"2025-07-21T18:02:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"4149fb6a-c02f-443e-a85e-ee256f02084a","html_url":"https://github.com/livekit/track-processors-js","commit_stats":null,"previous_names":["livekit/track-processors-js"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/livekit/track-processors-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livekit%2Ftrack-processors-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livekit%2Ftrack-processors-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livekit%2Ftrack-processors-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livekit%2Ftrack-processors-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livekit","download_url":"https://codeload.github.com/livekit/track-processors-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livekit%2Ftrack-processors-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267685554,"owners_count":24127706,"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-07-29T02:00:12.549Z","response_time":2574,"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":[],"created_at":"2025-07-29T12:17:32.194Z","updated_at":"2025-07-29T12:17:32.760Z","avatar_url":"https://github.com/livekit.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# LiveKit track processors\n\n## Install\n\n```\nnpm add @livekit/track-processors\n```\n\n## Usage of prebuilt processors\n\n### Available processors\n\nThis package exposes the `BackgroundBlur` and `VirtualBackground` pre-prepared processor pipelines.\n\n- `BackgroundBlur(blurRadius)`\n- `VirtualBackground(imagePath)`\n\n### Usage example\n\n```ts\nimport { BackgroundBlur, supportsBackgroundProcessors, supportsModernBackgroundProcessors } from '@livekit/track-processors';\n\nif(!supportsBackgroundProcessors()) {\n  throw new Error(\"this browser does not support background processors\")\n}\n\nif(supportsModernBackgroundProcessors()) {\n  console.log(\"this browser supports modern APIs that are more performant\");\n}\n\nconst videoTrack = await createLocalVideoTrack();\nconst blur = BackgroundBlur(10);\nawait videoTrack.setProcessor(blur);\nroom.localParticipant.publishTrack(videoTrack);\n\nasync function disableBackgroundBlur() {\n  await videoTrack.stopProcessor();\n}\n\nasync updateBlurRadius(radius) {\n  return blur.updateTransformerOptions({blurRadius: radius})\n}\n\n\n```\n\n## Developing your own processors\n\nA track processor is instantiated with a Transformer.\n\n```ts\n// src/index.ts\nexport const VirtualBackground = (imagePath: string) =\u003e {\n  const pipeline = new ProcessorWrapper(new BackgroundTransformer({ imagePath }));\n  return pipeline;\n};\n```\n\n### Available base transformers\n\n- BackgroundTransformer (can blur background or use a virtual background);\n\n\n## Running the sample app\n\nThis repository includes a small example app built on [Vite](https://vitejs.dev/). Run it with:\n\n```\n# install pnpm: https://pnpm.io/installation\npnpm install\npnpm sample\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivekit%2Ftrack-processors-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivekit%2Ftrack-processors-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivekit%2Ftrack-processors-js/lists"}