GI.Gst.Structs.Event

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. |[language="C" -- 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"); ... ]|

Exported types

newtype Event

Constructors

Event (ManagedPtr Event)

Instances

BoxedObject Event

Methods

boxedType :: Event -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Event tag

Methods

new :: MonadIO m => (ManagedPtr Event -> Event) -> [AttrOp Event tag] -> m Event

((~) * info (ResolveEventMethod t Event), MethodInfo * info Event p) => IsLabel t (Event -> p)

Methods

fromLabel :: Proxy# Symbol t -> Event -> p

((~) * info (ResolveEventMethod t Event), MethodInfo * info Event p) => IsLabelProxy t (Event -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Event -> p

HasAttributeList * Event

((~) * signature (m Structure), MonadIO m) => MethodInfo * EventWritableStructureMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventWritableStructureMethodInfo Event -> signature -> s

((~) * signature ([StreamFlags] -> m ()), MonadIO m) => MethodInfo * EventSetStreamFlagsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetStreamFlagsMethodInfo Event -> signature -> s

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetSeqnumMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetSeqnumMethodInfo Event -> signature -> s

((~) * signature (Int64 -> m ()), MonadIO m) => MethodInfo * EventSetRunningTimeOffsetMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetRunningTimeOffsetMethodInfo Event -> signature -> s

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetGroupIdMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetGroupIdMethodInfo Event -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseTocSelectMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTocSelectMethodInfo Event -> signature -> s

((~) * signature (m (Toc, Bool)), MonadIO m) => MethodInfo * EventParseTocMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTocMethodInfo Event -> signature -> s

((~) * signature (m TagList), MonadIO m) => MethodInfo * EventParseTagMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTagMethodInfo Event -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseStreamStartMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStreamStartMethodInfo Event -> signature -> s

((~) * signature (m [StreamFlags]), MonadIO m) => MethodInfo * EventParseStreamFlagsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStreamFlagsMethodInfo Event -> signature -> s

((~) * signature (m (Format, Word64, Double, Bool, Bool)), MonadIO m) => MethodInfo * EventParseStepMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStepMethodInfo Event -> signature -> s

((~) * signature (m Message), MonadIO m) => MethodInfo * EventParseSinkMessageMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSinkMessageMethodInfo Event -> signature -> s

((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * EventParseSegmentDoneMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSegmentDoneMethodInfo Event -> signature -> s

((~) * signature (m Segment), MonadIO m) => MethodInfo * EventParseSegmentMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSegmentMethodInfo Event -> signature -> s

((~) * signature (m (Double, Format, [SeekFlags], SeekType, Int64, SeekType, Int64)), MonadIO m) => MethodInfo * EventParseSeekMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSeekMethodInfo Event -> signature -> s

((~) * signature (m (QOSType, Double, Int64, Word64)), MonadIO m) => MethodInfo * EventParseQosMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseQosMethodInfo Event -> signature -> s

((~) * signature (Maybe Text -> m (Text, Buffer)), MonadIO m) => MethodInfo * EventParseProtectionMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseProtectionMethodInfo Event -> signature -> s

((~) * signature (m Word64), MonadIO m) => MethodInfo * EventParseLatencyMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseLatencyMethodInfo Event -> signature -> s

((~) * signature (m (Bool, Word32)), MonadIO m) => MethodInfo * EventParseGroupIdMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseGroupIdMethodInfo Event -> signature -> s

((~) * signature (m (Word64, Word64)), MonadIO m) => MethodInfo * EventParseGapMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseGapMethodInfo Event -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * EventParseFlushStopMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseFlushStopMethodInfo Event -> signature -> s

((~) * signature (m Caps), MonadIO m) => MethodInfo * EventParseCapsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseCapsMethodInfo Event -> signature -> s

((~) * signature (m (Format, Int64, Int64, Bool)), MonadIO m) => MethodInfo * EventParseBufferSizeMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseBufferSizeMethodInfo Event -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * EventHasNameMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventHasNameMethodInfo Event -> signature -> s

((~) * signature (m Structure), MonadIO m) => MethodInfo * EventGetStructureMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetStructureMethodInfo Event -> signature -> s

((~) * signature (m Word32), MonadIO m) => MethodInfo * EventGetSeqnumMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetSeqnumMethodInfo Event -> signature -> s

((~) * signature (m Int64), MonadIO m) => MethodInfo * EventGetRunningTimeOffsetMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetRunningTimeOffsetMethodInfo Event -> signature -> s

((~) * signature (Segment -> m ()), MonadIO m) => MethodInfo * EventCopySegmentMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventCopySegmentMethodInfo Event -> signature -> s

type AttributeList Event

type AttributeList Event

newZeroEvent :: MonadIO m => m Event

Construct a Event struct initialized to zero.

noEvent :: Maybe Event

Methods

copySegment

data EventCopySegmentMethodInfo

Instances

((~) * signature (Segment -> m ()), MonadIO m) => MethodInfo * EventCopySegmentMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventCopySegmentMethodInfo Event -> signature -> s

eventCopySegment :: MonadIO m => Event -> Segment -> m ()

getRunningTimeOffset

data EventGetRunningTimeOffsetMethodInfo

Instances

((~) * signature (m Int64), MonadIO m) => MethodInfo * EventGetRunningTimeOffsetMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetRunningTimeOffsetMethodInfo Event -> signature -> s

eventGetRunningTimeOffset :: MonadIO m => Event -> m Int64

getSeqnum

data EventGetSeqnumMethodInfo

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * EventGetSeqnumMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetSeqnumMethodInfo Event -> signature -> s

eventGetSeqnum :: MonadIO m => Event -> m Word32

getStructure

data EventGetStructureMethodInfo

Instances

((~) * signature (m Structure), MonadIO m) => MethodInfo * EventGetStructureMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventGetStructureMethodInfo Event -> signature -> s

eventGetStructure :: MonadIO m => Event -> m Structure

hasName

data EventHasNameMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * EventHasNameMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventHasNameMethodInfo Event -> signature -> s

eventHasName :: MonadIO m => Event -> Text -> m Bool

newBufferSize

eventNewBufferSize :: MonadIO m => Format -> Int64 -> Int64 -> Bool -> m Event

newCaps

eventNewCaps :: MonadIO m => Caps -> m Event

newCustom

eventNewCustom :: MonadIO m => EventType -> Structure -> m Event

newEos

eventNewEos :: MonadIO m => m Event

newFlushStart

eventNewFlushStart :: MonadIO m => m Event

newFlushStop

eventNewFlushStop :: MonadIO m => Bool -> m Event

newGap

eventNewGap :: MonadIO m => Word64 -> Word64 -> m Event

newLatency

eventNewLatency :: MonadIO m => Word64 -> m Event

newNavigation

eventNewNavigation :: MonadIO m => Structure -> m Event

newProtection

eventNewProtection :: MonadIO m => Text -> Buffer -> Text -> m Event

newQos

eventNewQos :: MonadIO m => QOSType -> Double -> Int64 -> Word64 -> m Event

newReconfigure

eventNewReconfigure :: MonadIO m => m Event

newSeek

eventNewSeek :: MonadIO m => Double -> Format -> [SeekFlags] -> SeekType -> Int64 -> SeekType -> Int64 -> m Event

newSegment

eventNewSegment :: MonadIO m => Segment -> m Event

newSegmentDone

eventNewSegmentDone :: MonadIO m => Format -> Int64 -> m Event

newSinkMessage

eventNewSinkMessage :: MonadIO m => Text -> Message -> m Event

newStep

eventNewStep :: MonadIO m => Format -> Word64 -> Double -> Bool -> Bool -> m Event

newStreamStart

eventNewStreamStart :: MonadIO m => Text -> m Event

newTag

eventNewTag :: MonadIO m => TagList -> m Event

newToc

eventNewToc :: MonadIO m => Toc -> Bool -> m Event

newTocSelect

eventNewTocSelect :: MonadIO m => Text -> m Event

parseBufferSize

data EventParseBufferSizeMethodInfo

Instances

((~) * signature (m (Format, Int64, Int64, Bool)), MonadIO m) => MethodInfo * EventParseBufferSizeMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseBufferSizeMethodInfo Event -> signature -> s

eventParseBufferSize :: MonadIO m => Event -> m (Format, Int64, Int64, Bool)

parseCaps

data EventParseCapsMethodInfo

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * EventParseCapsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseCapsMethodInfo Event -> signature -> s

eventParseCaps :: MonadIO m => Event -> m Caps

parseFlushStop

data EventParseFlushStopMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * EventParseFlushStopMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseFlushStopMethodInfo Event -> signature -> s

eventParseFlushStop :: MonadIO m => Event -> m Bool

parseGap

data EventParseGapMethodInfo

Instances

((~) * signature (m (Word64, Word64)), MonadIO m) => MethodInfo * EventParseGapMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseGapMethodInfo Event -> signature -> s

eventParseGap :: MonadIO m => Event -> m (Word64, Word64)

parseGroupId

data EventParseGroupIdMethodInfo

Instances

((~) * signature (m (Bool, Word32)), MonadIO m) => MethodInfo * EventParseGroupIdMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseGroupIdMethodInfo Event -> signature -> s

eventParseGroupId :: MonadIO m => Event -> m (Bool, Word32)

parseLatency

data EventParseLatencyMethodInfo

Instances

((~) * signature (m Word64), MonadIO m) => MethodInfo * EventParseLatencyMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseLatencyMethodInfo Event -> signature -> s

eventParseLatency :: MonadIO m => Event -> m Word64

parseProtection

data EventParseProtectionMethodInfo

Instances

((~) * signature (Maybe Text -> m (Text, Buffer)), MonadIO m) => MethodInfo * EventParseProtectionMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseProtectionMethodInfo Event -> signature -> s

eventParseProtection :: MonadIO m => Event -> Maybe Text -> m (Text, Buffer)

parseQos

data EventParseQosMethodInfo

Instances

((~) * signature (m (QOSType, Double, Int64, Word64)), MonadIO m) => MethodInfo * EventParseQosMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseQosMethodInfo Event -> signature -> s

eventParseQos :: MonadIO m => Event -> m (QOSType, Double, Int64, Word64)

parseSeek

data EventParseSeekMethodInfo

Instances

((~) * signature (m (Double, Format, [SeekFlags], SeekType, Int64, SeekType, Int64)), MonadIO m) => MethodInfo * EventParseSeekMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSeekMethodInfo Event -> signature -> s

eventParseSeek :: MonadIO m => Event -> m (Double, Format, [SeekFlags], SeekType, Int64, SeekType, Int64)

parseSegment

data EventParseSegmentMethodInfo

Instances

((~) * signature (m Segment), MonadIO m) => MethodInfo * EventParseSegmentMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSegmentMethodInfo Event -> signature -> s

eventParseSegment :: MonadIO m => Event -> m Segment

parseSegmentDone

data EventParseSegmentDoneMethodInfo

Instances

((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * EventParseSegmentDoneMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSegmentDoneMethodInfo Event -> signature -> s

eventParseSegmentDone :: MonadIO m => Event -> m (Format, Int64)

parseSinkMessage

data EventParseSinkMessageMethodInfo

Instances

((~) * signature (m Message), MonadIO m) => MethodInfo * EventParseSinkMessageMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseSinkMessageMethodInfo Event -> signature -> s

eventParseSinkMessage :: MonadIO m => Event -> m Message

parseStep

data EventParseStepMethodInfo

Instances

((~) * signature (m (Format, Word64, Double, Bool, Bool)), MonadIO m) => MethodInfo * EventParseStepMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStepMethodInfo Event -> signature -> s

eventParseStep :: MonadIO m => Event -> m (Format, Word64, Double, Bool, Bool)

parseStreamFlags

data EventParseStreamFlagsMethodInfo

Instances

((~) * signature (m [StreamFlags]), MonadIO m) => MethodInfo * EventParseStreamFlagsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStreamFlagsMethodInfo Event -> signature -> s

eventParseStreamFlags :: MonadIO m => Event -> m [StreamFlags]

parseStreamStart

data EventParseStreamStartMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseStreamStartMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseStreamStartMethodInfo Event -> signature -> s

eventParseStreamStart :: MonadIO m => Event -> m Text

parseTag

data EventParseTagMethodInfo

Instances

((~) * signature (m TagList), MonadIO m) => MethodInfo * EventParseTagMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTagMethodInfo Event -> signature -> s

eventParseTag :: MonadIO m => Event -> m TagList

parseToc

data EventParseTocMethodInfo

Instances

((~) * signature (m (Toc, Bool)), MonadIO m) => MethodInfo * EventParseTocMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTocMethodInfo Event -> signature -> s

eventParseToc :: MonadIO m => Event -> m (Toc, Bool)

parseTocSelect

data EventParseTocSelectMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * EventParseTocSelectMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventParseTocSelectMethodInfo Event -> signature -> s

eventParseTocSelect :: MonadIO m => Event -> m Text

setGroupId

data EventSetGroupIdMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetGroupIdMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetGroupIdMethodInfo Event -> signature -> s

eventSetGroupId :: MonadIO m => Event -> Word32 -> m ()

setRunningTimeOffset

data EventSetRunningTimeOffsetMethodInfo

Instances

((~) * signature (Int64 -> m ()), MonadIO m) => MethodInfo * EventSetRunningTimeOffsetMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetRunningTimeOffsetMethodInfo Event -> signature -> s

eventSetRunningTimeOffset :: MonadIO m => Event -> Int64 -> m ()

setSeqnum

data EventSetSeqnumMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * EventSetSeqnumMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetSeqnumMethodInfo Event -> signature -> s

eventSetSeqnum :: MonadIO m => Event -> Word32 -> m ()

setStreamFlags

data EventSetStreamFlagsMethodInfo

Instances

((~) * signature ([StreamFlags] -> m ()), MonadIO m) => MethodInfo * EventSetStreamFlagsMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventSetStreamFlagsMethodInfo Event -> signature -> s

eventSetStreamFlags :: MonadIO m => Event -> [StreamFlags] -> m ()

writableStructure

data EventWritableStructureMethodInfo

Instances

((~) * signature (m Structure), MonadIO m) => MethodInfo * EventWritableStructureMethodInfo Event signature

Methods

overloadedMethod :: MethodProxy EventWritableStructureMethodInfo Event -> signature -> s

eventWritableStructure :: MonadIO m => Event -> m Structure

Properties

miniObject

event_miniObject :: AttrLabelProxy "miniObject"

getEventMiniObject :: MonadIO m => Event -> m MiniObject

seqnum

event_seqnum :: AttrLabelProxy "seqnum"

getEventSeqnum :: MonadIO m => Event -> m Word32

setEventSeqnum :: MonadIO m => Event -> Word32 -> m ()

timestamp

event_timestamp :: AttrLabelProxy "timestamp"

getEventTimestamp :: MonadIO m => Event -> m Word64

setEventTimestamp :: MonadIO m => Event -> Word64 -> m ()

type

event_type :: AttrLabelProxy "type"

getEventType :: MonadIO m => Event -> m EventType

setEventType :: MonadIO m => Event -> EventType -> m ()