Skip to content

membraneframework/membrane_sdl_plugin

Repository files navigation

Membrane SDL plugin

Hex.pm API Docs CircleCI

This package provides an SDL-based video player.

It is part of Membrane Multimedia Framework.

Documentation is available at HexDocs.

Installation

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

def deps do
  [
    {:membrane_sdl_plugin, "~> 0.18.4"}
  ]
end

This package depends on the SDL2 library. The precompiled build will be pulled and linked automatically. However, should there be any problems, consider installing it manually. In the case of development mode, you need to install FFmpeg on your system.

Manual instalation of dependencies

Ubuntu

sudo apt-get install sdl2

Arch/Manjaro

pacman -S sdl2

MacOS

brew install sdl2

Usage

Usage example can be found in examples/player.exs. This example demonstrates how to play a H264 video, downloaded in real-time from Membrane's static repository over HTTP.

To run it, simply execute the following command in your terminal:

$ elixir examples/player.exs

Testing

To run manual tests, type mix test --include manual

Copyright and License

Copyright 2019, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0