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 |
- Exported types
- Methods
- messageGetSeqnum
- messageGetStreamStatusObject
- messageGetStructure
- messageHasName
- messageNewApplication
- messageNewAsyncDone
- messageNewAsyncStart
- messageNewBuffering
- messageNewClockLost
- messageNewClockProvide
- messageNewCustom
- messageNewDeviceAdded
- messageNewDeviceRemoved
- messageNewDurationChanged
- messageNewElement
- messageNewEos
- messageNewError
- messageNewHaveContext
- messageNewInfo
- messageNewLatency
- messageNewNeedContext
- messageNewNewClock
- messageNewProgress
- messageNewQos
- messageNewRequestState
- messageNewResetTime
- messageNewSegmentDone
- messageNewSegmentStart
- messageNewStateChanged
- messageNewStateDirty
- messageNewStepDone
- messageNewStepStart
- messageNewStreamStart
- messageNewStreamStatus
- messageNewStructureChange
- messageNewTag
- messageNewToc
- messageNewWarning
- messageParseAsyncDone
- messageParseBuffering
- messageParseBufferingStats
- messageParseClockLost
- messageParseClockProvide
- messageParseContextType
- messageParseDeviceAdded
- messageParseDeviceRemoved
- messageParseError
- messageParseGroupId
- messageParseHaveContext
- messageParseInfo
- messageParseNewClock
- messageParseProgress
- messageParseQos
- messageParseQosStats
- messageParseQosValues
- messageParseRequestState
- messageParseResetTime
- messageParseSegmentDone
- messageParseSegmentStart
- messageParseStateChanged
- messageParseStepDone
- messageParseStepStart
- messageParseStreamStatus
- messageParseStructureChange
- messageParseTag
- messageParseToc
- messageParseWarning
- messageSetBufferingStats
- messageSetGroupId
- messageSetQosStats
- messageSetQosValues
- messageSetSeqnum
- messageSetStreamStatusObject
- Properties
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().
- newtype Message = Message (ForeignPtr Message)
- newZeroMessage :: MonadIO m => m Message
- noMessage :: Maybe Message
- data MessageGetSeqnumMethodInfo
- messageGetSeqnum :: MonadIO m => Message -> m Word32
- data MessageGetStreamStatusObjectMethodInfo
- messageGetStreamStatusObject :: MonadIO m => Message -> m GValue
- data MessageGetStructureMethodInfo
- messageGetStructure :: MonadIO m => Message -> m Structure
- data MessageHasNameMethodInfo
- messageHasName :: MonadIO m => Message -> Text -> m Bool
- messageNewApplication :: (MonadIO m, ObjectK a) => Maybe a -> Structure -> m Message
- messageNewAsyncDone :: (MonadIO m, ObjectK a) => Maybe a -> Word64 -> m Message
- messageNewAsyncStart :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewBuffering :: (MonadIO m, ObjectK a) => Maybe a -> Int32 -> m Message
- messageNewClockLost :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> m Message
- messageNewClockProvide :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> Bool -> m Message
- messageNewCustom :: (MonadIO m, ObjectK a) => [MessageType] -> Maybe a -> Maybe Structure -> m Message
- messageNewDeviceAdded :: (MonadIO m, ObjectK a, DeviceK b) => a -> b -> m Message
- messageNewDeviceRemoved :: (MonadIO m, ObjectK a, DeviceK b) => a -> b -> m Message
- messageNewDurationChanged :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewElement :: (MonadIO m, ObjectK a) => Maybe a -> Structure -> m Message
- messageNewEos :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewError :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message
- messageNewHaveContext :: (MonadIO m, ObjectK a) => Maybe a -> Context -> m Message
- messageNewInfo :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message
- messageNewLatency :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewNeedContext :: (MonadIO m, ObjectK a) => Maybe a -> Text -> m Message
- messageNewNewClock :: (MonadIO m, ObjectK a, ClockK b) => Maybe a -> b -> m Message
- messageNewProgress :: (MonadIO m, ObjectK a) => a -> ProgressType -> Text -> Text -> m Message
- messageNewQos :: (MonadIO m, ObjectK a) => a -> Bool -> Word64 -> Word64 -> Word64 -> Word64 -> m Message
- messageNewRequestState :: (MonadIO m, ObjectK a) => Maybe a -> State -> m Message
- messageNewResetTime :: (MonadIO m, ObjectK a) => Maybe a -> Word64 -> m Message
- messageNewSegmentDone :: (MonadIO m, ObjectK a) => Maybe a -> Format -> Int64 -> m Message
- messageNewSegmentStart :: (MonadIO m, ObjectK a) => Maybe a -> Format -> Int64 -> m Message
- messageNewStateChanged :: (MonadIO m, ObjectK a) => Maybe a -> State -> State -> State -> m Message
- messageNewStateDirty :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewStepDone :: (MonadIO m, ObjectK a) => a -> Format -> Word64 -> Double -> Bool -> Bool -> Word64 -> Bool -> m Message
- messageNewStepStart :: (MonadIO m, ObjectK a) => a -> Bool -> Format -> Word64 -> Double -> Bool -> Bool -> m Message
- messageNewStreamStart :: (MonadIO m, ObjectK a) => Maybe a -> m Message
- messageNewStreamStatus :: (MonadIO m, ObjectK a, ElementK b) => a -> StreamStatusType -> b -> m Message
- messageNewStructureChange :: (MonadIO m, ObjectK a, ElementK b) => Maybe a -> StructureChangeType -> b -> Bool -> m Message
- messageNewTag :: (MonadIO m, ObjectK a) => Maybe a -> TagList -> m Message
- messageNewToc :: (MonadIO m, ObjectK a) => a -> Toc -> Bool -> m Message
- messageNewWarning :: (MonadIO m, ObjectK a) => Maybe a -> GError -> Text -> m Message
- data MessageParseAsyncDoneMethodInfo
- messageParseAsyncDone :: MonadIO m => Message -> m Word64
- data MessageParseBufferingMethodInfo
- messageParseBuffering :: MonadIO m => Message -> m Int32
- data MessageParseBufferingStatsMethodInfo
- messageParseBufferingStats :: MonadIO m => Message -> m (BufferingMode, Int32, Int32, Int64)
- data MessageParseClockLostMethodInfo
- messageParseClockLost :: MonadIO m => Message -> m Clock
- data MessageParseClockProvideMethodInfo
- messageParseClockProvide :: MonadIO m => Message -> m (Clock, Bool)
- data MessageParseContextTypeMethodInfo
- messageParseContextType :: MonadIO m => Message -> m (Bool, Text)
- data MessageParseDeviceAddedMethodInfo
- messageParseDeviceAdded :: MonadIO m => Message -> m Device
- data MessageParseDeviceRemovedMethodInfo
- messageParseDeviceRemoved :: MonadIO m => Message -> m Device
- data MessageParseErrorMethodInfo
- messageParseError :: MonadIO m => Message -> m (GError, Text)
- data MessageParseGroupIdMethodInfo
- messageParseGroupId :: MonadIO m => Message -> m (Bool, Word32)
- data MessageParseHaveContextMethodInfo
- messageParseHaveContext :: MonadIO m => Message -> m Context
- data MessageParseInfoMethodInfo
- messageParseInfo :: MonadIO m => Message -> m (GError, Text)
- data MessageParseNewClockMethodInfo
- messageParseNewClock :: MonadIO m => Message -> m Clock
- data MessageParseProgressMethodInfo
- messageParseProgress :: MonadIO m => Message -> m (ProgressType, Text, Text)
- data MessageParseQosMethodInfo
- messageParseQos :: MonadIO m => Message -> m (Bool, Word64, Word64, Word64, Word64)
- data MessageParseQosStatsMethodInfo
- messageParseQosStats :: MonadIO m => Message -> m (Format, Word64, Word64)
- data MessageParseQosValuesMethodInfo
- messageParseQosValues :: MonadIO m => Message -> m (Int64, Double, Int32)
- data MessageParseRequestStateMethodInfo
- messageParseRequestState :: MonadIO m => Message -> m State
- data MessageParseResetTimeMethodInfo
- messageParseResetTime :: MonadIO m => Message -> m Word64
- data MessageParseSegmentDoneMethodInfo
- messageParseSegmentDone :: MonadIO m => Message -> m (Format, Int64)
- data MessageParseSegmentStartMethodInfo
- messageParseSegmentStart :: MonadIO m => Message -> m (Format, Int64)
- data MessageParseStateChangedMethodInfo
- messageParseStateChanged :: MonadIO m => Message -> m (State, State, State)
- data MessageParseStepDoneMethodInfo
- messageParseStepDone :: MonadIO m => Message -> m (Format, Word64, Double, Bool, Bool, Word64, Bool)
- data MessageParseStepStartMethodInfo
- messageParseStepStart :: MonadIO m => Message -> m (Bool, Format, Word64, Double, Bool, Bool)
- data MessageParseStreamStatusMethodInfo
- messageParseStreamStatus :: MonadIO m => Message -> m (StreamStatusType, Element)
- data MessageParseStructureChangeMethodInfo
- messageParseStructureChange :: MonadIO m => Message -> m (StructureChangeType, Element, Bool)
- data MessageParseTagMethodInfo
- messageParseTag :: MonadIO m => Message -> m TagList
- data MessageParseTocMethodInfo
- messageParseToc :: MonadIO m => Message -> m (Toc, Bool)
- data MessageParseWarningMethodInfo
- messageParseWarning :: MonadIO m => Message -> m (GError, Text)
- data MessageSetBufferingStatsMethodInfo
- messageSetBufferingStats :: MonadIO m => Message -> BufferingMode -> Int32 -> Int32 -> Int64 -> m ()
- data MessageSetGroupIdMethodInfo
- messageSetGroupId :: MonadIO m => Message -> Word32 -> m ()
- data MessageSetQosStatsMethodInfo
- messageSetQosStats :: MonadIO m => Message -> Format -> Word64 -> Word64 -> m ()
- data MessageSetQosValuesMethodInfo
- messageSetQosValues :: MonadIO m => Message -> Int64 -> Double -> Int32 -> m ()
- data MessageSetSeqnumMethodInfo
- messageSetSeqnum :: MonadIO m => Message -> Word32 -> m ()
- data MessageSetStreamStatusObjectMethodInfo
- messageSetStreamStatusObject :: MonadIO m => Message -> GValue -> m ()
- messageReadMiniObject :: Message -> IO MiniObject
- messageReadSeqnum :: Message -> IO Word32
- messageReadSrc :: Message -> IO Object
- messageReadTimestamp :: Message -> IO Word64
- messageReadType :: Message -> IO [MessageType]
Exported types
newZeroMessage :: MonadIO m => m Message Source
Construct a Message
struct initialized to zero.
Methods
messageGetSeqnum
data MessageGetSeqnumMethodInfo Source
((~) (TYPE Lifted) signature (m Word32), MonadIO m) => MethodInfo (TYPE Lifted) MessageGetSeqnumMethodInfo Message signature Source | |
messageGetSeqnum :: MonadIO m => Message -> m Word32 Source
messageGetStreamStatusObject
data MessageGetStreamStatusObjectMethodInfo Source
((~) (TYPE Lifted) signature (m GValue), MonadIO m) => MethodInfo (TYPE Lifted) MessageGetStreamStatusObjectMethodInfo Message signature Source | |
messageGetStreamStatusObject :: MonadIO m => Message -> m GValue Source
messageGetStructure
data MessageGetStructureMethodInfo Source
((~) (TYPE Lifted) signature (m Structure), MonadIO m) => MethodInfo (TYPE Lifted) MessageGetStructureMethodInfo Message signature Source | |
messageGetStructure :: MonadIO m => Message -> m Structure Source
messageHasName
messageNewApplication
messageNewAsyncDone
messageNewAsyncStart
messageNewBuffering
messageNewClockLost
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
messageNewDeviceRemoved
messageNewDurationChanged
messageNewElement
messageNewEos
messageNewError
messageNewHaveContext
messageNewInfo
messageNewLatency
messageNewNeedContext
messageNewNewClock
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
messageNewResetTime
messageNewSegmentDone
messageNewSegmentStart
messageNewStateChanged
messageNewStateChanged :: (MonadIO m, ObjectK a) => Maybe a -> State -> State -> State -> m Message Source
messageNewStateDirty
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
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
messageNewToc
messageNewWarning
messageParseAsyncDone
data MessageParseAsyncDoneMethodInfo Source
((~) (TYPE Lifted) signature (m Word64), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseAsyncDoneMethodInfo Message signature Source | |
messageParseAsyncDone :: MonadIO m => Message -> m Word64 Source
messageParseBuffering
data MessageParseBufferingMethodInfo Source
((~) (TYPE Lifted) signature (m Int32), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseBufferingMethodInfo Message signature Source | |
messageParseBuffering :: MonadIO m => Message -> m Int32 Source
messageParseBufferingStats
data MessageParseBufferingStatsMethodInfo Source
((~) (TYPE Lifted) signature (m (BufferingMode, Int32, Int32, Int64)), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseBufferingStatsMethodInfo Message signature Source | |
messageParseBufferingStats :: MonadIO m => Message -> m (BufferingMode, Int32, Int32, Int64) Source
messageParseClockLost
data MessageParseClockLostMethodInfo Source
((~) (TYPE Lifted) signature (m Clock), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseClockLostMethodInfo Message signature Source | |
messageParseClockLost :: MonadIO m => Message -> m Clock Source
messageParseClockProvide
messageParseContextType
messageParseDeviceAdded
data MessageParseDeviceAddedMethodInfo Source
((~) (TYPE Lifted) signature (m Device), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseDeviceAddedMethodInfo Message signature Source | |
messageParseDeviceAdded :: MonadIO m => Message -> m Device Source
messageParseDeviceRemoved
data MessageParseDeviceRemovedMethodInfo Source
((~) (TYPE Lifted) signature (m Device), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseDeviceRemovedMethodInfo Message signature Source | |
messageParseDeviceRemoved :: MonadIO m => Message -> m Device Source
messageParseError
messageParseGroupId
messageParseHaveContext
data MessageParseHaveContextMethodInfo Source
((~) (TYPE Lifted) signature (m Context), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseHaveContextMethodInfo Message signature Source | |
messageParseHaveContext :: MonadIO m => Message -> m Context Source
messageParseInfo
messageParseNewClock
data MessageParseNewClockMethodInfo Source
((~) (TYPE Lifted) signature (m Clock), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseNewClockMethodInfo Message signature Source | |
messageParseNewClock :: MonadIO m => Message -> m Clock Source
messageParseProgress
data MessageParseProgressMethodInfo Source
((~) (TYPE Lifted) signature (m (ProgressType, Text, Text)), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseProgressMethodInfo Message signature Source | |
messageParseProgress :: MonadIO m => Message -> m (ProgressType, Text, Text) Source
messageParseQos
messageParseQosStats
messageParseQosValues
messageParseRequestState
data MessageParseRequestStateMethodInfo Source
((~) (TYPE Lifted) signature (m State), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseRequestStateMethodInfo Message signature Source | |
messageParseRequestState :: MonadIO m => Message -> m State Source
messageParseResetTime
data MessageParseResetTimeMethodInfo Source
((~) (TYPE Lifted) signature (m Word64), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseResetTimeMethodInfo Message signature Source | |
messageParseResetTime :: MonadIO m => Message -> m Word64 Source
messageParseSegmentDone
messageParseSegmentStart
messageParseStateChanged
messageParseStepDone
messageParseStepDone :: MonadIO m => Message -> m (Format, Word64, Double, Bool, Bool, Word64, Bool) Source
messageParseStepStart
messageParseStepStart :: MonadIO m => Message -> m (Bool, Format, Word64, Double, Bool, Bool) Source
messageParseStreamStatus
data MessageParseStreamStatusMethodInfo Source
((~) (TYPE Lifted) signature (m (StreamStatusType, Element)), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseStreamStatusMethodInfo Message signature Source | |
messageParseStreamStatus :: MonadIO m => Message -> m (StreamStatusType, Element) Source
messageParseStructureChange
data MessageParseStructureChangeMethodInfo Source
((~) (TYPE Lifted) signature (m (StructureChangeType, Element, Bool)), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseStructureChangeMethodInfo Message signature Source | |
messageParseStructureChange :: MonadIO m => Message -> m (StructureChangeType, Element, Bool) Source
messageParseTag
data MessageParseTagMethodInfo Source
((~) (TYPE Lifted) signature (m TagList), MonadIO m) => MethodInfo (TYPE Lifted) MessageParseTagMethodInfo Message signature Source | |
messageParseTag :: MonadIO m => Message -> m TagList Source
messageParseToc
messageParseWarning
messageSetBufferingStats
data MessageSetBufferingStatsMethodInfo Source
((~) (TYPE Lifted) signature (BufferingMode -> Int32 -> Int32 -> Int64 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageSetBufferingStatsMethodInfo Message signature Source | |
messageSetBufferingStats :: MonadIO m => Message -> BufferingMode -> Int32 -> Int32 -> Int64 -> m () Source
messageSetGroupId
data MessageSetGroupIdMethodInfo Source
((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageSetGroupIdMethodInfo Message signature Source | |
messageSetGroupId :: MonadIO m => Message -> Word32 -> m () Source
messageSetQosStats
messageSetQosValues
messageSetSeqnum
data MessageSetSeqnumMethodInfo Source
((~) (TYPE Lifted) signature (Word32 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageSetSeqnumMethodInfo Message signature Source | |
messageSetSeqnum :: MonadIO m => Message -> Word32 -> m () Source
messageSetStreamStatusObject
data MessageSetStreamStatusObjectMethodInfo Source
((~) (TYPE Lifted) signature (GValue -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageSetStreamStatusObjectMethodInfo Message signature Source | |
messageSetStreamStatusObject :: MonadIO m => Message -> GValue -> m () Source
Properties
MiniObject
Seqnum
messageReadSeqnum :: Message -> IO Word32 Source
Src
messageReadSrc :: Message -> IO Object Source
Timestamp
Type
messageReadType :: Message -> IO [MessageType] Source