Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.GstVideo.Structs.VideoVBIParser

Contents

Exported types
Methods

Description

A parser for detecting and extracting gstVideoAncillary data from Vertical Blanking Interval lines of component signals.

Since: 1.16

Synopsis

newtype VideoVBIParser = VideoVBIParser (ManagedPtr VideoVBIParser)
videoVBIParserAddLine :: (HasCallStack, MonadIO m) => VideoVBIParser -> Ptr Word8 -> m ()
videoVBIParserCopy :: (HasCallStack, MonadIO m) => VideoVBIParser -> m VideoVBIParser
videoVBIParserFree :: (HasCallStack, MonadIO m) => VideoVBIParser -> m ()
videoVBIParserGetAncillary :: (HasCallStack, MonadIO m) => VideoVBIParser -> m (VideoVBIParserResult, VideoAncillary)
videoVBIParserNew :: (HasCallStack, MonadIO m) => VideoFormat -> Word32 -> m (Maybe VideoVBIParser)

Exported types

newtype VideoVBIParser Source #

Memory-managed wrapper type.

Constructors

VideoVBIParser (ManagedPtr VideoVBIParser)

Instances

Instances details

Eq VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser Methods (==) :: VideoVBIParser -> VideoVBIParser -> Bool # (/=) :: VideoVBIParser -> VideoVBIParser -> Bool #
GBoxed VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser
ManagedPtrNewtype VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser Methods toManagedPtr :: VideoVBIParser -> ManagedPtr VideoVBIParser
TypedObject VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser Methods glibType :: IO GType
HasParentTypes VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser
IsGValue (Maybe VideoVBIParser) Source #	Convert `VideoVBIParser` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe VideoVBIParser -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe VideoVBIParser)
type ParentTypes VideoVBIParser Source #
Instance details Defined in GI.GstVideo.Structs.VideoVBIParser type ParentTypes VideoVBIParser = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

addLine, copy, free.

Getters

getAncillary.

Setters

None.

addLine

videoVBIParserAddLine Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoVBIParser	`parser`: a `VideoVBIParser`
-> Ptr Word8	`data`: The line of data to parse
-> m ()

Provide a new line of data to the parser. Call videoVBIParserGetAncillary to get the Ancillary data that might be present on that line.

Since: 1.16

copy

videoVBIParserCopy :: (HasCallStack, MonadIO m) => VideoVBIParser -> m VideoVBIParser Source #

No description available in the introspection data.

free

videoVBIParserFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoVBIParser	`parser`: a `VideoVBIParser`
-> m ()

Frees the parser.

Since: 1.16

getAncillary

videoVBIParserGetAncillary Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoVBIParser	`parser`: a `VideoVBIParser`
-> m (VideoVBIParserResult, VideoAncillary)	Returns: `VideoVBIParserResultOk` if ancillary data was found and `anc` was filled. `VideoVBIParserResultDone` if there wasn't any data.

Parse the line provided previously by videoVBIParserAddLine.

Since: 1.16

new

videoVBIParserNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoFormat	`format`: a `VideoFormat`
-> Word32	`pixelWidth`: The width in pixel to use
-> m (Maybe VideoVBIParser)	Returns: The new `VideoVBIParser` or `Nothing` if the `format` and/or `pixelWidth` is not supported.

Create a new VideoVBIParser for the specified format and pixelWidth.

Since: 1.16