libpurple/media/backend-fs2.h

Wed, 05 Feb 2014 21:42:07 +0530

author
Ankit Vani <a@nevitus.org>
date
Wed, 05 Feb 2014 21:42:07 +0530
branch
soc.2013.gobjectification.plugins
changeset 37071
3ebf3bb2d317
parent 37058
04ebc4a2fac7
parent 35462
901dfa763f15
child 37094
84873ce721dc
permissions
-rw-r--r--

Merge gtkdoc-conversion

29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
1 /* purple
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
2 *
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
3 * Purple is the legal property of its developers, whose names are too numerous
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
4 * to list here. Please refer to the COPYRIGHT file distributed with this
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
5 * source distribution.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
6 *
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
7 * This program is free software; you can redistribute it and/or modify
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
8 * it under the terms of the GNU General Public License as published by
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
10 * (at your option) any later version.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
11 *
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful,
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
15 * GNU General Public License for more details.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
16 *
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
18 * along with this program; if not, write to the Free Software
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
20 */
35462
901dfa763f15 Fix some gtk-doc warnings till proxy.c
Ankit Vani <a@nevitus.org>
parents: 35436
diff changeset
21 /*
35431
65668e608813 Add section blocks for libpurple/media/*.h
Ankit Vani <a@nevitus.org>
parents: 35396
diff changeset
22 * SECTION:backend-fs2
65668e608813 Add section blocks for libpurple/media/*.h
Ankit Vani <a@nevitus.org>
parents: 35396
diff changeset
23 * @section_id: libpurple-backend-fs2
35436
a69d2e5604c5 Swap @title and @short_description roles
Ankit Vani <a@nevitus.org>
parents: 35431
diff changeset
24 * @short_description: <filename>media/backend-fs2.h</filename>
a69d2e5604c5 Swap @title and @short_description roles
Ankit Vani <a@nevitus.org>
parents: 35431
diff changeset
25 * @title: Farsight 2 backend for media API
35462
901dfa763f15 Fix some gtk-doc warnings till proxy.c
Ankit Vani <a@nevitus.org>
parents: 35436
diff changeset
26 *
29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
27 * This file should not yet be part of libpurple's API.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
28 * It should remain internal only for now.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
29 */
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
30
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
31 #ifndef _MEDIA_BACKEND_FS2_H_
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
32 #define _MEDIA_BACKEND_FS2_H_
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
33
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
34 #include <glib-object.h>
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
35
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
36 G_BEGIN_DECLS
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
37
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
38 #define PURPLE_TYPE_MEDIA_BACKEND_FS2 (purple_media_backend_fs2_get_type())
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
39 #define PURPLE_IS_MEDIA_BACKEND_FS2(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2))
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
40 #define PURPLE_IS_MEDIA_BACKEND_FS2_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_BACKEND_FS2))
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
41 #define PURPLE_MEDIA_BACKEND_FS2(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
42 #define PURPLE_MEDIA_BACKEND_FS2_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
43 #define PURPLE_MEDIA_BACKEND_FS2_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
44
35396
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
45 /**
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
46 * PurpleMediaBackendFs2:
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
47 *
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
48 * An opaque structure representing the Farsight 2 media backend.
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
49 */
29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
50 typedef struct _PurpleMediaBackendFs2 PurpleMediaBackendFs2;
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
51
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
52 /**
35396
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
53 * purple_media_backend_fs2_get_type:
7bfe75a37af7 Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
54 *
29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
55 * Gets the type of the Farsight 2 media backend object.
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
56 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 32438
diff changeset
57 * Returns: The Farsight 2 media backend's GType
29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
58 */
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
59 GType purple_media_backend_fs2_get_type(void);
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
60
30340
a3fb5b7d9d0b Apply Polynomial-C's suggestion for fixing a compile error with
Mark Doliner <markdoliner@pidgin.im>
parents: 29606
diff changeset
61 #ifdef USE_GSTREAMER
29564
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
62 /*
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
63 * Temporary function in order to be able to test while
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
64 * integrating with PurpleMedia
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
65 */
29606
57c482f5d1c1 Remove references to FsStream in PurpleMedia.
Michael Ruprecht <maiku@pidgin.im>
parents: 29605
diff changeset
66 #include <gst/gst.h>
29599
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
67 GstElement *purple_media_backend_fs2_get_src(
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
68 PurpleMediaBackendFs2 *self,
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
69 const gchar *sess_id);
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
70 GstElement *purple_media_backend_fs2_get_tee(
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
71 PurpleMediaBackendFs2 *self,
24e1d49a6fce Move all src and sink creation in PurpleMedia to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29598
diff changeset
72 const gchar *sess_id, const gchar *who);
29601
fb1168d4ee6b Move volume setting functionality to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29600
diff changeset
73 void purple_media_backend_fs2_set_input_volume(PurpleMediaBackendFs2 *self,
fb1168d4ee6b Move volume setting functionality to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29600
diff changeset
74 const gchar *sess_id, double level);
fb1168d4ee6b Move volume setting functionality to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29600
diff changeset
75 void purple_media_backend_fs2_set_output_volume(PurpleMediaBackendFs2 *self,
fb1168d4ee6b Move volume setting functionality to the Fs2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents: 29600
diff changeset
76 const gchar *sess_id, const gchar *who, double level);
29564
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
77 /* end tmp */
30340
a3fb5b7d9d0b Apply Polynomial-C's suggestion for fixing a compile error with
Mark Doliner <markdoliner@pidgin.im>
parents: 29606
diff changeset
78 #endif /* USE_GSTREAMER */
29564
fa76e21160fd Various tweaks, fixes, and added debug output. Attached some media signals,
Michael Ruprecht <maiku@pidgin.im>
parents: 29556
diff changeset
79
29556
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
80 G_END_DECLS
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
81
ebf1af169279 Skeleton of the Farsight 2 media backend.
Michael Ruprecht <maiku@pidgin.im>
parents:
diff changeset
82 #endif /* _MEDIA_BACKEND_FS2_H_ */

mercurial