Menu
▾
▴
[Gtk2hs-commit] (main branch): gstreamer: document M.S.G.Core.Constants; add version checks, remove MessageStateDirty (deprecated)
|
From: Duncan C. <dun...@wo...> - 2007-11-10 18:17:42
|
Thu Nov 1 17:31:42 PDT 2007 Peter Gavin <pg...@gm...>
* gstreamer: document M.S.G.Core.Constants; add version checks, remove MessageStateDirty (deprecated)
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 25
--- [_$_]
+
+-- #hide
+ [_$_]
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 32
- [_$_]
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 33
- [_$_]
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 38
- [_$_]
+ BufferOffset,
+ bufferOffsetNone,
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 49
- bufferOffsetNone,
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 52
- [_$_]
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 57
+-- | A time value in nanoseconds.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 60
+-- | The undefined 'ClockTime' value.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 65
+-- | One second as a 'ClockTime' value.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 67
+-- | One millisecond as a 'ClockTime' value.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 69
+-- | One microsecond as a 'ClockTime' value.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 71
+-- | One nanosecond as a 'ClockTime' value.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 74
-data ObjectFlags = ObjectDisposing
+-- | The type for buffer offsets.
+type BufferOffset = Word64
+-- | The undefined 'BufferOffset' value.
+bufferOffsetNone :: BufferOffset
+bufferOffsetNone = #{const GST_BUFFER_OFFSET_NONE}
+
+-- | The flags that an 'Object' may have.
+data ObjectFlags = ObjectDisposing -- ^ The object has been
+ -- destroyed, don't use it any
+ -- more.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 90
-data PadFlags = PadBlocked
- | PadFlushing
- | PadInGetCaps
- | PadInSetCaps
- | PadBlocking
+-- | The flags that a 'Pad' may have.
+data PadFlags = PadBlocked -- ^ dataflow on the pad is blocked
+ | PadFlushing -- ^ the pad is refusing buffers
+ | PadInGetCaps -- ^ 'padGetCaps' is executing
+ | PadInSetCaps -- ^ 'padSetCaps' is executing
+ | PadBlocking -- ^ the pad is blocking on a buffer or event
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 110
-data ElementFlags = ElementLockedState
- | ElementIsSink
- | ElementUnparenting
+-- | The flags that an 'Element' may have.
+data ElementFlags = ElementLockedState -- ^ parent state changes are ignored
+ | ElementIsSink -- ^ the element is a sink
+ | ElementUnparenting -- ^ child is being removed
+ -- from the parent bin
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 125
-data StateChange = StateChangeNullToReady
- | StateChangeReadyToPaused
- | StateChangePausedToPlaying
- | StateChangePlayingToPaused
- | StateChangePausedToReady
- | StateChangeReadyToNull
+-- | The different state changes that are passed to the state change
+-- functions of 'Element's.
+data StateChange = StateChangeNullToReady -- ^ state change from 'StateNull' to 'StateReady'
+ | StateChangeReadyToPaused -- ^ state change from 'StateReady' to 'StatePaused'
+ | StateChangePausedToPlaying -- ^ state change from 'StatePaused' to 'StatePlaying'
+ | StateChangePlayingToPaused -- ^ state change from 'StatePlaying' to 'StatePaused'
+ | StateChangePausedToReady -- ^ state change from 'StatePaused' to 'StateReady'
+ | StateChangeReadyToNull -- ^ state change from 'StateReady' to 'StateNull'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 149
-data BusFlags = BusFlushing
+-- | The flags that a 'Bus' may have.
+data BusFlags = BusFlushing -- ^ the bus is currently dropping all messages
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 157
-data ClockFlags = ClockCanDoSingleSync
- | ClockCanDoSingleAsync
- | ClockCanDoPeriodicSync
- | ClockCanDoPeriodicAsync
- | ClockCanSetResolution
- | ClockCanSetMaster
+-- | The flags that a 'Clock' may have.
+data ClockFlags = ClockCanDoSingleSync -- ^ the clock can do a single sync timeout request
+ | ClockCanDoSingleAsync -- ^ the clock can do a single async timeout request
+ | ClockCanDoPeriodicSync -- ^ the clock can do periodic sync timeout requests
+ | ClockCanDoPeriodicAsync -- ^ the clock can do periodic async timeout requests
+ | ClockCanSetResolution -- ^ the clock's resolution can be changed
+ | ClockCanSetMaster -- ^ the clock can be slaved to a master clock
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 181
-data IndexFlags = IndexWritable
- | IndexReadable
+-- | The flags an 'Index' may have.
+data IndexFlags = IndexWritable -- ^ the index is writable
+ | IndexReadable -- ^ the index is readable
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 192
-data MiniObjectFlags = MiniObjectReadOnly
+-- | The flags a 'MiniObject' may have.
+data MiniObjectFlags = MiniObjectReadOnly -- ^ the object is not writable
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 200
-data BufferFlags = BufferPreroll
- | BufferDiscont
- | BufferInCaps
- | BufferGap
- | BufferDeltaUnit
+-- | The flags a 'Buffer' may have.
+data BufferFlags = BufferPreroll -- ^ the buffer is part of a preroll and should not be displayed
+ | BufferDiscont -- ^ the buffer marks a discontinuity in the stream
+ | BufferInCaps -- ^ the buffer has been added as a field in a 'Caps'
+ | BufferGap -- ^ the buffer has been created to fill a gap in the stream
+ | BufferDeltaUnit -- ^ the buffer cannot be decoded independently
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 220
-bufferOffsetNone :: Word64
-bufferOffsetNone = #{const GST_BUFFER_OFFSET_NONE}
-
-data EventType = EventUnknown
- | EventFlushStart
- | EventFlushStop
- | EventEOS
- | EventNewSegment
- | EventTag
- | EventBufferSize
- | EventQOS
- | EventSeek
- | EventNavigation
- | EventLatency
- | EventCustomUpstream
- | EventCustomDownstream
- | EventCustomDownstreamOOB
- | EventCustomBoth
- | EventCustomBothOOB
+-- | The event types that may occur in a pipeline.
+data EventType = EventUnknown -- ^ an unknown event
+ | EventFlushStart -- ^ start a flush operation
+ | EventFlushStop -- ^ stop a flush operation
+ | EventEOS -- ^ end of stream
+ | EventNewSegment -- ^ a new segment follows in the dataflow
+ | EventTag -- ^ a new set of metadata tags has been found
+ | EventBufferSize -- ^ notification of buffering requirements
+ | EventQOS -- ^ quality of service notification
+ | EventSeek -- ^ a request for a new playback position and rate
+ | EventNavigation -- ^ notification of user request
+#if GSTREAMER_CHECK_VERSION(0, 10, 12)
+ | EventLatency -- ^ notification of latency adjustment
+#endif
+ | EventCustomUpstream -- ^ custom upstream event
+ | EventCustomDownstream -- ^ custom downstream event
+ | EventCustomDownstreamOOB -- ^ custom downstream out-of-band event
+ | EventCustomBoth -- ^ custom bidirectional event
+ | EventCustomBothOOB -- ^ custom bidirectional out-of-band event
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 251
+#if GSTREAMER_CHECK_VERSION(0, 10, 12)
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 253
+#endif
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 270
+#if GSTREAMER_CHECK_VERSION(0, 10, 12)
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 272
+#endif
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 279
-data MessageType = MessageEOS
- | MessageError
- | MessageWarning
- | MessageInfo
- | MessageTag
- | MessageBuffering
- | MessageStateChanged
- | MessageStateDirty
- | MessageStepDone
- | MessageClockProvide
- | MessageClockLost
- | MessageNewClock
- | MessageStructureChange
- | MessageStreamStatus
- | MessageApplication
- | MessageElement
- | MessageSegmentStart
- | MessageSegmentDone
- | MessageDuration
- | MessageLatency
- | MessageAsyncStart
+-- | The messages types that may be sent by a pipeline.
+data MessageType = MessageEOS -- ^ end-of-stream
+ | MessageError -- ^ an error message
+ | MessageWarning -- ^ a warning message
+ | MessageInfo -- ^ an informational message
+ | MessageTag -- ^ a metadata tag
+ | MessageBuffering -- ^ the pipeline is buffering
+ | MessageStateChanged -- ^ the pipeline changed state
+ | MessageStepDone -- ^ a framestep finished
+ | MessageClockProvide -- ^ an element is able to provide a clock
+ | MessageClockLost -- ^ the current clock has become unusable
+ | MessageNewClock -- ^ a new clock was selected by the pipeline
+ | MessageStructureChange -- ^ the structure of the pipeline has changed
+ | MessageStreamStatus -- ^ a stream status message
+ | MessageApplication -- ^ a message posted by the application
+ | MessageElement -- ^ an element specific message
+ | MessageSegmentStart -- ^ the pipeline started playback of a segment
+ | MessageSegmentDone -- ^ the pipeline finished playback of a segment
+ | MessageDuration -- ^ the duration of the pipeline changed
+#if GSTREAMER_CHECK_VERSION(0, 10, 12)
+ | MessageLatency -- ^ an element's latency has changed
+#endif
+#if GSTREAMER_CHECK_VERSION(0, 10, 13)
+ | MessageAsyncStart -- ^ [_$_]
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 304
+#endif
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 314
- | n == #{const GST_MESSAGE_STATE_DIRTY} = MessageStateDirty
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 335
- fromEnum MessageStateDirty = #{const GST_MESSAGE_STATE_DIRTY}
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Constants.hsc 351
+-- | The flags that a 'Caps' may have.
|
