{"id":16716167,"url":"https://github.com/benrosen/react-video-compositor","last_synced_at":"2025-04-05T05:13:29.561Z","repository":{"id":52790191,"uuid":"359040132","full_name":"benrosen/react-video-compositor","owner":"benrosen","description":"A React video component with virtual backgrounds, foreground effects, and bokeh background blur.","archived":false,"fork":false,"pushed_at":"2021-04-19T12:28:12.000Z","size":1670,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-10T13:12:17.620Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benrosen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-18T04:07:26.000Z","updated_at":"2022-04-14T14:21:56.000Z","dependencies_parsed_at":"2022-08-23T02:01:02.118Z","dependency_job_id":null,"html_url":"https://github.com/benrosen/react-video-compositor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benrosen%2Freact-video-compositor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benrosen%2Freact-video-compositor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benrosen%2Freact-video-compositor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benrosen%2Freact-video-compositor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benrosen","download_url":"https://codeload.github.com/benrosen/react-video-compositor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289430,"owners_count":20914464,"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","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":"2024-10-12T21:12:10.869Z","updated_at":"2025-04-05T05:13:29.534Z","avatar_url":"https://github.com/benrosen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-video-compositor\n\nA flexible React video component for virtual backgrounds, foreground effects, and bokeh background blur.\n\n## Resources\n\n- Repository: https://github.com/benrosen/react-video-compositor\n- Documentation: https://benrosen.github.io/react-video-compositor\n- Package: https://www.npmjs.com/package/react-video-compositor\n\n## Getting Started\n\n### Install\n\n```shell\nnpm i react-video-compositor\n```\n\n### Import\n\nAdd the following line to the top of your `index.js` file.\n\n```javascript\nimport * as tfjs from \"@tensorflow/tfjs\";\n```\n\n### Implement\n\nThe following example shows a `BodyPixCompositor` component that has been configured to render 60 times per second.\n\nThe rendered video will have a blurred background and will be overlaid with an image from a file.\n\nThe `onCaptureStream` callback will be used to log a `MediaStream` to the console.\n\n```javascript\nimport React from \"react\";\nimport { BodyPixCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return (\n    \u003cBodyPixCompositor\n      background=\"blur\"\n      foreground=\"images/foreground.png\"\n      fps={60}\n      onCaptureStream={(stream) =\u003e {\n        console.log(stream);\n      }}\n      style={{\n        border: \"1px dotted magenta\",\n        maxHeight: \"50%\",\n        minHeight: \"10%\",\n      }}\n    /\u003e\n  );\n}\n```\n\n**TIP:** You can use the `onCaptureStream` callback to send the `MediaStream` argument to a service like the [AWS Chime SDK](https://aws.amazon.com/chime/chime-sdk/).\n\n#### Configuring Virtual Backgrounds\n\nThe `background` prop can be used to configure virtual backgrounds for the video stream. The `background` prop accepts a variety of input types, including:\n\n- [Bypass](#raw-video)\n- [Background Blur](#background-blur)\n- [CSS Color Name](#css-color-name)\n- [Hex Code](#hex-code)\n- [RGBA](#rgba)\n- [Image Element](#image-element)\n- [Video Element](#video-element)\n- [Image Path](#image-path)\n- [Video Path](#video-path)\n\n##### Bypass\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor /\u003e;\n}\n```\n\n##### Background Blur\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"blur\" /\u003e;\n}\n```\n\n##### CSS Color Name\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"yellow\" /\u003e;\n}\n```\n\n##### Hex Code\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"#ffff00\" /\u003e;\n}\n```\n\n##### RGBA\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"rgba(255, 255, 0, 1)\" /\u003e;\n}\n```\n\n##### Image Element\n\n```javascript\nimport React, { Fragement, useRef } from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  const imageElement = useRef();\n  return (\n    \u003cFragment\u003e\n      \u003cimg ref={imageElement} /\u003e\n      \u003cVideoCompositor background={imageElement} /\u003e\n    \u003c/Fragment\u003e\n  );\n}\n```\n\n##### Video Element\n\n```javascript\nimport React, { Fragement, useRef } from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  const videoElement = useRef();\n  return (\n    \u003cFragment\u003e\n      \u003cvideo ref={videoElement} /\u003e\n      \u003cVideoCompositor background={videoElement} /\u003e\n    \u003c/Fragment\u003e\n  );\n}\n```\n\n##### Image Path\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"images/background.png\" /\u003e;\n}\n```\n\n##### Video Path\n\n```javascript\nimport React from \"react\";\nimport { VideoCompositor } from \"react-video-compositor\";\n\nexport default function App() {\n  return \u003cVideoCompositor background=\"videos/background.mp4\" /\u003e;\n}\n```\n\n## Bibliography\n\n- https://dannadori.medium.com/virtual-background-with-amazon-chime-sdk-bodypix-23fb59ac8c64\n- https://github.com/FLECT-DEV-TEAM/LocalVideoEffector\n- https://blog.tensorflow.org/2019/11/updated-bodypix-2.html\n- https://blog.logrocket.com/responsive-camera-component-react-hooks/\n- https://github.com/vinooniv/video-bg-blur/blob/master/index.html\n- https://github.com/vinooniv/video-bg-blur/blob/master/js/video.js\n- https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API\n- https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenrosen%2Freact-video-compositor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenrosen%2Freact-video-compositor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenrosen%2Freact-video-compositor/lists"}