| 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.Message
Contents
- Exported types
- Methods
- getSeqnum
- getStreamStatusObject
- getStructure
- hasName
- newApplication
- newAsyncDone
- newAsyncStart
- newBuffering
- newClockLost
- newClockProvide
- newCustom
- newDeviceAdded
- newDeviceRemoved
- newDurationChanged
- newElement
- newEos
- newError
- newHaveContext
- newInfo
- newLatency
- newNeedContext
- newNewClock
- newProgress
- newQos
- newRequestState
- newResetTime
- newSegmentDone
- newSegmentStart
- newStateChanged
- newStateDirty
- newStepDone
- newStepStart
- newStreamStart
- newStreamStatus
- newStructureChange
- newTag
- newToc
- newWarning
- parseAsyncDone
- parseBuffering
- parseBufferingStats
- parseClockLost
- parseClockProvide
- parseContextType
- parseDeviceAdded
- parseDeviceRemoved
- parseError
- parseGroupId
- parseHaveContext
- parseInfo
- parseNewClock
- parseProgress
- parseQos
- parseQosStats
- parseQosValues
- parseRequestState
- parseResetTime
- parseSegmentDone
- parseSegmentStart
- parseStateChanged
- parseStepDone
- parseStepStart
- parseStreamStatus
- parseStructureChange
- parseTag
- parseToc
- parseWarning
- setBufferingStats
- setGroupId
- setQosStats
- setQosValues
- setSeqnum
- setStreamStatusObject
- Properties
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: |[language="C" -- 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 (ManagedPtr 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, IsObject a) => Maybe a -> Structure -> m Message
- messageNewAsyncDone :: (MonadIO m, IsObject a) => Maybe a -> Word64 -> m Message
- messageNewAsyncStart :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewBuffering :: (MonadIO m, IsObject a) => Maybe a -> Int32 -> m Message
- messageNewClockLost :: (MonadIO m, IsObject a, IsClock b) => Maybe a -> b -> m Message
- messageNewClockProvide :: (MonadIO m, IsObject a, IsClock b) => Maybe a -> b -> Bool -> m Message
- messageNewCustom :: (MonadIO m, IsObject a) => [MessageType] -> Maybe a -> Maybe Structure -> m Message
- messageNewDeviceAdded :: (MonadIO m, IsObject a, IsDevice b) => a -> b -> m Message
- messageNewDeviceRemoved :: (MonadIO m, IsObject a, IsDevice b) => a -> b -> m Message
- messageNewDurationChanged :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewElement :: (MonadIO m, IsObject a) => Maybe a -> Structure -> m Message
- messageNewEos :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewError :: (MonadIO m, IsObject a) => Maybe a -> GError -> Text -> m Message
- messageNewHaveContext :: (MonadIO m, IsObject a) => Maybe a -> Context -> m Message
- messageNewInfo :: (MonadIO m, IsObject a) => Maybe a -> GError -> Text -> m Message
- messageNewLatency :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewNeedContext :: (MonadIO m, IsObject a) => Maybe a -> Text -> m Message
- messageNewNewClock :: (MonadIO m, IsObject a, IsClock b) => Maybe a -> b -> m Message
- messageNewProgress :: (MonadIO m, IsObject a) => a -> ProgressType -> Text -> Text -> m Message
- messageNewQos :: (MonadIO m, IsObject a) => a -> Bool -> Word64 -> Word64 -> Word64 -> Word64 -> m Message
- messageNewRequestState :: (MonadIO m, IsObject a) => Maybe a -> State -> m Message
- messageNewResetTime :: (MonadIO m, IsObject a) => Maybe a -> Word64 -> m Message
- messageNewSegmentDone :: (MonadIO m, IsObject a) => Maybe a -> Format -> Int64 -> m Message
- messageNewSegmentStart :: (MonadIO m, IsObject a) => Maybe a -> Format -> Int64 -> m Message
- messageNewStateChanged :: (MonadIO m, IsObject a) => Maybe a -> State -> State -> State -> m Message
- messageNewStateDirty :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewStepDone :: (MonadIO m, IsObject a) => a -> Format -> Word64 -> Double -> Bool -> Bool -> Word64 -> Bool -> m Message
- messageNewStepStart :: (MonadIO m, IsObject a) => a -> Bool -> Format -> Word64 -> Double -> Bool -> Bool -> m Message
- messageNewStreamStart :: (MonadIO m, IsObject a) => Maybe a -> m Message
- messageNewStreamStatus :: (MonadIO m, IsObject a, IsElement b) => a -> StreamStatusType -> b -> m Message
- messageNewStructureChange :: (MonadIO m, IsObject a, IsElement b) => Maybe a -> StructureChangeType -> b -> Bool -> m Message
- messageNewTag :: (MonadIO m, IsObject a) => Maybe a -> TagList -> m Message
- messageNewToc :: (MonadIO m, IsObject a) => a -> Toc -> Bool -> m Message
- messageNewWarning :: (MonadIO m, IsObject 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 ()
- getMessageMiniObject :: MonadIO m => Message -> m MiniObject
- message_miniObject :: AttrLabelProxy "miniObject"
- getMessageSeqnum :: MonadIO m => Message -> m Word32
- message_seqnum :: AttrLabelProxy "seqnum"
- setMessageSeqnum :: MonadIO m => Message -> Word32 -> m ()
- clearMessageSrc :: MonadIO m => Message -> m ()
- getMessageSrc :: MonadIO m => Message -> m (Maybe Object)
- message_src :: AttrLabelProxy "src"
- setMessageSrc :: MonadIO m => Message -> Ptr Object -> m ()
- getMessageTimestamp :: MonadIO m => Message -> m Word64
- message_timestamp :: AttrLabelProxy "timestamp"
- setMessageTimestamp :: MonadIO m => Message -> Word64 -> m ()
- getMessageType :: MonadIO m => Message -> m [MessageType]
- message_type :: AttrLabelProxy "type"
- setMessageType :: MonadIO m => Message -> [MessageType] -> m ()
Exported types
Instances
Methods
getSeqnum
getStreamStatusObject
messageGetStreamStatusObject :: MonadIO m => Message -> m GValue Source #
getStructure
hasName
newApplication
newAsyncDone
newAsyncStart
newBuffering
newClockLost
newClockProvide
messageNewClockProvide :: (MonadIO m, IsObject a, IsClock b) => Maybe a -> b -> Bool -> m Message Source #
newCustom
messageNewCustom :: (MonadIO m, IsObject a) => [MessageType] -> Maybe a -> Maybe Structure -> m Message Source #
newDeviceAdded
newDeviceRemoved
newDurationChanged
newElement
newEos
newError
newHaveContext
newInfo
newLatency
newNeedContext
newNewClock
newProgress
messageNewProgress :: (MonadIO m, IsObject a) => a -> ProgressType -> Text -> Text -> m Message Source #
newQos
messageNewQos :: (MonadIO m, IsObject a) => a -> Bool -> Word64 -> Word64 -> Word64 -> Word64 -> m Message Source #
newRequestState
newResetTime
newSegmentDone
messageNewSegmentDone :: (MonadIO m, IsObject a) => Maybe a -> Format -> Int64 -> m Message Source #
newSegmentStart
messageNewSegmentStart :: (MonadIO m, IsObject a) => Maybe a -> Format -> Int64 -> m Message Source #
newStateChanged
messageNewStateChanged :: (MonadIO m, IsObject a) => Maybe a -> State -> State -> State -> m Message Source #
newStateDirty
newStepDone
messageNewStepDone :: (MonadIO m, IsObject a) => a -> Format -> Word64 -> Double -> Bool -> Bool -> Word64 -> Bool -> m Message Source #
newStepStart
messageNewStepStart :: (MonadIO m, IsObject a) => a -> Bool -> Format -> Word64 -> Double -> Bool -> Bool -> m Message Source #
newStreamStart
newStreamStatus
messageNewStreamStatus :: (MonadIO m, IsObject a, IsElement b) => a -> StreamStatusType -> b -> m Message Source #
newStructureChange
messageNewStructureChange :: (MonadIO m, IsObject a, IsElement b) => Maybe a -> StructureChangeType -> b -> Bool -> m Message Source #
newTag
newToc
newWarning
parseAsyncDone
parseBuffering
parseBufferingStats
messageParseBufferingStats :: MonadIO m => Message -> m (BufferingMode, Int32, Int32, Int64) Source #
parseClockLost
parseClockProvide
parseContextType
parseDeviceAdded
parseDeviceRemoved
parseError
messageParseError :: MonadIO m => Message -> m (GError, Text) Source #
parseGroupId
parseHaveContext
parseInfo
messageParseInfo :: MonadIO m => Message -> m (GError, Text) Source #
parseNewClock
parseProgress
data MessageParseProgressMethodInfo Source #
Instances
| ((~) * signature (m (ProgressType, Text, Text)), MonadIO m) => MethodInfo * MessageParseProgressMethodInfo Message signature Source # | |
messageParseProgress :: MonadIO m => Message -> m (ProgressType, Text, Text) Source #
parseQos
parseQosStats
parseQosValues
parseRequestState
parseResetTime
parseSegmentDone
parseSegmentStart
parseStateChanged
parseStepDone
messageParseStepDone :: MonadIO m => Message -> m (Format, Word64, Double, Bool, Bool, Word64, Bool) Source #
parseStepStart
messageParseStepStart :: MonadIO m => Message -> m (Bool, Format, Word64, Double, Bool, Bool) Source #
parseStreamStatus
data MessageParseStreamStatusMethodInfo Source #
Instances
| ((~) * signature (m (StreamStatusType, Element)), MonadIO m) => MethodInfo * MessageParseStreamStatusMethodInfo Message signature Source # | |
messageParseStreamStatus :: MonadIO m => Message -> m (StreamStatusType, Element) Source #
parseStructureChange
data MessageParseStructureChangeMethodInfo Source #
Instances
| ((~) * signature (m (StructureChangeType, Element, Bool)), MonadIO m) => MethodInfo * MessageParseStructureChangeMethodInfo Message signature Source # | |
messageParseStructureChange :: MonadIO m => Message -> m (StructureChangeType, Element, Bool) Source #
parseTag
parseToc
parseWarning
messageParseWarning :: MonadIO m => Message -> m (GError, Text) Source #
setBufferingStats
messageSetBufferingStats :: MonadIO m => Message -> BufferingMode -> Int32 -> Int32 -> Int64 -> m () Source #
setGroupId
setQosStats
setQosValues
setSeqnum
setStreamStatusObject
messageSetStreamStatusObject :: MonadIO m => Message -> GValue -> m () Source #
Properties
miniObject
getMessageMiniObject :: MonadIO m => Message -> m MiniObject Source #
message_miniObject :: AttrLabelProxy "miniObject" Source #
seqnum
message_seqnum :: AttrLabelProxy "seqnum" Source #
src
clearMessageSrc :: MonadIO m => Message -> m () Source #
message_src :: AttrLabelProxy "src" Source #
timestamp
message_timestamp :: AttrLabelProxy "timestamp" Source #
type
getMessageType :: MonadIO m => Message -> m [MessageType] Source #
message_type :: AttrLabelProxy "type" Source #
setMessageType :: MonadIO m => Message -> [MessageType] -> m () Source #