summaryrefslogtreecommitdiff
path: root/clutter-gst/clutter-gst-playback.h
blob: ded67de8ac73b689e61b6dc26b03afa07af9ae0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
 * Clutter-GStreamer.
 *
 * GStreamer integration library for Clutter.
 *
 * clutter-gst-player.h - Wrap some convenience functions around playbin2
 *
 * Authored By Damien Lespiau    <damien.lespiau@intel.com>
 *             Lionel Landwerlin <lionel.g.landwerlin@linux.intel.com>
 *             Matthew Allum     <mallum@openedhand.com>
 *             Emmanuele Bassi   <ebassi@linux.intel.com>
 *             Andre Moreira Magalhaes <andre.magalhaes@collabora.co.uk>
 *
 * Copyright (C) 2006 OpenedHand
 * Copyright (C) 2009-2013 Intel Corporation
 * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#if !defined(__CLUTTER_GST_H_INSIDE__) && !defined(CLUTTER_GST_COMPILATION)
#error "Only <clutter-gst/clutter-gst.h> can be include directly."
#endif

#ifndef __CLUTTER_GST_PLAYBACK_H__
#define __CLUTTER_GST_PLAYBACK_H__

#include <glib-object.h>

#include <clutter-gst/clutter-gst-types.h>
#include <gst/gst.h>

G_BEGIN_DECLS

#define CLUTTER_GST_TYPE_PLAYBACK clutter_gst_playback_get_type()

#define CLUTTER_GST_PLAYBACK(obj)                               \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj),                           \
                               CLUTTER_GST_TYPE_PLAYBACK,       \
                               ClutterGstPlayback))

#define CLUTTER_GST_PLAYBACK_CLASS(klass)                   \
  (G_TYPE_CHECK_CLASS_CAST ((klass),                        \
                            CLUTTER_GST_TYPE_PLAYBACK,      \
                            ClutterGstPlaybackClass))

#define CLUTTER_GST_IS_PLAYBACK(obj)                            \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj),                           \
                               CLUTTER_GST_TYPE_PLAYBACK))

#define CLUTTER_GST_IS_PLAYBACK_CLASS(klass)            \
  (G_TYPE_CHECK_CLASS_TYPE ((klass),                    \
                            CLUTTER_GST_TYPE_PLAYBACK))

#define CLUTTER_GST_PLAYBACK_GET_CLASS(obj)                     \
  (G_TYPE_INSTANCE_GET_CLASS ((obj),                            \
                              CLUTTER_GST_TYPE_PLAYBACK,        \
                              ClutterGstPlaybackClass))

typedef struct _ClutterGstPlayback ClutterGstPlayback;
typedef struct _ClutterGstPlaybackClass ClutterGstPlaybackClass;
typedef struct _ClutterGstPlaybackPrivate ClutterGstPlaybackPrivate;

/**
 * ClutterGstPlayback:
 *
 * Implementation of #ClutterGstPlayback that displays media streams
 * using GStreamer.
 *
 * The #ClutterGstPlayback structure contains only private data and
 * should not be accessed directly.
 */
struct _ClutterGstPlayback
{
  GObject parent;

  ClutterGstPlaybackPrivate *priv;
};

/**
 * ClutterGstPlaybackClass:
 * @download_buffering: signal class closure for #ClutterGstPlayback::download-buffering
 *
 * Base class for #ClutterGstPlayback.
 */
struct _ClutterGstPlaybackClass
{
  /*< private >*/
  GObjectClass parent_class;

  /*< public >*/
  /* signals */
  gboolean (* should_buffer)  (ClutterGstPlayback *self,
                                GstQuery *query);
};

GType clutter_gst_playback_get_type (void) G_GNUC_CONST;

ClutterGstPlayback *      clutter_gst_playback_new (void);

void                      clutter_gst_playback_set_uri             (ClutterGstPlayback        *self,
                                                                    const gchar               *uri);
gchar *                   clutter_gst_playback_get_uri             (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_filename        (ClutterGstPlayback        *self,
                                                                    const gchar               *filename);

gchar *                   clutter_gst_playback_get_user_agent      (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_user_agent      (ClutterGstPlayback        *self,
                                                                    const gchar               *user_agent);

ClutterGstSeekFlags       clutter_gst_playback_get_seek_flags      (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_seek_flags      (ClutterGstPlayback        *self,
                                                                    ClutterGstSeekFlags        flags);

ClutterGstBufferingMode   clutter_gst_playback_get_buffering_mode  (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_buffering_mode  (ClutterGstPlayback        *self,
                                                                    ClutterGstBufferingMode    mode);
gdouble                   clutter_gst_playback_get_buffer_fill     (ClutterGstPlayback        *self);
gint                      clutter_gst_playback_get_buffer_size     (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_buffer_size     (ClutterGstPlayback        *self,
                                                                    gint                       size);
gint64                    clutter_gst_playback_get_buffer_duration (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_buffer_duration (ClutterGstPlayback        *self,
                                                                    gint64                     duration);

GList *                   clutter_gst_playback_get_audio_streams   (ClutterGstPlayback        *self);
gint                      clutter_gst_playback_get_audio_stream    (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_audio_stream    (ClutterGstPlayback        *self,
                                                                    gint                       index_);

void                      clutter_gst_playback_set_subtitle_uri    (ClutterGstPlayback        *self,
                                                                    const gchar               *uri);
gchar *                   clutter_gst_playback_get_subtitle_uri    (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_subtitle_font_name
                                                                   (ClutterGstPlayback        *self,
                                                                    const char                *font_name);
gchar *                   clutter_gst_playback_get_subtitle_font_name
                                                                   (ClutterGstPlayback        *self);
GList *                   clutter_gst_playback_get_subtitle_tracks (ClutterGstPlayback        *self);
gint                      clutter_gst_playback_get_subtitle_track  (ClutterGstPlayback        *self);
void                      clutter_gst_playback_set_subtitle_track  (ClutterGstPlayback        *self,
                                                                    gint                       index_);

gboolean                  clutter_gst_playback_get_in_seek         (ClutterGstPlayback        *self);

void                      clutter_gst_playback_set_progress        (ClutterGstPlayback        *self,
                                                                    gdouble                    progress);
gdouble                   clutter_gst_playback_get_progress        (ClutterGstPlayback        *self);
gdouble                   clutter_gst_playback_get_position        (ClutterGstPlayback        *self);
gdouble                   clutter_gst_playback_get_duration        (ClutterGstPlayback        *self);

gboolean                  clutter_gst_playback_is_live_media       (ClutterGstPlayback        *self);

G_END_DECLS

#endif /* __CLUTTER_GST_PLAYBACK_H__ */