gi-gst-0.1.6.13: Gst bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.Event

Contents

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 

Methods

boxedType :: Event -> IO GType

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

Methods

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

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

Methods

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

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

newZeroEvent :: MonadIO m => m Event Source

Construct a Event struct initialized to zero.

noEvent :: Maybe Event Source

Methods

eventCopySegment

data EventCopySegmentMethodInfo Source

Instances

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

eventGetRunningTimeOffset

data EventGetRunningTimeOffsetMethodInfo Source

Instances

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

eventGetSeqnum

data EventGetSeqnumMethodInfo Source

Instances

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

eventGetStructure

data EventGetStructureMethodInfo Source

Instances

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

eventHasName

data EventHasNameMethodInfo Source

Instances

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

eventNewBufferSize

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

eventNewCaps

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

eventNewCustom

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

eventNewEos

eventNewEos :: MonadIO m => m Event Source

eventNewFlushStart

eventNewFlushStart :: MonadIO m => m Event Source

eventNewFlushStop

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

eventNewGap

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

eventNewLatency

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

eventNewNavigation

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

eventNewProtection

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

eventNewQos

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

eventNewReconfigure

eventNewReconfigure :: MonadIO m => m Event Source

eventNewSeek

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

eventNewSegment

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

eventNewSegmentDone

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

eventNewSinkMessage

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

eventNewStep

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

eventNewStreamStart

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

eventNewTag

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

eventNewToc

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

eventNewTocSelect

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

eventParseBufferSize

data EventParseBufferSizeMethodInfo Source

Instances

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

eventParseCaps

data EventParseCapsMethodInfo Source

Instances

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

eventParseFlushStop

data EventParseFlushStopMethodInfo Source

Instances

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

eventParseGap

data EventParseGapMethodInfo Source

Instances

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

eventParseGroupId

data EventParseGroupIdMethodInfo Source

Instances

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

eventParseLatency

data EventParseLatencyMethodInfo Source

Instances

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

eventParseProtection

data EventParseProtectionMethodInfo Source

Instances

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

eventParseQos

data EventParseQosMethodInfo Source

Instances

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

eventParseSeek

data EventParseSeekMethodInfo Source

Instances

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

eventParseSegment

data EventParseSegmentMethodInfo Source

Instances

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

eventParseSegmentDone

data EventParseSegmentDoneMethodInfo Source

Instances

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

eventParseSinkMessage

data EventParseSinkMessageMethodInfo Source

Instances

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

eventParseStep

data EventParseStepMethodInfo Source

Instances

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

eventParseStreamFlags

data EventParseStreamFlagsMethodInfo Source

Instances

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

eventParseStreamStart

data EventParseStreamStartMethodInfo Source

Instances

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

eventParseTag

data EventParseTagMethodInfo Source

Instances

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

eventParseToc

data EventParseTocMethodInfo Source

Instances

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

eventParseTocSelect

data EventParseTocSelectMethodInfo Source

Instances

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

eventSetGroupId

data EventSetGroupIdMethodInfo Source

Instances

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

eventSetRunningTimeOffset

data EventSetRunningTimeOffsetMethodInfo Source

Instances

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

eventSetSeqnum

data EventSetSeqnumMethodInfo Source

Instances

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

eventSetStreamFlags

data EventSetStreamFlagsMethodInfo Source

Instances

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

eventWritableStructure

data EventWritableStructureMethodInfo Source

Instances

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

Properties

MiniObject

eventReadMiniObject :: Event -> IO MiniObject Source

Seqnum

eventReadSeqnum :: Event -> IO Word32 Source

Timestamp

eventReadTimestamp :: Event -> IO Word64 Source

Type

eventReadType :: Event -> IO EventType Source