Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gst.Structs.Event

Contents

Exported types
Methods
Properties

Description

The event class provides factory methods to construct events for sending and functions to query (parse) received events.

Events are usually created with gst_event_new_*() which takes event-type specific parameters as arguments. To send an event application will usually use gst_element_send_event() and elements will use gst_pad_send_event() or gst_pad_push_event(). The event should be unreffed with gst_event_unref() if it has not been sent.

Events that have been received can be parsed with their respective gst_event_parse_*() functions. It is valid to pass %NULL for unwanted details.

Events are passed between elements in parallel to the data stream. Some events are serialized with buffers, others are not. Some events only travel downstream, others only upstream. Some events can travel both upstream and downstream.

The events are used to signal special conditions in the datastream such as EOS (end of stream) or the start of a new stream-segment. Events are also used to flush the pipeline of any pending data.

Most of the event API is used inside plugins. Applications usually only construct and use seek events. To do that gst_event_new_seek() is used to create a seek event. It takes the needed parameters to specify seeking time and mode. |[ GstEvent *event; gboolean result; ... // construct a seek event to play the media from second 2 to 5, flush // the pipeline to decrease latency. event = gst_event_new_seek (1.0, GST_FORMAT_TIME, GST_SEEK_FLAG_FLUSH, GST_SEEK_TYPE_SET, 2 * GST_SECOND, GST_SEEK_TYPE_SET, 5 * GST_SECOND); ... result = gst_element_send_event (pipeline, event); if (!result) g_warning ("seek failed"); ... ]|

Synopsis

Exported types

newtype Event Source

Constructors

Event (ForeignPtr Event)

Instances

BoxedObject Event Source
(~) AttrOpTag tag AttrSet => Constructible Event tag Source
((~) * signature (m Structure), MonadIO m) => MethodInfo * EventWritableStructureMethodInfo Event signature Source
((~) * signature ([StreamFlags] -> m ()), MonadIO m) => MethodInfo * EventSetStreamFlagsMethodInfo Event signature Source
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetSeqnumMethodInfo Event signature Source
((~) * signature (Int64 -> m ()), MonadIO m) => MethodInfo * EventSetRunningTimeOffsetMethodInfo Event signature Source
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetGroupIdMethodInfo Event signature Source
((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseTocSelectMethodInfo Event signature Source
((~) * signature (m (Toc, Bool)), MonadIO m) => MethodInfo * EventParseTocMethodInfo Event signature Source
((~) * signature (m TagList), MonadIO m) => MethodInfo * EventParseTagMethodInfo Event signature Source
((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseStreamStartMethodInfo Event signature Source
((~) * signature (m [StreamFlags]), MonadIO m) => MethodInfo * EventParseStreamFlagsMethodInfo Event signature Source
((~) * signature (m (Format, Word64, Double, Bool, Bool)), MonadIO m) => MethodInfo * EventParseStepMethodInfo Event signature Source
((~) * signature (m Message), MonadIO m) => MethodInfo * EventParseSinkMessageMethodInfo Event signature Source
((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * EventParseSegmentDoneMethodInfo Event signature Source
((~) * signature (m Segment), MonadIO m) => MethodInfo * EventParseSegmentMethodInfo Event signature Source
((~) * signature (m (Double, Format, [SeekFlags], SeekType, Int64, SeekType, Int64)), MonadIO m) => MethodInfo * EventParseSeekMethodInfo Event signature Source
((~) * signature (m (QOSType, Double, Int64, Word64)), MonadIO m) => MethodInfo * EventParseQosMethodInfo Event signature Source
((~) * signature (Maybe Text -> m (Text, Buffer)), MonadIO m) => MethodInfo * EventParseProtectionMethodInfo Event signature Source
((~) * signature (m Word64), MonadIO m) => MethodInfo * EventParseLatencyMethodInfo Event signature Source
((~) * signature (m (Bool, Word32)), MonadIO m) => MethodInfo * EventParseGroupIdMethodInfo Event signature Source
((~) * signature (m (Word64, Word64)), MonadIO m) => MethodInfo * EventParseGapMethodInfo Event signature Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * EventParseFlushStopMethodInfo Event signature Source
((~) * signature (m Caps), MonadIO m) => MethodInfo * EventParseCapsMethodInfo Event signature Source
((~) * signature (m (Format, Int64, Int64, Bool)), MonadIO m) => MethodInfo * EventParseBufferSizeMethodInfo Event signature Source
((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * EventHasNameMethodInfo Event signature Source
((~) * signature (m Structure), MonadIO m) => MethodInfo * EventGetStructureMethodInfo Event signature Source
((~) * signature (m Word32), MonadIO m) => MethodInfo * EventGetSeqnumMethodInfo Event signature Source
((~) * signature (m Int64), MonadIO m) => MethodInfo * EventGetRunningTimeOffsetMethodInfo Event signature Source
((~) * signature (Segment -> m ()), MonadIO m) => MethodInfo * EventCopySegmentMethodInfo Event signature Source
((~) * info (ResolveEventMethod t Event), MethodInfo * info Event p) => IsLabelProxy t (Event -> p) Source
type AttributeList Event Source