https://github.com/membraneframework/membrane_camera_capture_plugin

A set of elements allowing for capturing local media such as camera or microphone
https://github.com/membraneframework/membrane_camera_capture_plugin

Last synced: 2 days ago
JSON representation

A set of elements allowing for capturing local media such as camera or microphone

• Host: GitHub
• URL: https://github.com/membraneframework/membrane_camera_capture_plugin
• Owner: membraneframework
• License: apache-2.0
• Created: 2022-01-12T09:21:45.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-14T10:18:01.000Z (11 months ago)
• Last Synced: 2024-03-14T14:03:00.257Z (8 months ago)
• Language: Elixir
• Size: 76.2 KB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Membrane Camera Capture Plugin

[![Hex.pm](https://img.shields.io/hexpm/v/membrane_camera_capture_plugin.svg)](https://hex.pm/packages/membrane_camera_capture_plugin)

[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/membrane_camera_capture_plugin)

[![CircleCI](https://circleci.com/gh/membraneframework/membrane_camera_capture_plugin.svg?style=svg)](https://circleci.com/gh/membraneframework/membrane_camera_capture_plugin)

This plugin can be used to capture video stream from an input device.

It is part of [Membrane Multimedia Framework](https://membraneframework.org).

## Installation

Add the following line to your `deps` in `mix.exs`. Run `mix deps.get`.

```elixir

	{:membrane_camera_capture_plugin, "~> 0.7.2"}

```

This package depends on the [ffmpeg](https://www.ffmpeg.org) libraries. The precompiled builds will be pulled and linked automatically. However, should there be any problems, consider installing it manually.

### Manual installation of dependencies

#### Ubuntu

```bash

sudo apt-get install ffmpeg

```

#### Arch/Manjaro

```bash

pacman -S ffmpeg

```

#### MacOS

```bash

brew install ffmpeg

```

## Sample Usage

This example displays the stream from your camera on the screen:

```elixir

Logger.configure(level: :info)

Mix.install([

  {:membrane_camera_capture_plugin, "~> 0.7.1"},

  :membrane_h264_ffmpeg_plugin,

  :membrane_ffmpeg_swscale_plugin,

  :membrane_sdl_plugin

])

defmodule Example do

  use Membrane.Pipeline

  @impl true

  def handle_init(_ctx, _options) do

    spec =

      child(Membrane.CameraCapture)

      |> child(%Membrane.FFmpeg.SWScale.PixelFormatConverter{format: :I420})

      |> child(Membrane.SDL.Player)

    {[spec: spec], %{}}

  end

end

Membrane.Pipeline.start_link(Example)

Process.sleep(:infinity)

```

## Testing

To run manual tests, you need to install dependencies:

```shell

$ mix deps.get

```

And run manual (you observe the result and decide whether it works) tests:

```shell

$ mix test --include manual

```

If it runs successfully, you should be able to see video from your camera.

_You might be asked to grant access to your camera, as some operating systems require that_

_In case of the absence of a physical camera, it is necessary to use a virtual camera (e.g. OBS, [see how to set up the virtual camera in OBS](https://obsproject.com/kb/virtual-camera-guide))_

## Copyright and License

Copyright 2022, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_camera_capture_plugin)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_camera_capture_plugin)

Licensed under the [Apache License, Version 2.0](LICENSE)