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

GI.GstVideo.Structs.VideoContentLightLevel

Contents

Exported types
Methods
Properties
- maxContentLightLevel
- maxFrameAverageLightLevel

Description

Content light level information specified in CEA-861.3, Appendix A.

Since: 1.18

Synopsis

newtype VideoContentLightLevel = VideoContentLightLevel (ManagedPtr VideoContentLightLevel)
newZeroVideoContentLightLevel :: MonadIO m => m VideoContentLightLevel
videoContentLightLevelAddToCaps :: (HasCallStack, MonadIO m) => VideoContentLightLevel -> Caps -> m Bool
videoContentLightLevelFromCaps :: (HasCallStack, MonadIO m) => VideoContentLightLevel -> Caps -> m Bool
videoContentLightLevelFromString :: (HasCallStack, MonadIO m) => VideoContentLightLevel -> Text -> m Bool
videoContentLightLevelInit :: (HasCallStack, MonadIO m) => VideoContentLightLevel -> m ()
videoContentLightLevelToString :: (HasCallStack, MonadIO m) => VideoContentLightLevel -> m Text
getVideoContentLightLevelMaxContentLightLevel :: MonadIO m => VideoContentLightLevel -> m Word16
setVideoContentLightLevelMaxContentLightLevel :: MonadIO m => VideoContentLightLevel -> Word16 -> m ()
getVideoContentLightLevelMaxFrameAverageLightLevel :: MonadIO m => VideoContentLightLevel -> m Word16
setVideoContentLightLevelMaxFrameAverageLightLevel :: MonadIO m => VideoContentLightLevel -> Word16 -> m ()

Exported types

newtype VideoContentLightLevel Source #

Memory-managed wrapper type.

Constructors

VideoContentLightLevel (ManagedPtr VideoContentLightLevel)

Instances

Instances details

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

newZeroVideoContentLightLevel :: MonadIO m => m VideoContentLightLevel Source #

Construct a VideoContentLightLevel struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

addToCaps, fromCaps, fromString, init, toString.

Getters

None.

Setters

None.

addToCaps

videoContentLightLevelAddToCaps Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoContentLightLevel	`linfo`: a `VideoContentLightLevel`
-> Caps	`caps`: a `Caps`
-> m Bool	Returns: `True` if `linfo` was successfully set to `caps`

Parse caps and update linfo

Since: 1.18

fromCaps

videoContentLightLevelFromCaps Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoContentLightLevel	`linfo`: a `VideoContentLightLevel`
-> Caps	`caps`: a `Caps`
-> m Bool	Returns: if `caps` has `VideoContentLightLevel` and could be parsed

Parse caps and update linfo

Since: 1.18

fromString

videoContentLightLevelFromString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoContentLightLevel	`linfo`: a `VideoContentLightLevel`
-> Text	`level`: a content-light-level string from caps
-> m Bool	Returns: `True` if `linfo` points to valid `VideoContentLightLevel`.

Parse the value of content-light-level caps field and update minfo with the parsed values.

Since: 1.18

init

videoContentLightLevelInit Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoContentLightLevel	`linfo`: a `VideoContentLightLevel`
-> m ()

Initialize linfo

Since: 1.18

toString

videoContentLightLevelToString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoContentLightLevel	`linfo`: a `VideoContentLightLevel`
-> m Text	Returns: a string representation of `linfo`.

Convert linfo to its string representation.

Since: 1.18

Properties

maxContentLightLevel

the maximum content light level (abbreviated to MaxCLL) in candelas per square meter (cd/m^2 and nit)

getVideoContentLightLevelMaxContentLightLevel :: MonadIO m => VideoContentLightLevel -> m Word16 Source #

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

get videoContentLightLevel #maxContentLightLevel

setVideoContentLightLevelMaxContentLightLevel :: MonadIO m => VideoContentLightLevel -> Word16 -> m () Source #

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

set videoContentLightLevel [ #maxContentLightLevel := value ]

maxFrameAverageLightLevel

the maximum frame average light level (abbreviated to MaxFLL) in candelas per square meter (cd/m^2 and nit)

getVideoContentLightLevelMaxFrameAverageLightLevel :: MonadIO m => VideoContentLightLevel -> m Word16 Source #

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

get videoContentLightLevel #maxFrameAverageLightLevel

setVideoContentLightLevelMaxFrameAverageLightLevel :: MonadIO m => VideoContentLightLevel -> Word16 -> m () Source #

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

set videoContentLightLevel [ #maxFrameAverageLightLevel := value ]