GI.GstBase.Structs.BaseParseFrame

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.

Exported types

newtype BaseParseFrame

Constructors

BaseParseFrame (ManagedPtr BaseParseFrame)

Instances

BoxedObject BaseParseFrame

Methods

boxedType :: BaseParseFrame -> IO GType

(~) AttrOpTag tag AttrSet => Constructible BaseParseFrame tag

Methods

new :: MonadIO m => (ManagedPtr BaseParseFrame -> BaseParseFrame) -> [AttrOp BaseParseFrame tag] -> m BaseParseFrame

newZeroBaseParseFrame :: MonadIO m => m BaseParseFrame

Construct a BaseParseFrame struct initialized to zero.

noBaseParseFrame :: Maybe BaseParseFrame

Methods

copy

baseParseFrameCopy :: (HasCallStack, MonadIO m) => BaseParseFrame -> m BaseParseFrame

No description available in the introspection data.

free

baseParseFrameFree :: (HasCallStack, MonadIO m) => BaseParseFrame -> m ()

No description available in the introspection data.

init

baseParseFrameInit

Arguments

:: (HasCallStack, MonadIO m)

=> BaseParseFrame

frame: BaseParseFrame.

-> m ()

Sets a BaseParseFrame to initial state. Currently this means all public fields are zero-ed and a private flag is set to make sure baseParseFrameFree only frees the contents but not the actual frame. Use this function to initialise a BaseParseFrame allocated on the stack.

new

baseParseFrameNew

Arguments

:: (HasCallStack, MonadIO m)

=> Buffer

buffer: a Buffer

-> [BaseParseFrameFlags]

flags: the flags

-> Int32

overhead: number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

-> m BaseParseFrame

Returns: a newly-allocated BaseParseFrame. Free with baseParseFrameFree when no longer needed.

Allocates a new BaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use baseParseFrameInit to initialise it.

Properties

buffer

clearBaseParseFrameBuffer :: MonadIO m => BaseParseFrame -> m ()

getBaseParseFrameBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer)

setBaseParseFrameBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m ()

flags

getBaseParseFrameFlags :: MonadIO m => BaseParseFrame -> m Word32

setBaseParseFrameFlags :: MonadIO m => BaseParseFrame -> Word32 -> m ()

offset

getBaseParseFrameOffset :: MonadIO m => BaseParseFrame -> m Word64

setBaseParseFrameOffset :: MonadIO m => BaseParseFrame -> Word64 -> m ()

outBuffer

clearBaseParseFrameOutBuffer :: MonadIO m => BaseParseFrame -> m ()

getBaseParseFrameOutBuffer :: MonadIO m => BaseParseFrame -> m (Maybe Buffer)

setBaseParseFrameOutBuffer :: MonadIO m => BaseParseFrame -> Ptr Buffer -> m ()

overhead

getBaseParseFrameOverhead :: MonadIO m => BaseParseFrame -> m Int32

setBaseParseFrameOverhead :: MonadIO m => BaseParseFrame -> Int32 -> m ()