Merged pidgin/main into default
[pidgin-git.git] / libpurple / media / backend-fs2.h
blob1aa31c1f9befd77c6763ca821c24e069aaed1a0f
1 /* purple
3 * Purple is the legal property of its developers, whose names are too numerous
4 * to list here. Please refer to the COPYRIGHT file distributed with this
5 * source distribution.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
22 #ifndef _MEDIA_BACKEND_FS2_H_
23 #define _MEDIA_BACKEND_FS2_H_
25 * SECTION:backend-fs2
26 * @section_id: libpurple-backend-fs2
27 * @short_description: <filename>media/backend-fs2.h</filename>
28 * @title: Farstream backend for media API
30 * This file should not yet be part of libpurple's API.
31 * It should remain internal only for now.
34 #include <glib-object.h>
36 G_BEGIN_DECLS
38 #define PURPLE_TYPE_MEDIA_BACKEND_FS2 (purple_media_backend_fs2_get_type())
39 #define PURPLE_IS_MEDIA_BACKEND_FS2(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2))
40 #define PURPLE_IS_MEDIA_BACKEND_FS2_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_BACKEND_FS2))
41 #define PURPLE_MEDIA_BACKEND_FS2(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
42 #define PURPLE_MEDIA_BACKEND_FS2_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
43 #define PURPLE_MEDIA_BACKEND_FS2_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_BACKEND_FS2, PurpleMediaBackendFs2))
45 /**
46 * PurpleMediaBackendFs2:
48 * An opaque structure representing the Farstream media backend.
50 typedef struct _PurpleMediaBackendFs2 PurpleMediaBackendFs2;
52 /**
53 * purple_media_backend_fs2_get_type:
55 * Gets the type of the Farstream media backend object.
57 * Returns: The Farstream media backend's GType
59 GType purple_media_backend_fs2_get_type(void);
62 * Temporary function in order to be able to test while
63 * integrating with PurpleMedia
65 #include <gst/gst.h>
66 GstElement *purple_media_backend_fs2_get_src(
67 PurpleMediaBackendFs2 *self,
68 const gchar *sess_id);
69 GstElement *purple_media_backend_fs2_get_tee(
70 PurpleMediaBackendFs2 *self,
71 const gchar *sess_id, const gchar *who);
72 void purple_media_backend_fs2_set_input_volume(PurpleMediaBackendFs2 *self,
73 const gchar *sess_id, double level);
74 void purple_media_backend_fs2_set_output_volume(PurpleMediaBackendFs2 *self,
75 const gchar *sess_id, const gchar *who, double level);
76 /* end tmp */
78 G_END_DECLS
80 #endif /* _MEDIA_BACKEND_FS2_H_ */