Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matthew1000/gstreamer-cheat-sheet

Gstreamer command-line cheat sheet
https://github.com/matthew1000/gstreamer-cheat-sheet

Last synced: 26 days ago
JSON representation

Gstreamer command-line cheat sheet

Awesome Lists containing this project

README 

        
# GStreamer command-line cheat sheet



[GStreamer](https://gstreamer.freedesktop.org/) is a powerful library for manipulating audio and video - including live streams. This repo provides:



*  a cheat sheet for GStreamer on the command-line, and

*  a few [Python examples](python_examples/). 



Whilst the command line is great, programmatic usage (in Python or another language) allows you to dynamically manipulate the A/V streams.



## Contents



* [Installing](installing.md)

* [Basics](basics.md)

* [Test streams](test_streams.md)

* [RTMP](rtmp.md)

* [Mixing video & audio](mixing.md)

* [Images](images.md)

* [Queues](queues.md)

* [Writing to files](writing_to_files.md)

* [Sending to multiple destinations (tee)](tee.md)

* [Sharing and receiving pipelines (including sending/receiving video from shared memory)](sharing_and_splitting_pipelines.md)

* [Network transfer](network_transfer.md) (including how to send so that VLC can preview)

* [RTP](rtp.md)

* [SRT](srt.md)



## Sources and references



* [Basic command line reference](https://gstreamer.freedesktop.org/documentation/tutorials/basic/gstreamer-tools.html?gi-language=c)

* [Pipeline examples](https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html#pipeline-examples)

* [List of all Gstreamer plugins](https://gstreamer.freedesktop.org/documentation/plugins_doc.html?gi-language=c)

* [Handy elements](https://gstreamer.freedesktop.org/documentation/tutorials/basic/handy-elements.html#uridecodebin)



## Other cheat-sheets



* 

* 



## Interacting with the GStreamer pipeline



If you want to interact with GStreamer after it's started (e.g. respond to an event, or dynamically change a pipeline), the command-line GStreamer doesn't really cut it. Instead, here are some options:



* *[GStreamer Daemon (gstd)](https://github.com/RidgeRun/gstd-1.x)* - allows setting and updating via a TCP connection

* *[Snowmix](http://snowmix.sourceforge.net/)* - an open-source live video mixer

* *Develop using the GStreamer library*, in either [C](https://gstreamer.freedesktop.org/documentation/application-development/basics/helloworld.html), [Python](https://github.com/GStreamer/gst-python), or [C#/.NET](https://github.com/GStreamer/gstreamer-sharp)



### Python with GStreamer



Python is an easy language, so it's no surprise that it's good way to develop using GStreamer.



Some example scripts can be found in the [python_examples/](python_examples/) directory.



Other good GStreamer Python resources that I've found:



* [Getting started with GStreamer with Python](https://www.jonobacon.com/2006/08/28/getting-started-with-gstreamer-with-python/)

* [Python GStreamer Tutorial](http://brettviren.github.io/pygst-tutorial-org/pygst-tutorial.html)

* [Function reference](http://lazka.github.io/pgi-docs/#Gst-1.0)

 * Including a useful [mapping from C](https://lazka.github.io/pgi-docs/Gst-1.0/mapping.html)

* [Nice example script](https://github.com/rabits/rstream/blob/master/rstream.py)



### C/C++ with GStreamer



My favourite reference is [Valadoc](https://valadoc.org/gstreamer-1.0/index.htm)



# Problems or suggestions with this guide?



If you spot anything incorrect or incomplete, reports are welcome, either using [issues](issues) or [pull requests](pulls)



# My GStreamer project



Creating this guide gave me enough GStreamer understanding to make a prototype [Brave](https://github.com/bbc/brave), a live video editor for the cloud. (Regrettably this prototype has not been updated in a few years.)