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.VideoBarMeta

Contents

Exported types
Methods
- getInfo
Properties

Description

Bar data should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame and AFD alone is insufficient to describe the extent of the image.

Note: either vertical or horizontal bars are specified, but not both.

For more details, see:

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and SMPTE ST2016-1

Since: 1.18

Synopsis

newtype VideoBarMeta = VideoBarMeta (ManagedPtr VideoBarMeta)
newZeroVideoBarMeta :: MonadIO m => m VideoBarMeta
videoBarMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo
getVideoBarMetaBarData1 :: MonadIO m => VideoBarMeta -> m Word32
setVideoBarMetaBarData1 :: MonadIO m => VideoBarMeta -> Word32 -> m ()
getVideoBarMetaBarData2 :: MonadIO m => VideoBarMeta -> m Word32
setVideoBarMetaBarData2 :: MonadIO m => VideoBarMeta -> Word32 -> m ()
getVideoBarMetaField :: MonadIO m => VideoBarMeta -> m Word8
setVideoBarMetaField :: MonadIO m => VideoBarMeta -> Word8 -> m ()
getVideoBarMetaIsLetterbox :: MonadIO m => VideoBarMeta -> m Bool
setVideoBarMetaIsLetterbox :: MonadIO m => VideoBarMeta -> Bool -> m ()
getVideoBarMetaMeta :: MonadIO m => VideoBarMeta -> m Meta

Exported types

newtype VideoBarMeta Source #

Memory-managed wrapper type.

Constructors

VideoBarMeta (ManagedPtr VideoBarMeta)

Instances

Instances details

Eq VideoBarMeta Source #
Instance details Defined in GI.GstVideo.Structs.VideoBarMeta Methods (==) :: VideoBarMeta -> VideoBarMeta -> Bool # (/=) :: VideoBarMeta -> VideoBarMeta -> Bool #
BoxedPtr VideoBarMeta Source #
Instance details Defined in GI.GstVideo.Structs.VideoBarMeta Methods boxedPtrCopy :: VideoBarMeta -> IO VideoBarMeta boxedPtrFree :: VideoBarMeta -> IO ()
CallocPtr VideoBarMeta Source #
Instance details Defined in GI.GstVideo.Structs.VideoBarMeta Methods boxedPtrCalloc :: IO (Ptr VideoBarMeta)
ManagedPtrNewtype VideoBarMeta Source #
Instance details Defined in GI.GstVideo.Structs.VideoBarMeta Methods toManagedPtr :: VideoBarMeta -> ManagedPtr VideoBarMeta
tag ~ 'AttrSet => Constructible VideoBarMeta tag Source #
Instance details Defined in GI.GstVideo.Structs.VideoBarMeta Methods new :: MonadIO m => (ManagedPtr VideoBarMeta -> VideoBarMeta) -> [AttrOp VideoBarMeta tag] -> m VideoBarMeta

newZeroVideoBarMeta :: MonadIO m => m VideoBarMeta Source #

Construct a VideoBarMeta struct initialized to zero.

Methods

getInfo

videoBarMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo Source #

No description available in the introspection data.

Properties

barData1

If isLetterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame

getVideoBarMetaBarData1 :: MonadIO m => VideoBarMeta -> m Word32 Source #

Get the value of the “bar_data1” field. When overloading is enabled, this is equivalent to

get videoBarMeta #barData1

setVideoBarMetaBarData1 :: MonadIO m => VideoBarMeta -> Word32 -> m () Source #

Set the value of the “bar_data1” field. When overloading is enabled, this is equivalent to

set videoBarMeta [ #barData1 := value ]

barData2

If isLetterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame.

getVideoBarMetaBarData2 :: MonadIO m => VideoBarMeta -> m Word32 Source #

Get the value of the “bar_data2” field. When overloading is enabled, this is equivalent to

get videoBarMeta #barData2

setVideoBarMetaBarData2 :: MonadIO m => VideoBarMeta -> Word32 -> m () Source #

Set the value of the “bar_data2” field. When overloading is enabled, this is equivalent to

set videoBarMeta [ #barData2 := value ]

field

0 for progressive or field 1 and 1 for field 2

getVideoBarMetaField :: MonadIO m => VideoBarMeta -> m Word8 Source #

Get the value of the “field” field. When overloading is enabled, this is equivalent to

get videoBarMeta #field

setVideoBarMetaField :: MonadIO m => VideoBarMeta -> Word8 -> m () Source #

Set the value of the “field” field. When overloading is enabled, this is equivalent to

set videoBarMeta [ #field := value ]

isLetterbox

if true then bar data specifies letterbox, otherwise pillarbox

getVideoBarMetaIsLetterbox :: MonadIO m => VideoBarMeta -> m Bool Source #

Get the value of the “is_letterbox” field. When overloading is enabled, this is equivalent to

get videoBarMeta #isLetterbox

setVideoBarMetaIsLetterbox :: MonadIO m => VideoBarMeta -> Bool -> m () Source #

Set the value of the “is_letterbox” field. When overloading is enabled, this is equivalent to

set videoBarMeta [ #isLetterbox := value ]