| 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.GstBase.Structs.BaseParseFrame
Contents
Description
Frame (context) data passed to each frame parsing virtual methods. In addition to providing the data to be checked for a valid frame or an already identified frame, it conveys additional metadata or control information from and to the subclass w.r.t. the particular frame in question (rather than global parameters). Some of these may apply to each parsing stage, others only to some a particular one. These parameters are effectively zeroed at start of each frame's processing, i.e. parsing virtual method invocation sequence.
- newtype BaseParseFrame = BaseParseFrame (ForeignPtr BaseParseFrame)
- newZeroBaseParseFrame :: MonadIO m => m BaseParseFrame
- noBaseParseFrame :: Maybe BaseParseFrame
- data BaseParseFrameFreeMethodInfo
- baseParseFrameFree :: MonadIO m => BaseParseFrame -> m ()
- data BaseParseFrameInitMethodInfo
- baseParseFrameInit :: MonadIO m => BaseParseFrame -> m ()
- baseParseFrameNew :: MonadIO m => Buffer -> [BaseParseFrameFlags] -> Int32 -> m BaseParseFrame
- baseParseFrameBuffer :: AttrLabelProxy "buffer"
- baseParseFrameClearBuffer :: MonadIO m => BaseParseFrame -> m ()
- baseParseFrameReadBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer)
- baseParseFrameWriteBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m ()
- baseParseFrameFlags :: AttrLabelProxy "flags"
- baseParseFrameReadFlags :: MonadIO m => BaseParseFrame -> m Word32
- baseParseFrameWriteFlags :: MonadIO m => BaseParseFrame -> Word32 -> m ()
- baseParseFrameOffset :: AttrLabelProxy "offset"
- baseParseFrameReadOffset :: MonadIO m => BaseParseFrame -> m Word64
- baseParseFrameWriteOffset :: MonadIO m => BaseParseFrame -> Word64 -> m ()
- baseParseFrameClearOutBuffer :: MonadIO m => BaseParseFrame -> m ()
- baseParseFrameOutBuffer :: AttrLabelProxy "outBuffer"
- baseParseFrameReadOutBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer)
- baseParseFrameWriteOutBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m ()
- baseParseFrameOverhead :: AttrLabelProxy "overhead"
- baseParseFrameReadOverhead :: MonadIO m => BaseParseFrame -> m Int32
- baseParseFrameWriteOverhead :: MonadIO m => BaseParseFrame -> Int32 -> m ()
Exported types
newtype BaseParseFrame Source
Constructors
| BaseParseFrame (ForeignPtr BaseParseFrame) |
Instances
| BoxedObject BaseParseFrame Source | |
| (~) AttrOpTag tag AttrSet => Constructible BaseParseFrame tag Source | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * BaseParseFrameInitMethodInfo BaseParseFrame signature Source | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * BaseParseFrameFreeMethodInfo BaseParseFrame signature Source | |
| ((~) * info (ResolveBaseParseFrameMethod t BaseParseFrame), MethodInfo * info BaseParseFrame p) => IsLabelProxy t (BaseParseFrame -> p) Source | |
| type AttributeList BaseParseFrame Source |
newZeroBaseParseFrame :: MonadIO m => m BaseParseFrame Source
Construct a BaseParseFrame struct initialized to zero.
Methods
baseParseFrameFree
data BaseParseFrameFreeMethodInfo Source
Instances
| ((~) * signature (m ()), MonadIO m) => MethodInfo * BaseParseFrameFreeMethodInfo BaseParseFrame signature Source |
baseParseFrameFree :: MonadIO m => BaseParseFrame -> m () Source
baseParseFrameInit
data BaseParseFrameInitMethodInfo Source
Instances
| ((~) * signature (m ()), MonadIO m) => MethodInfo * BaseParseFrameInitMethodInfo BaseParseFrame signature Source |
baseParseFrameInit :: MonadIO m => BaseParseFrame -> m () Source
baseParseFrameNew
baseParseFrameNew :: MonadIO m => Buffer -> [BaseParseFrameFlags] -> Int32 -> m BaseParseFrame Source
Properties
Buffer
baseParseFrameBuffer :: AttrLabelProxy "buffer" Source
baseParseFrameClearBuffer :: MonadIO m => BaseParseFrame -> m () Source
baseParseFrameReadBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer) Source
baseParseFrameWriteBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m () Source
Flags
baseParseFrameFlags :: AttrLabelProxy "flags" Source
baseParseFrameReadFlags :: MonadIO m => BaseParseFrame -> m Word32 Source
baseParseFrameWriteFlags :: MonadIO m => BaseParseFrame -> Word32 -> m () Source
Offset
baseParseFrameOffset :: AttrLabelProxy "offset" Source
baseParseFrameReadOffset :: MonadIO m => BaseParseFrame -> m Word64 Source
baseParseFrameWriteOffset :: MonadIO m => BaseParseFrame -> Word64 -> m () Source
OutBuffer
baseParseFrameClearOutBuffer :: MonadIO m => BaseParseFrame -> m () Source
baseParseFrameOutBuffer :: AttrLabelProxy "outBuffer" Source
baseParseFrameReadOutBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer) Source
baseParseFrameWriteOutBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m () Source
Overhead
baseParseFrameOverhead :: AttrLabelProxy "overhead" Source
baseParseFrameReadOverhead :: MonadIO m => BaseParseFrame -> m Int32 Source
baseParseFrameWriteOverhead :: MonadIO m => BaseParseFrame -> Int32 -> m () Source