GI.GstVideo.Objects.VideoSink

Provides useful functions and a base class for video sinks.

GstVideoSink will configure the default base sink to drop frames that arrive later than 20ms as this is considered the default threshold for observing out-of-sync frames.

Exported types

newtype VideoSink

Memory-managed wrapper type.

Constructors

VideoSink (ManagedPtr VideoSink)

Instances

GObject VideoSink

Defined in GI.GstVideo.Objects.VideoSink

Methods

gobjectType :: IO GType

HasParentTypes VideoSink

Defined in GI.GstVideo.Objects.VideoSink

type ParentTypes VideoSink

Defined in GI.GstVideo.Objects.VideoSink

type ParentTypes VideoSink = BaseSink ': (Element ': (Object ': (Object ': ([] :: [Type]))))

class (GObject o, IsDescendantOf VideoSink o) => IsVideoSink o

Type class for types which can be safely cast to VideoSink, for instance with toVideoSink.

Instances

(GObject o, IsDescendantOf VideoSink o) => IsVideoSink o

Defined in GI.GstVideo.Objects.VideoSink

toVideoSink :: (MonadIO m, IsVideoSink o) => o -> m VideoSink

Cast to VideoSink, for types for which this is known to be safe. For general casts, use castTo.

noVideoSink :: Maybe VideoSink

A convenience alias for Nothing :: Maybe VideoSink.

Methods

centerRect

videoSinkCenterRect

Arguments

:: (HasCallStack, MonadIO m)

=> VideoRectangle

src: the VideoRectangle describing the source area

-> VideoRectangle

dst: the VideoRectangle describing the destination area

-> VideoRectangle

result: a pointer to a VideoRectangle which will receive the result area

-> Bool

scaling: a Bool indicating if scaling should be applied or not

-> m ()

Takes src rectangle and position it at the center of dst rectangle with or without scaling. It handles clipping if the src rectangle is bigger than the dst one and scaling is set to FALSE.

Properties

showPrerollFrame

Whether to show video frames during preroll. If set to False, video frames will only be rendered in PLAYING state.

constructVideoSinkShowPrerollFrame :: IsVideoSink o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-preroll-frame” property. This is rarely needed directly, but it is used by new.

getVideoSinkShowPrerollFrame :: (MonadIO m, IsVideoSink o) => o -> m Bool

Get the value of the “show-preroll-frame” property. When overloading is enabled, this is equivalent to

get videoSink #showPrerollFrame

setVideoSinkShowPrerollFrame :: (MonadIO m, IsVideoSink o) => o -> Bool -> m ()

Set the value of the “show-preroll-frame” property. When overloading is enabled, this is equivalent to

set videoSink [ #showPrerollFrame := value ]