/usr/include/gstreamermm-1.0/gstreamermm/appsink.h is in libgstreamermm-1.0-dev 1.10.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | // Generated by gmmproc 2.50.1 -- DO NOT MODIFY!
#ifndef _GSTREAMERMM_APPSINK_H
#define _GSTREAMERMM_APPSINK_H
#include <gstreamermmconfig.h>
#ifndef GSTREAMERMM_DISABLE_DEPRECATED
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// Generated by generate_plugin_gmmproc_file. Don't edit this file.
#include <gstreamermm/basesink.h>
#include <gstreamermm/caps.h>
#include <gstreamermm/pad.h>
#include <gstreamermm/sample.h>
#include <gstreamermm/urihandler.h>
// Plug-in C enums used in signals:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GstAppSink = struct _GstAppSink;
using GstAppSinkClass = struct _GstAppSinkClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gst
{ class AppSink_Class; } // namespace Gst
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gst
{
/** A Wrapper for the appsink plugin.
* Please note that not all plug-ins are available on all systems so care
* must be taken that they exist before they are used otherwise there will
* be errors and possibly a crash.
*
* @ingroup GstPlugins
* @deprecated Plugins API is deprecated, and should not be used in a new code.
*/
class AppSink
: public Gst::BaseSink, public Gst::URIHandler
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = AppSink;
using CppClassType = AppSink_Class;
using BaseObjectType = GstAppSink;
using BaseClassType = GstAppSinkClass;
// noncopyable
AppSink(const AppSink&) = delete;
AppSink& operator=(const AppSink&) = delete;
private: friend class AppSink_Class;
static CppClassType appsink_class_;
protected:
explicit AppSink(const Glib::ConstructParams& construct_params);
explicit AppSink(GstAppSink* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
AppSink(AppSink&& src) noexcept;
AppSink& operator=(AppSink&& src) noexcept;
~AppSink() noexcept override;
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GstAppSink* gobj() { return reinterpret_cast<GstAppSink*>(gobject_); }
///Provides access to the underlying C GObject.
const GstAppSink* gobj() const { return reinterpret_cast<GstAppSink*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GstAppSink* gobj_copy();
private:
protected:
AppSink();
explicit AppSink(const Glib::ustring& name);
public:
/** Creates a new appsink plugin with a unique name.
*/
static Glib::RefPtr<AppSink> create();
/** Creates a new appsink plugin with the given name.
*/
static Glib::RefPtr<AppSink> create(const Glib::ustring& name);
/** This is a convenience method for the action signal
* signal_pull_preroll().
*/
Glib::RefPtr<Gst::Sample> pull_preroll();
/** This is a convenience method for the action signal
* signal_pull_sample().
*/
Glib::RefPtr<Gst::Sample> pull_sample();
/** This is a convenience method for the action signal
* signal_try_pull_preroll().
*/
Glib::RefPtr<Gst::Sample> try_pull_preroll(guint64 arg0);
/** This is a convenience method for the action signal
* signal_try_pull_sample().
*/
Glib::RefPtr<Gst::Sample> try_pull_sample(guint64 arg0);
/** The allowed caps for the sink pad.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<Gst::Caps> > property_caps() ;
/** The allowed caps for the sink pad.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gst::Caps> > property_caps() const;
/** Check if the sink is EOS or not started.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_eos() const;
/** Emit new-preroll and new-sample signals.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_emit_signals() ;
/** Emit new-preroll and new-sample signals.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_emit_signals() const;
/** The maximum number of buffers to queue internally (0 = unlimited).
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< guint > property_max_buffers() ;
/** The maximum number of buffers to queue internally (0 = unlimited).
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< guint > property_max_buffers() const;
/** Drop old buffers when the buffer queue is filled.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_drop() ;
/** Drop old buffers when the buffer queue is filled.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_drop() const;
/** Wait for all buffers to be processed after receiving an EOS.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_wait_on_eos() ;
/** Wait for all buffers to be processed after receiving an EOS.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_wait_on_eos() const;
/**
* @par Slot Prototype:
* <tt>void on_my_%eos()</tt>
*
* Signal that the end-of-stream has been reached. This signal is emitted from
* the streaming thread.
*/
Glib::SignalProxy< void > signal_eos();
/**
* @par Slot Prototype:
* <tt>Gst::FlowReturn on_my_%new_preroll()</tt>
*
* Signal that a new preroll sample is available.
*
* This signal is emitted from the streaming thread and only when the
* "emit-signals" property is <tt>true</tt>.
*
* The new preroll sample can be retrieved with the "pull-preroll" action
* signal or Gst::AppSink::pull_preroll() either from this signal callback
* or from any other thread.
*
* Note that this signal is only emitted when the "emit-signals" property is
* set to <tt>true</tt>, which it is not by default for performance reasons.
*/
Glib::SignalProxy< Gst::FlowReturn > signal_new_preroll();
/**
* @par Slot Prototype:
* <tt>Gst::FlowReturn on_my_%new_sample()</tt>
*
* Signal that a new sample is available.
*
* This signal is emitted from the streaming thread and only when the
* "emit-signals" property is <tt>true</tt>.
*
* The new sample can be retrieved with the "pull-sample" action
* signal or Gst::AppSink::pull_sample() either from this signal callback
* or from any other thread.
*
* Note that this signal is only emitted when the "emit-signals" property is
* set to <tt>true</tt>, which it is not by default for performance reasons.
*/
Glib::SignalProxy< Gst::FlowReturn > signal_new_sample();
/** This is an action signal which is designed to be used as a method. To
* do that, use its convenience method, pull_preroll().
*
* @par Slot Prototype:
* <tt>Glib::RefPtr<Gst::Sample> on_my_%pull_preroll()</tt>
*
* Get the last preroll sample in @a appsink. This was the sample that caused the
* appsink to preroll in the PAUSED state. This sample can be pulled many times
* and remains available to the application even after EOS.
*
* This function is typically used when dealing with a pipeline in the PAUSED
* state. Calling this function after doing a seek will give the sample right
* after the seek position.
*
* Note that the preroll sample will also be returned as the first sample
* when calling Gst::AppSink::pull_sample() or the "pull-sample" action signal.
*
* If an EOS event was received before any buffers, this function returns
* <tt>nullptr</tt>. Use Gst::AppSink::is_eos() to check for the EOS condition.
*
* This function blocks until a preroll sample or EOS is received or the appsink
* element is set to the READY/<tt>nullptr</tt> state.
*
* @return A Gst::Sample or <tt>nullptr</tt> when the appsink is stopped or EOS.
*/
Glib::SignalProxy< Glib::RefPtr<Gst::Sample> > signal_pull_preroll();
/** This is an action signal which is designed to be used as a method. To
* do that, use its convenience method, pull_sample().
*
* @par Slot Prototype:
* <tt>Glib::RefPtr<Gst::Sample> on_my_%pull_sample()</tt>
*
* This function blocks until a sample or EOS becomes available or the appsink
* element is set to the READY/<tt>nullptr</tt> state.
*
* This function will only return samples when the appsink is in the PLAYING
* state. All rendered samples will be put in a queue so that the application
* can pull samples at its own rate.
*
* Note that when the application does not pull samples fast enough, the
* queued samples could consume a lot of memory, especially when dealing with
* raw video frames. It's possible to control the behaviour of the queue with
* the "drop" and "max-buffers" properties.
*
* If an EOS event was received before any buffers, this function returns
* <tt>nullptr</tt>. Use Gst::AppSink::is_eos() to check for the EOS condition.
*
* @return A Gst::Sample or <tt>nullptr</tt> when the appsink is stopped or EOS.
*/
Glib::SignalProxy< Glib::RefPtr<Gst::Sample> > signal_pull_sample();
//gtkmmproc error: try-pull-preroll : signal defs lookup failed
//gtkmmproc error: try-pull-sample : signal defs lookup failed
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gst
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gst::AppSink
*/
Glib::RefPtr<Gst::AppSink> wrap(GstAppSink* object, bool take_copy = false);
}
#endif // GSTREAMERMM_DISABLE_DEPRECATED
#endif /* _GSTREAMERMM_APPSINK_H */
|