DesktopStreamer

Capture A/V from the desktop and stream it to the local network.


License
GPL-3.0
Install
pip install DesktopStreamer==0.7

Documentation

Desktop Streamer

Capture audio and video from the desktop and stream it to the local network using avconv and vlc.

Python Script

You can just run the python module and - if you install this package - you could also start the provided script from the console or your desktop shell.

Usage

Start the package like this python -m desktopstreamer [options]. Or use the startup script like this:

stream_desktop [-n|--gui] [-a|-A] [capture options] [stream options]
stream_desktop --version
stream_desktop --help

To use it in your desktop shell, a .desktop file is provided.

Install

The easiest way to install this package is trough pip:

pip install --user desktopstreamer

Or download the latest source (or get it trough git clone ...) and install it like this (from the sources root directory):

python setup.py install --user

Dependencies

You don't need to install any Python dependencies.

Requirements

avconv and vlc are required though. Install them like this:

  • Debian / Ubuntu: sudo apt-get install libav-tools vlc

Setup

You can use the provided .desktop file and icon from the data/ directory to start the script from your desktop shell.

Settings

You can use a file to store the settings in a JSON dictionary.

The default location is ~/.config/DesktopStreamer/settings.json. The supported keys are the capture and stream long-options (with _ instead of -).

To store settings in this file, use the --save option. If you use it, the current settings are stored and previous settings are overwritten. You can create and edit it manually too.

Here's some example content:

{
  "port": 420,
  "res_out": "1280x720"
}

The settings from this file are applied, if you use the --load option.

Note

The provided .desktop file uses the --load option automatically each time.

Shell Script

You can source the data/stream_desktop.sh in your .bash_aliases or similar to get a quick stream_desktop command. The python script has more options though.

Contribute

If you find any bugs, have feature ideas or similar, just use the issue tracker on github.