GStreamer multimedia framework
Find a file
2016-10-19 16:05:26 -04: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 Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
hotdoc_bootstrap_theme@c1fc1c9b3d Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
images Update Android screenshots 2016-10-06 15:21:55 -04:00
less Implement our own theme, yay! 2016-10-16 01:53:38 +02:00
tutorials move tutorials to root 2016-10-09 15:24:09 +02: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
ges-launch.md Rename API reference with "command line tools" 2016-06-15 14:20:42 -04:00
gst-inspect.md gst-inspect.md: Correct env variable name 2016-06-17 17:22:33 -04:00
gst-launch.md Fix hotdoc warnings 2016-10-06 16:30:24 -04: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 Merge licensing information from website into docs. 2016-10-19 16:05:26 -04: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
README README: add instructions for debian 2016-10-19 07:04:16 +01:00
rtp.md rtp: Move from website to docs 2016-10-18 18:47:02 -04:00
sdk-android-tutorial-a-complete-media-player.md Finish updating Android tutorials: 2016-06-16 20:01:54 -04:00
sdk-android-tutorial-a-running-pipeline.md Update Android screenshots 2016-10-06 15:21:55 -04:00
sdk-android-tutorial-link-against-gstreamer.md Finish updating Android tutorials: 2016-06-16 20:01:54 -04:00
sdk-android-tutorial-media-player.md Update header levels 2016-10-09 16:49:29 +02:00
sdk-android-tutorial-video.md Fix link 2016-10-06 15:24:14 -04:00
sdk-android-tutorials.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-basic-media-player.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
sdk-basic-tutorial-concepts.md Fix code block language tagging 2016-06-05 21:16:51 -04:00
sdk-basic-tutorial-debugging-tools.md Rename picture 2016-06-17 15:47:44 -04:00
sdk-basic-tutorial-dynamic-pipelines.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorial-gstreamer-tools.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorial-handy-elements.md Replace gstreamer.com uri with freedesktop 2016-09-15 16:19:28 -04:00
sdk-basic-tutorial-hello-world.md hello world: Close code section 2016-10-09 15:31:08 +02:00
sdk-basic-tutorial-media-formats-and-pad-capabilities.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorial-media-information-gathering.md Replace gstreamer.com uri with freedesktop 2016-09-15 16:19:28 -04:00
sdk-basic-tutorial-multithreading-and-pad-availability.md Update the last basic tutorials 2016-06-15 20:00:24 -04:00
sdk-basic-tutorial-platform-specific-elements.md Fix more links to old html filenames 2016-06-17 15:49:34 -04:00
sdk-basic-tutorial-playback-speed.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorial-short-cutting-the-pipeline.md Update the last basic tutorials 2016-06-15 20:00:24 -04:00
sdk-basic-tutorial-streaming.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorial-time-management.md Replace gstreamer.com uri with freedesktop 2016-09-15 16:19:28 -04:00
sdk-basic-tutorial-toolkit-integration.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-basic-tutorials.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-building-from-source-using-cerbero.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-deploying-your-application.md Update deploying sections 2016-06-17 17:20:43 -04:00
sdk-installing-for-android-development.md Comment out Android Studio reference until we port the examples 2016-09-15 16:11:25 -04:00
sdk-installing-for-ios-development.md Update iOS/OS X info 2016-09-16 16:45:24 -04:00
sdk-installing-on-linux.md Update the installing on Linux page 2016-10-09 14:33:39 +02:00
sdk-installing-on-mac-osx.md Update iOS/OS X info 2016-09-16 16:45:24 -04:00
sdk-installing-on-windows.md windows: We also support Windows 10 2016-10-09 17:13:23 +02:00
sdk-installing.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-ios-tutorial-a-basic-media-player.md Replace gstreamer.com uri with freedesktop 2016-09-15 16:19:28 -04:00
sdk-ios-tutorial-a-complete-media-player.md Updated iOS tutorials 2016-06-17 15:32:33 -04:00
sdk-ios-tutorial-a-running-pipeline.md Updated iOS tutorials 2016-06-17 15:32:33 -04:00
sdk-ios-tutorial-link-against-gstreamer.md Updated iOS tutorials 2016-06-17 15:32:33 -04:00
sdk-ios-tutorial-video.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
sdk-ios-tutorials.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-legal-information.md Merge licensing information from website into docs. 2016-10-19 16:05:26 -04:00
sdk-mac-osx-deployment.md Update deploying sections 2016-06-17 17:20:43 -04:00
sdk-multiplatform-deployment-using-cerbero.md Remove spurious version numbers 2016-10-06 16:32:28 -04:00
sdk-playback-tutorial-audio-visualization.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-playback-tutorial-color-balance.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-playback-tutorial-custom-playbin-sinks.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-playback-tutorial-digital-audio-pass-through.md Update all playback tutorials 2016-06-15 21:27:41 -04:00
sdk-playback-tutorial-hardware-accelerated-video-decoding.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
sdk-playback-tutorial-playbin-usage.md playback: you can call playbin playbin 2016-10-19 07:15:59 +01:00
sdk-playback-tutorial-progressive-streaming.md Fix hotdoc warnings 2016-10-06 16:30:24 -04:00
sdk-playback-tutorial-short-cutting-the-pipeline.md Update all playback tutorials 2016-06-15 21:27:41 -04:00
sdk-playback-tutorial-subtitle-management.md Replace gstreamer.com uri with freedesktop 2016-09-15 16:19:28 -04:00
sdk-playback-tutorials.md Update all playback tutorials 2016-06-15 21:27:41 -04:00
sdk-qt-gstreamer-vs-c-gstreamer.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
sdk-qt-tutorials.md Remove last GStreamer.com references 2016-09-15 16:17:55 -04:00
sdk-table-of-concepts.md Remove ref to non-existing gst-inspect.md 2016-10-06 15:27:04 -04:00
sdk-tutorials.md Remove most mentions of the SDK 2016-06-17 18:21:42 -04:00
sdk-using-appsink-appsrc-in-qt.md Avoid having several 'h1' title per page 2016-06-17 18:42:07 -04:00
sdk-windows-deployment.md Update deploying sections 2016-06-17 17:20:43 -04:00
sitemap.txt rtp: Move from website to docs 2016-10-18 18:47:02 -04:00
splitup.md splitup: Move from website to docs 2016-10-18 18:36:08 -04:00
TODO.md TODO: Cleanup 2016-10-09 18:50:24 +02: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
npm install && ./node_modules/bower/bin/bower install
cd ..
```

* Build the portal:

```
make
```

* And browse it:

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