A flush start event. More...
#include <gstreamermm/event.h>
Inheritance diagram for Gst::EventFlushStart:
Static Public Member Functions | |
| static Glib::RefPtr< Gst::EventFlushStart > | create () |
| Allocate a new flush start event. More... | |
Additional Inherited Members | |
 Public Types inherited from Gst::MiniObject | |
| typedef sigc::slot< void > | SlotFinalizer |
| Public Member Functions inherited from Gst::Event | |
| void | reference () const |
| Increment the reference count for this object. More... | |
| void | unreference () const |
| Decrement the reference count for this object. More... | |
| GstEvent* | gobj () |
| Provides access to the underlying C instance. More... | |
| const GstEvent* | gobj () const |
| Provides access to the underlying C instance. More... | |
| GstEvent* | gobj_copy () const |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| Event ()=delete | |
| Event (const Event&)=delete | |
| Event& | operator= (const Event&)=delete |
| Gst::Structure | get_structure () const |
| Access the structure of the event. More... | |
| bool | has_name (const Glib::ustring& name) const |
| Checks if event has the given name. More... | |
| guint32 | get_seqnum () const |
| Retrieve the sequence number of a event. More... | |
| void | set_seqnum (guint32 seqnum) |
| Set the sequence number of a event. More... | |
| gint64 | get_running_time_offset () const |
| Retrieve the accumulated running time offset of the event. More... | |
| void | set_running_time_offset (gint64 offset) |
| Set the running time offset of a event. More... | |
| Glib::RefPtr< Gst::Event > | copy () const |
| Copy the event using the event specific copy function. More... | |
| Glib::RefPtr< Gst::Event > | create_writable () |
| Makes a writable event from the given event. More... | |
| bool | is_downstream () const |
| Check if an event can travel downstream. More... | |
| bool | is_serialized () const |
| Check if an event is serialized with the data stream. More... | |
| bool | is_upstream () const |
| Check if an event can travel upstream. More... | |
| EventType | get_event_type () const |
| Get the Gst::EventType of the event. More... | |
| Gst::ClockTime | get_timestamp () const |
| Get the Gst::ClockTime timestamp of the event. More... | |
| Public Member Functions inherited from Gst::MiniObject | |
| void | reference () const |
| Increment the reference count for this object. More... | |
| void | unreference () const |
| Decrement the reference count for this object. More... | |
| GstMiniObject* | gobj () |
| Provides access to the underlying C instance. More... | |
| const GstMiniObject* | gobj () const |
| Provides access to the underlying C instance. More... | |
| GstMiniObject* | gobj_copy () const |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| MiniObject ()=delete | |
| MiniObject (const MiniObject&)=delete | |
| MiniObject& | operator= (const MiniObject&)=delete |
| ~MiniObject () | |
| guint | get_flags () const |
| void | set_flags (const guint& value) |
| gint | get_refcount () const |
| gint | get_lockstate () const |
| bool | lock (LockFlags flags) |
| Lock the mini-object with the specified access mode in flags. More... | |
| void | unlock (LockFlags flags) |
| Unlock the mini-object with the specified access mode in flags. More... | |
| bool | is_writable () const |
| If mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE lock on object is the only one, this means that changes to the object will not be visible to any other object. More... | |
| Glib::RefPtr< MiniObject > | create_writable () |
| Checks if a mini-object is writable. More... | |
| void | set_qdata (GQuark quark, QuarkData* data) |
| This sets an opaque, named pointer on a miniobject. More... | |
| QuarkData* | get_qdata (GQuark quark) const |
| This function gets back user data pointers stored via set_qdata(). More... | |
| QuarkData* | steal_qdata (GQuark quark) |
| This function gets back user data pointers stored via set_qdata() and removes the data from object without invoking its destroy() function (if any was set). More... | |
| void | add_finalize_notifier (const SlotFinalizer& slot) |
| Adds notifier when mini object is finalized. More... | |
| void | remove_finalize_notifier () |
| Remove finalize notifier. More... | |
| Protected Member Functions inherited from Gst::Event | |
| void | operator delete (void*, std::size_t) |
| Protected Member Functions inherited from Gst::MiniObject | |
| void | operator delete (void*, std::size_t) |
| Related Functions inherited from Gst::Event | |
| Glib::RefPtr< Gst::Event > | wrap (GstEvent* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Gst::MiniObject | |
| Glib::RefPtr< Gst::MiniObject > | wrap (GstMiniObject* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Detailed Description
A flush start event.
See create() for more details.
Member Function Documentation
◆ create()
|
static |
Allocate a new flush start event.
The flush start event can be sent upstream and downstream and travels out-of-bounds with the dataflow.
It marks pads as being flushing and will make them return Gst::FLOW_FLUSHING when used for data flow with Gst::Pad::push(), Gst::Pad::chain(), Gst::Pad::get_range() and Gst::Pad::pull_range(). Any event (except a Gst::EVENT_FLUSH_STOP) received on a flushing pad will return false immediately.
Elements should unlock any blocking functions and exit their streaming functions as fast as possible when this event is received.
This event is typically generated after a seek to flush out all queued data in the pipeline so that the new media is played as soon as possible.
- Returns
- A new flush start event.
