View Source Membrane PortAudio plugin

Hex.pm API Docs CircleCI

The plugin that captures and plays sound using the multiplatform PortAudio library.

installation

Installation

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

	{:membrane_portaudio_plugin, "~> 0.16.2"}

You also need to have PortAudio installed. For Mac OS you can install it via Homebrew: brew install portaudio, on Debian via apt-get: apt-get install portaudio19-dev.

sample-usage

Sample usage

The pipeline below should play a raw file to a default output device.

defmodule Membrane.ReleaseTest.Pipeline do
  use Membrane.Pipeline

  alias Membrane.PortAudio

  @impl true
  def handle_init(_ctx, _opts) do
    structure = 
      child(:file_src, %Membrane.Element.File.Source{location: "file.raw"})
      |> child(:pa_sink, PortAudio.Sink)
    
    {[spec: structure], %{}}
  end
end

And this one should forward sound from the default input to the default output. DO NOT USE WITHOUT HEADPHONES to avoid audio feedback.

defmodule Membrane.ReleaseTest.Pipeline do
  use Membrane.Pipeline

  alias Membrane.PortAudio

  @impl true
  def handle_init(_ctx, _opts) do
    structure =
      child(:pa_src, PortAudio.Source)
      |> child(:pa_sink, PortAudio.Sink)

    {[spec: structure], %{}}
  end
end

testing

Testing

Tests contain some cases that use PortAudio stuff instead of mocking. Such cases require the presence of at least one input and output sound card, thus they are disabled by default. To enable them, run

mix test --include soundcard

Copyright 2018, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0