GStreamer multimedia framework
Find a file
2016-10-27 14:16:43 +02:00
attachments Remove unused attachments 2016-09-16 16:50:38 -04:00
examples Use basic-tutorial-1.c from tutorials subdirectory 2016-10-09 15:28:12 +02:00
extra_theme Provide a favicon 2016-10-27 14:01:11 +02:00
hotdoc_bootstrap_theme@9318352ec6 Update theme submodule 2016-10-27 14:16:43 +02:00
images Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
less Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
tutorials iOS tutorials: Enable SSL for 4 & 5 2016-10-24 20:12:25 -04:00
.gitignore Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
.gitmodules Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
basic-media-player.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
building-from-source-using-cerbero.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
deploying-mac-osx.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
deploying-multiplatform-using-cerbero.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
deploying-windows.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
deploying-your-application.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
gstreamer-command-line-tools.md Rename API reference with "command line tools" 2016-06-15 14:20:42 -04:00
hotdoc.json Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
index.md Remove SDK legal info for now 2016-10-19 16:41:49 -04:00
installing-for-android-development.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
installing-for-ios-development.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
installing-on-linux.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
installing-on-mac-osx.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
installing-on-windows.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
installing.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
legal-information.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
Makefile Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
manual-advanced.md Application development manual 2016-06-04 16:13:35 +02:00
manual-appendices.md Application development manual 2016-06-04 16:13:35 +02:00
manual-autoplugging.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-bins.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-buffering.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-building.md Application development manual 2016-06-04 16:13:35 +02:00
manual-bus.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-checklist-element.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-clocks.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-compiling.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-data.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-dataaccess.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-dparams.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-elements.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-gstreamer.md reviewed the legal information 2016-06-15 21:41:27 -04:00
manual-helloworld.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-highlevel.md Application development manual 2016-06-04 16:13:35 +02:00
manual-index.md Remove spurious version numbers 2016-10-06 16:32:28 -04:00
manual-init.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-integration.md Rename intgration to integration 2016-09-16 17:01:30 -04:00
manual-interfaces.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-intro-basics.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-introduction.md Application development manual 2016-06-04 16:13:35 +02:00
manual-licensing.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-metadata.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-motivation.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-pads.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-playback-components.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-porting-1.0.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-porting.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-programs.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-queryevents.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
manual-quotes.md Application development manual 2016-06-04 16:13:35 +02:00
manual-threads.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-clock.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-events.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-interfaces.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-qos.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-request.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced-tagging.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-advanced.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-allocation.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-appendix.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-building-args.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-boiler.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-building-chainfn.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-eventfn.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-pads.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-queryfn.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-signals.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-building-testapp.md Add missing language tags to code blocks 2016-06-05 21:50:32 -04:00
pwg-building-types.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-building.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-checklist-element.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-dparams.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-index.md Remove some redundancy 2016-06-04 16:14:36 +02:00
pwg-intro-basics.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-intro-preface.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-introduction.md Remove spurious version numbers 2016-10-06 16:32:28 -04:00
pwg-licensing-advisory.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-negotiation.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-other-base.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-other-manager.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-other-ntoone.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-other-oneton.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-other.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-porting-1_0.md Plugin writer's guide 2016-06-04 16:11:52 +02:00
pwg-porting.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-scheduling.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
pwg-statemanage-states.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
qt-gstreamer-vs-c-gstreamer.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
README README: add instructions for arch linux 2016-10-26 13:49:17 -03:00
rtp.md rtp: Move from website to docs 2016-10-18 18:47:02 -04:00
sitemap.txt Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
splitup.md splitup: Move from website to docs 2016-10-18 18:36:08 -04:00
table-of-concepts.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
TODO.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tool-ges-launch.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tool-gst-inspect.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tool-gst-launch.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-android-a-complete-media-player.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-android-a-running-pipeline.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-android-link-against-gstreamer.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-android-media-player.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-android-video.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-concepts.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-debugging-tools.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-dynamic-pipelines.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-gstreamer-tools.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-handy-elements.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-hello-world.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-media-formats-and-pad-capabilities.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-media-information-gathering.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-multithreading-and-pad-availability.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-platform-specific-elements.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-playback-speed.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-short-cutting-the-pipeline.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-streaming.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-time-management.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-basic-toolkit-integration.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-ios-a-basic-media-player.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-ios-a-complete-media-player.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-ios-a-running-pipeline.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-ios-link-against-gstreamer.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-ios-video.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-audio-visualization.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-color-balance.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-custom-playbin-sinks.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-digital-audio-pass-through.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-hardware-accelerated-video-decoding.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-playbin-usage.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-progressive-streaming.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-short-cutting-the-pipeline.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-playback-subtitle-management.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorial-qt-tutorials.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorials-android.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorials-basic.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorials-ios.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorials-playback.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
tutorials.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00
using-appsink-appsrc-in-qt.md Remove all reference to the SDK in pages names 2016-10-26 14:01:37 -03:00

# Introduction

This is a collection of design documents, formerly maintained in various
different locations and formats, now grouped together and converted
to commonmark.

# Contributing

## Style

We will follow the commonmark specification.

We *should* try to follow this
[style guide](http://www.cirosantilli.com/markdown-style-guide/#about),
but are still [evaluating solutions](https://github.com/jgm/cmark/issues/131)
for *stable* automatic formatting.

80 columns line width is thus not yet enforced, but strongly suggested.

# Build a web portal from the sources

## Install dependencies

* Follow [hotdoc's installation guide](https://people.collabora.com/~meh/hotdoc_hotdoc/html/installing.html),
  preferably in a virtualenv.

* We *experimentally* use the hotdoc C extension to include functions by
  name, follow the steps outlined [here](https://github.com/hotdoc/hotdoc_c_extension)

* We recompile and override hotdoc's default theme, which is a submodule of this project:

```
git submodule update --init
```

Follow the instructions outlined in the theme's README.md, you can dispense
with the last step (building the theme):

```
cd hotdoc_bootstrap_theme
sudo dnf install nodejs # On Fedora
sudo apt-get install nodejs nodejs-legacy npm # debian
sudo pacman -S nodejs npm# arch
npm install && ./node_modules/bower/bin/bower install
cd ..
```

* Build the portal:

```
make
```

* And browse it:

```
xdg-open build/html/index.html
```