gi-gst-1.0.2: GStreamer 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.Message

Contents

Description

Messages are implemented as a subclass of #GstMiniObject with a generic #GstStructure as the content. This allows for writing custom messages without requiring an API change while allowing a wide range of different types of messages.

Messages are posted by objects in the pipeline and are passed to the application using the #GstBus.

The basic use pattern of posting a message on a #GstBus is as follows: |[ gst_bus_post (bus, gst_message_new_eos()); ]|

A #GstElement usually posts messages on the bus provided by the parent container using gst_element_post_message().

Synopsis

Exported types

newtype Message Source

Constructors

Message (ForeignPtr Message) 

Instances

BoxedObject Message Source 
(~) AttrOpTag tag AttrSet => Constructible Message tag Source 
((~) * signature (GValue -> m ()), MonadIO m) => MethodInfo * MessageSetStreamStatusObjectMethodInfo Message signature Source 
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * MessageSetSeqnumMethodInfo Message signature Source 
((~) * signature (Int64 -> Double -> Int32 -> m ()), MonadIO m) => MethodInfo * MessageSetQosValuesMethodInfo Message signature Source 
((~) * signature (Format -> Word64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MessageSetQosStatsMethodInfo Message signature Source 
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * MessageSetGroupIdMethodInfo Message signature Source 
((~) * signature (BufferingMode -> Int32 -> Int32 -> Int64 -> m ()), MonadIO m) => MethodInfo * MessageSetBufferingStatsMethodInfo Message signature Source 
((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseWarningMethodInfo Message signature Source 
((~) * signature (m (Toc, Bool)), MonadIO m) => MethodInfo * MessageParseTocMethodInfo Message signature Source 
((~) * signature (m TagList), MonadIO m) => MethodInfo * MessageParseTagMethodInfo Message signature Source 
((~) * signature (m (StructureChangeType, Element, Bool)), MonadIO m) => MethodInfo * MessageParseStructureChangeMethodInfo Message signature Source 
((~) * signature (m (StreamStatusType, Element)), MonadIO m) => MethodInfo * MessageParseStreamStatusMethodInfo Message signature Source 
((~) * signature (m (Bool, Format, Word64, Double, Bool, Bool)), MonadIO m) => MethodInfo * MessageParseStepStartMethodInfo Message signature Source 
((~) * signature (m (Format, Word64, Double, Bool, Bool, Word64, Bool)), MonadIO m) => MethodInfo * MessageParseStepDoneMethodInfo Message signature Source 
((~) * signature (m (State, State, State)), MonadIO m) => MethodInfo * MessageParseStateChangedMethodInfo Message signature Source 
((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * MessageParseSegmentStartMethodInfo Message signature Source 
((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * MessageParseSegmentDoneMethodInfo Message signature Source 
((~) * signature (m Word64), MonadIO m) => MethodInfo * MessageParseResetTimeMethodInfo Message signature Source 
((~) * signature (m State), MonadIO m) => MethodInfo * MessageParseRequestStateMethodInfo Message signature Source 
((~) * signature (m (Int64, Double, Int32)), MonadIO m) => MethodInfo * MessageParseQosValuesMethodInfo Message signature Source 
((~) * signature (m (Format, Word64, Word64)), MonadIO m) => MethodInfo * MessageParseQosStatsMethodInfo Message signature Source 
((~) * signature (m (Bool, Word64, Word64, Word64, Word64)), MonadIO m) => MethodInfo * MessageParseQosMethodInfo Message signature Source 
((~) * signature (m (ProgressType, Text, Text)), MonadIO m) => MethodInfo * MessageParseProgressMethodInfo Message signature Source 
((~) * signature (m Clock), MonadIO m) => MethodInfo * MessageParseNewClockMethodInfo Message signature Source 
((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseInfoMethodInfo Message signature Source 
((~) * signature (m Context), MonadIO m) => MethodInfo * MessageParseHaveContextMethodInfo Message signature Source 
((~) * signature (m (Bool, Word32)), MonadIO m) => MethodInfo * MessageParseGroupIdMethodInfo Message signature Source 
((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseErrorMethodInfo Message signature Source 
((~) * signature (m Device), MonadIO m) => MethodInfo * MessageParseDeviceRemovedMethodInfo Message signature Source 
((~) * signature (m Device), MonadIO m) => MethodInfo * MessageParseDeviceAddedMethodInfo Message signature Source 
((~) * signature (m (Bool, Text)), MonadIO m) => MethodInfo * MessageParseContextTypeMethodInfo Message signature Source 
((~) * signature (m (Clock, Bool)), MonadIO m) => MethodInfo * MessageParseClockProvideMethodInfo Message signature Source 
((~) * signature (m Clock), MonadIO m) => MethodInfo * MessageParseClockLostMethodInfo Message signature Source 
((~) * signature (m (BufferingMode, Int32, Int32, Int64)), MonadIO m) => MethodInfo * MessageParseBufferingStatsMethodInfo Message signature Source 
((~) * signature (m Int32), MonadIO m) => MethodInfo * MessageParseBufferingMethodInfo Message signature Source 
((~) * signature (m Word64), MonadIO m) => MethodInfo * MessageParseAsyncDoneMethodInfo Message signature Source 
((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MessageHasNameMethodInfo Message signature Source 
((~) * signature (m Structure), MonadIO m) => MethodInfo * MessageGetStructureMethodInfo Message signature Source 
((~) * signature (m GValue), MonadIO m) => MethodInfo * MessageGetStreamStatusObjectMethodInfo Message signature Source 
((~) * signature (m Word32), MonadIO m) => MethodInfo * MessageGetSeqnumMethodInfo Message signature Source 
((~) * info (ResolveMessageMethod t Message), MethodInfo * info Message p) => IsLabelProxy t (Message -> p) Source 
type AttributeList Message Source 

newZeroMessage :: MonadIO m => m Message Source

Construct a Message struct initialized to zero.

noMessage :: Maybe Message Source

Methods

messageGetSeqnum

data MessageGetSeqnumMethodInfo Source

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * MessageGetSeqnumMethodInfo Message signature Source 

messageGetSeqnum :: MonadIO m => Message -> m Word32 Source

messageGetStreamStatusObject

data MessageGetStreamStatusObjectMethodInfo Source

Instances

messageGetStreamStatusObject :: MonadIO m => Message -> m GValue Source

messageGetStructure

data MessageGetStructureMethodInfo Source

Instances

((~) * signature (m Structure), MonadIO m) => MethodInfo * MessageGetStructureMethodInfo Message signature Source 

messageGetStructure :: MonadIO m => Message -> m Structure Source

messageHasName

data MessageHasNameMethodInfo Source

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MessageHasNameMethodInfo Message signature Source 

messageHasName :: MonadIO m => Message -> Text -> m Bool Source

messageNewApplication

messageNewApplication :: (MonadIO m, ObjectK a) => Maybe a -> Structure -> m Message Source

messageNewAsyncDone

messageNewAsyncDone :: (MonadIO m, ObjectK a) => Maybe a -> Word64 -> m Message Source

messageNewAsyncStart

messageNewAsyncStart :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewBuffering

messageNewBuffering :: (MonadIO m, ObjectK a) => Maybe a -> Int32 -> m Message Source

messageNewClockLost

messageNewClockLost :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> m Message Source

messageNewClockProvide

messageNewClockProvide :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> Bool -> m Message Source

messageNewCustom

messageNewCustom :: (MonadIO m, ObjectK a) => [MessageType] -> Maybe a -> Maybe Structure -> m Message Source

messageNewDeviceAdded

messageNewDeviceAdded :: (MonadIO m, ObjectK a, DeviceK b) => a -> b -> m Message Source

messageNewDeviceRemoved

messageNewDeviceRemoved :: (MonadIO m, ObjectK a, DeviceK b) => a -> b -> m Message Source

messageNewDurationChanged

messageNewDurationChanged :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewElement

messageNewElement :: (MonadIO m, ObjectK a) => Maybe a -> Structure -> m Message Source

messageNewEos

messageNewEos :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewError

messageNewError :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message Source

messageNewHaveContext

messageNewHaveContext :: (MonadIO m, ObjectK a) => Maybe a -> Context -> m Message Source

messageNewInfo

messageNewInfo :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message Source

messageNewLatency

messageNewLatency :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewNeedContext

messageNewNeedContext :: (MonadIO m, ObjectK a) => Maybe a -> Text -> m Message Source

messageNewNewClock

messageNewNewClock :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> m Message Source

messageNewProgress

messageNewProgress :: (MonadIO m, ObjectK a) => a -> ProgressType -> Text -> Text -> m Message Source

messageNewQos

messageNewQos :: (MonadIO m, ObjectK a) => a -> Bool -> Word64 -> Word64 -> Word64 -> Word64 -> m Message Source

messageNewRequestState

messageNewRequestState :: (MonadIO m, ObjectK a) => Maybe a -> State -> m Message Source

messageNewResetTime

messageNewResetTime :: (MonadIO m, ObjectK a) => Maybe a -> Word64 -> m Message Source

messageNewSegmentDone

messageNewSegmentDone :: (MonadIO m, ObjectK a) => Maybe a -> Format -> Int64 -> m Message Source

messageNewSegmentStart

messageNewSegmentStart :: (MonadIO m, ObjectK a) => Maybe a -> Format -> Int64 -> m Message Source

messageNewStateChanged

messageNewStateChanged :: (MonadIO m, ObjectK a) => Maybe a -> State -> State -> State -> m Message Source

messageNewStateDirty

messageNewStateDirty :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewStepDone

messageNewStepDone :: (MonadIO m, ObjectK a) => a -> Format -> Word64 -> Double -> Bool -> Bool -> Word64 -> Bool -> m Message Source

messageNewStepStart

messageNewStepStart :: (MonadIO m, ObjectK a) => a -> Bool -> Format -> Word64 -> Double -> Bool -> Bool -> m Message Source

messageNewStreamStart

messageNewStreamStart :: (MonadIO m, ObjectK a) => Maybe a -> m Message Source

messageNewStreamStatus

messageNewStreamStatus :: (MonadIO m, ObjectK a, ElementK b) => a -> StreamStatusType -> b -> m Message Source

messageNewStructureChange

messageNewStructureChange :: (MonadIO m, ObjectK a, ElementK b) => Maybe a -> StructureChangeType -> b -> Bool -> m Message Source

messageNewTag

messageNewTag :: (MonadIO m, ObjectK a) => Maybe a -> TagList -> m Message Source

messageNewToc

messageNewToc :: (MonadIO m, ObjectK a) => a -> Toc -> Bool -> m Message Source

messageNewWarning

messageNewWarning :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message Source

messageParseAsyncDone

data MessageParseAsyncDoneMethodInfo Source

Instances

((~) * signature (m Word64), MonadIO m) => MethodInfo * MessageParseAsyncDoneMethodInfo Message signature Source 

messageParseAsyncDone :: MonadIO m => Message -> m Word64 Source

messageParseBuffering

data MessageParseBufferingMethodInfo Source

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * MessageParseBufferingMethodInfo Message signature Source 

messageParseBuffering :: MonadIO m => Message -> m Int32 Source

messageParseBufferingStats

data MessageParseBufferingStatsMethodInfo Source

Instances

messageParseBufferingStats :: MonadIO m => Message -> m (BufferingMode, Int32, Int32, Int64) Source

messageParseClockLost

data MessageParseClockLostMethodInfo Source

Instances

((~) * signature (m Clock), MonadIO m) => MethodInfo * MessageParseClockLostMethodInfo Message signature Source 

messageParseClockLost :: MonadIO m => Message -> m Clock Source

messageParseClockProvide

data MessageParseClockProvideMethodInfo Source

Instances

((~) * signature (m (Clock, Bool)), MonadIO m) => MethodInfo * MessageParseClockProvideMethodInfo Message signature Source 

messageParseClockProvide :: MonadIO m => Message -> m (Clock, Bool) Source

messageParseContextType

data MessageParseContextTypeMethodInfo Source

Instances

((~) * signature (m (Bool, Text)), MonadIO m) => MethodInfo * MessageParseContextTypeMethodInfo Message signature Source 

messageParseContextType :: MonadIO m => Message -> m (Bool, Text) Source

messageParseDeviceAdded

data MessageParseDeviceAddedMethodInfo Source

Instances

((~) * signature (m Device), MonadIO m) => MethodInfo * MessageParseDeviceAddedMethodInfo Message signature Source 

messageParseDeviceAdded :: MonadIO m => Message -> m Device Source

messageParseDeviceRemoved

data MessageParseDeviceRemovedMethodInfo Source

Instances

messageParseDeviceRemoved :: MonadIO m => Message -> m Device Source

messageParseError

data MessageParseErrorMethodInfo Source

Instances

((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseErrorMethodInfo Message signature Source 

messageParseError :: MonadIO m => Message -> m (GError, Text) Source

messageParseGroupId

data MessageParseGroupIdMethodInfo Source

Instances

((~) * signature (m (Bool, Word32)), MonadIO m) => MethodInfo * MessageParseGroupIdMethodInfo Message signature Source 

messageParseGroupId :: MonadIO m => Message -> m (Bool, Word32) Source

messageParseHaveContext

data MessageParseHaveContextMethodInfo Source

Instances

((~) * signature (m Context), MonadIO m) => MethodInfo * MessageParseHaveContextMethodInfo Message signature Source 

messageParseHaveContext :: MonadIO m => Message -> m Context Source

messageParseInfo

data MessageParseInfoMethodInfo Source

Instances

((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseInfoMethodInfo Message signature Source 

messageParseInfo :: MonadIO m => Message -> m (GError, Text) Source

messageParseNewClock

data MessageParseNewClockMethodInfo Source

Instances

((~) * signature (m Clock), MonadIO m) => MethodInfo * MessageParseNewClockMethodInfo Message signature Source 

messageParseNewClock :: MonadIO m => Message -> m Clock Source

messageParseProgress

data MessageParseProgressMethodInfo Source

Instances

messageParseProgress :: MonadIO m => Message -> m (ProgressType, Text, Text) Source

messageParseQos

data MessageParseQosMethodInfo Source

Instances

((~) * signature (m (Bool, Word64, Word64, Word64, Word64)), MonadIO m) => MethodInfo * MessageParseQosMethodInfo Message signature Source 

messageParseQos :: MonadIO m => Message -> m (Bool, Word64, Word64, Word64, Word64) Source

messageParseQosStats

data MessageParseQosStatsMethodInfo Source

Instances

((~) * signature (m (Format, Word64, Word64)), MonadIO m) => MethodInfo * MessageParseQosStatsMethodInfo Message signature Source 

messageParseQosStats :: MonadIO m => Message -> m (Format, Word64, Word64) Source

messageParseQosValues

data MessageParseQosValuesMethodInfo Source

Instances

((~) * signature (m (Int64, Double, Int32)), MonadIO m) => MethodInfo * MessageParseQosValuesMethodInfo Message signature Source 

messageParseQosValues :: MonadIO m => Message -> m (Int64, Double, Int32) Source

messageParseRequestState

data MessageParseRequestStateMethodInfo Source

Instances

((~) * signature (m State), MonadIO m) => MethodInfo * MessageParseRequestStateMethodInfo Message signature Source 

messageParseRequestState :: MonadIO m => Message -> m State Source

messageParseResetTime

data MessageParseResetTimeMethodInfo Source

Instances

((~) * signature (m Word64), MonadIO m) => MethodInfo * MessageParseResetTimeMethodInfo Message signature Source 

messageParseResetTime :: MonadIO m => Message -> m Word64 Source

messageParseSegmentDone

data MessageParseSegmentDoneMethodInfo Source

Instances

((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * MessageParseSegmentDoneMethodInfo Message signature Source 

messageParseSegmentDone :: MonadIO m => Message -> m (Format, Int64) Source

messageParseSegmentStart

data MessageParseSegmentStartMethodInfo Source

Instances

((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * MessageParseSegmentStartMethodInfo Message signature Source 

messageParseSegmentStart :: MonadIO m => Message -> m (Format, Int64) Source

messageParseStateChanged

data MessageParseStateChangedMethodInfo Source

Instances

((~) * signature (m (State, State, State)), MonadIO m) => MethodInfo * MessageParseStateChangedMethodInfo Message signature Source 

messageParseStateChanged :: MonadIO m => Message -> m (State, State, State) Source

messageParseStepDone

data MessageParseStepDoneMethodInfo Source

Instances

messageParseStepDone :: MonadIO m => Message -> m (Format, Word64, Double, Bool, Bool, Word64, Bool) Source

messageParseStepStart

data MessageParseStepStartMethodInfo Source

Instances

messageParseStepStart :: MonadIO m => Message -> m (Bool, Format, Word64, Double, Bool, Bool) Source

messageParseStreamStatus

data MessageParseStreamStatusMethodInfo Source

Instances

messageParseStreamStatus :: MonadIO m => Message -> m (StreamStatusType, Element) Source

messageParseStructureChange

data MessageParseStructureChangeMethodInfo Source

Instances

messageParseStructureChange :: MonadIO m => Message -> m (StructureChangeType, Element, Bool) Source

messageParseTag

data MessageParseTagMethodInfo Source

Instances

((~) * signature (m TagList), MonadIO m) => MethodInfo * MessageParseTagMethodInfo Message signature Source 

messageParseTag :: MonadIO m => Message -> m TagList Source

messageParseToc

data MessageParseTocMethodInfo Source

Instances

((~) * signature (m (Toc, Bool)), MonadIO m) => MethodInfo * MessageParseTocMethodInfo Message signature Source 

messageParseToc :: MonadIO m => Message -> m (Toc, Bool) Source

messageParseWarning

data MessageParseWarningMethodInfo Source

Instances

((~) * signature (m (GError, Text)), MonadIO m) => MethodInfo * MessageParseWarningMethodInfo Message signature Source 

messageParseWarning :: MonadIO m => Message -> m (GError, Text) Source

messageSetBufferingStats

data MessageSetBufferingStatsMethodInfo Source

Instances

((~) * signature (BufferingMode -> Int32 -> Int32 -> Int64 -> m ()), MonadIO m) => MethodInfo * MessageSetBufferingStatsMethodInfo Message signature Source 

messageSetBufferingStats :: MonadIO m => Message -> BufferingMode -> Int32 -> Int32 -> Int64 -> m () Source

messageSetGroupId

data MessageSetGroupIdMethodInfo Source

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * MessageSetGroupIdMethodInfo Message signature Source 

messageSetGroupId :: MonadIO m => Message -> Word32 -> m () Source

messageSetQosStats

data MessageSetQosStatsMethodInfo Source

Instances

((~) * signature (Format -> Word64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MessageSetQosStatsMethodInfo Message signature Source 

messageSetQosStats :: MonadIO m => Message -> Format -> Word64 -> Word64 -> m () Source

messageSetQosValues

data MessageSetQosValuesMethodInfo Source

Instances

((~) * signature (Int64 -> Double -> Int32 -> m ()), MonadIO m) => MethodInfo * MessageSetQosValuesMethodInfo Message signature Source 

messageSetQosValues :: MonadIO m => Message -> Int64 -> Double -> Int32 -> m () Source

messageSetSeqnum

data MessageSetSeqnumMethodInfo Source

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * MessageSetSeqnumMethodInfo Message signature Source 

messageSetSeqnum :: MonadIO m => Message -> Word32 -> m () Source

messageSetStreamStatusObject

data MessageSetStreamStatusObjectMethodInfo Source

Instances

((~) * signature (GValue -> m ()), MonadIO m) => MethodInfo * MessageSetStreamStatusObjectMethodInfo Message signature Source 

messageSetStreamStatusObject :: MonadIO m => Message -> GValue -> m () Source

Properties

MiniObject

messageClearMiniObject :: MonadIO m => Message -> m () Source

messageMiniObject :: AttrLabelProxy "miniObject" Source

messageReadMiniObject :: MonadIO m => Message -> m (Maybe MiniObject) Source

messageWriteMiniObject :: MonadIO m => Message -> Ptr MiniObject -> m () Source

Seqnum

messageReadSeqnum :: MonadIO m => Message -> m Word32 Source

messageSeqnum :: AttrLabelProxy "seqnum" Source

messageWriteSeqnum :: MonadIO m => Message -> Word32 -> m () Source

Src

messageClearSrc :: MonadIO m => Message -> m () Source

messageReadSrc :: MonadIO m => Message -> m (Maybe Object) Source

messageSrc :: AttrLabelProxy "src" Source

messageWriteSrc :: MonadIO m => Message -> Ptr Object -> m () Source

Timestamp

messageReadTimestamp :: MonadIO m => Message -> m Word64 Source

messageTimestamp :: AttrLabelProxy "timestamp" Source

messageWriteTimestamp :: MonadIO m => Message -> Word64 -> m () Source

Type

messageReadType :: MonadIO m => Message -> m [MessageType] Source

messageType :: AttrLabelProxy "type" Source

messageWriteType :: MonadIO m => Message -> [MessageType] -> m () Source