← Back to branch summary

~ubuntu-branches/ubuntu/saucy/qt-gstreamer/saucy-proposed

« back to all changes in this revision

Viewing changes to examples/examples.dox

  • Committer: Package Import Robot
  • Author(s): Felix Geyer
  • Date: 2012-06-15 15:03:26 UTC
  • mfrom: (1.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20120615150326-pkmdog620pkytcgt
Tags: 0.10.2-2ubuntu1
* Merge from Debian unstable, remaining changes:
  - Enable unit tests.
    + Build-depend on gstreamer0.10-plugins-base.

Show diffs side-by-side

added added

removed removed

Lines of Context:
examples/examples.dox
10
10
    This program is distributed in the hope that it will be useful,
11
11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
    GNU General Public License for more details.
 
13
    GNU Lesser General Public License for more details.
14
14
 
15
15
    You should have received a copy of the GNU Lesser General Public License
16
16
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
17
*/
18
18
 
19
 
/*! \example player/main.cpp
 
19
/*! \example examples/player/main.cpp
20
20
 * This is an example audio/video player using QtGStreamer.
21
21
 *
22
22
 * In this example, the GStreamer playbin2 element is used to perform most
25
25
 * and duration of the stream, performing seeking, etc...
26
26
 *
27
27
 * player.h:
28
 
 * \include player/player.h
 
28
 * \include examples/player/player.h
29
29
 *
30
30
 * player.cpp:
31
 
 * \include player/player.cpp
 
31
 * \include examples/player/player.cpp
32
32
 *
33
33
 * mediaapp.h:
34
 
 * \include player/mediaapp.h
 
34
 * \include examples/player/mediaapp.h
35
35
 *
36
36
 * mediaapp.cpp:
37
 
 * \include player/mediaapp.cpp
 
37
 * \include examples/player/mediaapp.cpp
38
38
 *
39
39
 * main.cpp:
40
40
 */
41
41
 
42
 
/*! \example appsink-src/main.cpp
 
42
/*! \example examples/appsink-src/main.cpp
43
43
 * This example demonstrates how to use QGst::Utils::ApplicationSource and
44
44
 * QGst::Utils::ApplicationSink to create a custom source and sink respectively.
45
45
 *
52
52
 * audio player.
53
53
 */
54
54
 
55
 
/*! \example recorder/main.cpp
 
55
/*! \example examples/recorder/main.cpp
56
56
 * This is a recording application that takes audio from a microphone
57
57
 * and video from either a camera or the X11 screen, encodes them with
58
58
 * theora and speex and saves the result in a file.
69
69
 * \li How to handle bus messages.
70
70
 * \li Others...
71
71
 */
 
72
 
 
73
/*! \example examples/voip/main.cpp
 
74
 * This is a simple VoIP application that takes audio from a microphone and
 
75
 * video from the video test source, encodes them with speex and h264 respectively
 
76
 * and sends them to the other side using RTP.
 
77
 *
 
78
 * The same application is both a client and a server. To make a call between them,
 
79
 * you need to configure the destination ports of the one side to be the source
 
80
 * ports of the other and vice versa.
 
81
 */
 
82
 
 
83
/*! \example examples/qmlplayer/main.cpp
 
84
 * This example demonstrates how to paint video on QML.
 
85
 *
 
86
 * Much of the code here is borrowed from the player example and it is not generally
 
87
 * a good example on how to write QML and connect it with C++. The intention is just
 
88
 * to demonstrate the use of QGst::Ui::GraphicsVideoSurface, which is bound on the
 
89
 * QML context and then used by the VideoItem.
 
90
 *
 
91
 * qmlplayer.qml:
 
92
 * \include examples/qmlplayer/qmlplayer.qml
 
93
 *
 
94
 * player.h:
 
95
 * \include examples/qmlplayer/player.h
 
96
 *
 
97
 * player.cpp:
 
98
 * \include examples/qmlplayer/player.cpp
 
99
 *
 
100
 * main.cpp:
 
101
 */