GI.GstVideo.Structs.VideoTimeCode

fieldCount must be 0 for progressive video and 1 or 2 for interlaced.

A representation of a SMPTE time code.

hours must be positive and less than 24. Will wrap around otherwise. minutes and seconds must be positive and less than 60. frames must be less than or equal to config.fps_n / config.fps_d These values are *NOT* automatically normalized.

Exported types

newtype VideoTimeCode

Constructors

VideoTimeCode (ManagedPtr VideoTimeCode)

Instances

BoxedObject VideoTimeCode

Methods

boxedType :: VideoTimeCode -> IO GType

(~) AttrOpTag tag AttrSet => Constructible VideoTimeCode tag

Methods

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

((~) * info (ResolveVideoTimeCodeMethod t VideoTimeCode), MethodInfo * info VideoTimeCode p) => IsLabel t (VideoTimeCode -> p)

Methods

fromLabel :: Proxy# Symbol t -> VideoTimeCode -> p

((~) * info (ResolveVideoTimeCodeMethod t VideoTimeCode), MethodInfo * info VideoTimeCode p) => IsLabelProxy t (VideoTimeCode -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> VideoTimeCode -> p

HasAttributeList * VideoTimeCode

((~) * signature (m Text), MonadIO m) => MethodInfo * VideoTimeCodeToStringMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeToStringMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m DateTime), MonadIO m) => MethodInfo * VideoTimeCodeToDateTimeMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeToDateTimeMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m Word64), MonadIO m) => MethodInfo * VideoTimeCodeNsecSinceDailyJamMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeNsecSinceDailyJamMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * VideoTimeCodeIsValidMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeIsValidMethodInfo VideoTimeCode -> signature -> s

((~) * signature (Word32 -> Word32 -> DateTime -> [VideoTimeCodeFlags] -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> m ()), MonadIO m) => MethodInfo * VideoTimeCodeInitMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeInitMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeIncrementFrameMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeIncrementFrameMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeFreeMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeFreeMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m Word64), MonadIO m) => MethodInfo * VideoTimeCodeFramesSinceDailyJamMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeFramesSinceDailyJamMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m VideoTimeCode), MonadIO m) => MethodInfo * VideoTimeCodeCopyMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeCopyMethodInfo VideoTimeCode -> signature -> s

((~) * signature (VideoTimeCode -> m Int32), MonadIO m) => MethodInfo * VideoTimeCodeCompareMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeCompareMethodInfo VideoTimeCode -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeClearMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeClearMethodInfo VideoTimeCode -> signature -> s

((~) * signature (Int64 -> m ()), MonadIO m) => MethodInfo * VideoTimeCodeAddFramesMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeAddFramesMethodInfo VideoTimeCode -> signature -> s

type AttributeList VideoTimeCode

type AttributeList VideoTimeCode

newZeroVideoTimeCode :: MonadIO m => m VideoTimeCode

Construct a VideoTimeCode struct initialized to zero.

noVideoTimeCode :: Maybe VideoTimeCode

Methods

addFrames

data VideoTimeCodeAddFramesMethodInfo

Instances

((~) * signature (Int64 -> m ()), MonadIO m) => MethodInfo * VideoTimeCodeAddFramesMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeAddFramesMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeAddFrames

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> Int64

frames: How many frames to add or subtract

-> m ()

Adds or subtracts frames amount of frames to tc .

Since: 1.10

clear

data VideoTimeCodeClearMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeClearMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeClearMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeClear

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m ()

Initializes tc with empty/zero/NULL values.

Since: 1.10

compare

data VideoTimeCodeCompareMethodInfo

Instances

((~) * signature (VideoTimeCode -> m Int32), MonadIO m) => MethodInfo * VideoTimeCodeCompareMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeCompareMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeCompare

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc1: a VideoTimeCode

-> VideoTimeCode

tc2: another VideoTimeCode

-> m Int32

Returns: 1 if tc1 is after tc2, -1 if tc1 is before tc2, 0 otherwise.

Compares tc1 and tc2 . If both have latest daily jam information, it is taken into account. Otherwise, it is assumed that the daily jam of both tc1 and tc2 was at the same time.

Since: 1.10

copy

data VideoTimeCodeCopyMethodInfo

Instances

((~) * signature (m VideoTimeCode), MonadIO m) => MethodInfo * VideoTimeCodeCopyMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeCopyMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeCopy

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m VideoTimeCode

Returns: a new VideoTimeCode with the same values as tc .

No description available in the introspection data.

Since: 1.10

framesSinceDailyJam

data VideoTimeCodeFramesSinceDailyJamMethodInfo

Instances

((~) * signature (m Word64), MonadIO m) => MethodInfo * VideoTimeCodeFramesSinceDailyJamMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeFramesSinceDailyJamMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeFramesSinceDailyJam

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m Word64

Returns: how many frames have passed since the daily jam of tc .

No description available in the introspection data.

Since: 1.10

free

data VideoTimeCodeFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeFreeMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeFreeMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeFree

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m ()

Frees tc .

Since: 1.10

incrementFrame

data VideoTimeCodeIncrementFrameMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoTimeCodeIncrementFrameMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeIncrementFrameMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeIncrementFrame

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m ()

Adds one frame to tc .

Since: 1.10

init

data VideoTimeCodeInitMethodInfo

Instances

((~) * signature (Word32 -> Word32 -> DateTime -> [VideoTimeCodeFlags] -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> m ()), MonadIO m) => MethodInfo * VideoTimeCodeInitMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeInitMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeInit

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> Word32

fpsN: Numerator of the frame rate

-> Word32

fpsD: Denominator of the frame rate

-> DateTime

latestDailyJam: The latest daily jam of the VideoTimeCode

-> [VideoTimeCodeFlags]

flags: VideoTimeCodeFlags

-> Word32

hours: the hours field of VideoTimeCode

-> Word32

minutes: the minutes field of VideoTimeCode

-> Word32

seconds: the seconds field of VideoTimeCode

-> Word32

frames: the frames field of VideoTimeCode

-> Word32

fieldCount: Interlaced video field count

-> m ()

fieldCount is 0 for progressive, 1 or 2 for interlaced. latestDaiyJam reference is stolen from caller.

Initializes tc with the given values.

Since: 1.10

isValid

data VideoTimeCodeIsValidMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * VideoTimeCodeIsValidMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeIsValidMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeIsValid

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: VideoTimeCode to check

-> m Bool

Returns: whether tc is a valid timecode (supported frame rate, hours/minutes/seconds/frames not overflowing)

No description available in the introspection data.

Since: 1.10

new

videoTimeCodeNew

Arguments

:: (HasCallStack, MonadIO m)

=> Word32

fpsN: Numerator of the frame rate

-> Word32

fpsD: Denominator of the frame rate

-> DateTime

latestDailyJam: The latest daily jam of the VideoTimeCode

-> [VideoTimeCodeFlags]

flags: VideoTimeCodeFlags

-> Word32

hours: the hours field of VideoTimeCode

-> Word32

minutes: the minutes field of VideoTimeCode

-> Word32

seconds: the seconds field of VideoTimeCode

-> Word32

frames: the frames field of VideoTimeCode

-> Word32

fieldCount: Interlaced video field count

-> m VideoTimeCode

Returns: a new VideoTimeCode with the given values.

fieldCount is 0 for progressive, 1 or 2 for interlaced. latestDaiyJam reference is stolen from caller.

Since: 1.10

newEmpty

videoTimeCodeNewEmpty

Arguments

:: (HasCallStack, MonadIO m)

=> m VideoTimeCode

Returns: a new empty VideoTimeCode

No description available in the introspection data.

Since: 1.10

nsecSinceDailyJam

data VideoTimeCodeNsecSinceDailyJamMethodInfo

Instances

((~) * signature (m Word64), MonadIO m) => MethodInfo * VideoTimeCodeNsecSinceDailyJamMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeNsecSinceDailyJamMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeNsecSinceDailyJam

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: a VideoTimeCode

-> m Word64

Returns: how many nsec have passed since the daily jam of tc .

No description available in the introspection data.

Since: 1.10

toDateTime

data VideoTimeCodeToDateTimeMethodInfo

Instances

((~) * signature (m DateTime), MonadIO m) => MethodInfo * VideoTimeCodeToDateTimeMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeToDateTimeMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeToDateTime

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: VideoTimeCode to convert

-> m DateTime

Returns: the DateTime representation of tc.

The tc.config->latest_daily_jam is required to be non-NULL.

Since: 1.10

toString

data VideoTimeCodeToStringMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * VideoTimeCodeToStringMethodInfo VideoTimeCode signature

Methods

overloadedMethod :: MethodProxy VideoTimeCodeToStringMethodInfo VideoTimeCode -> signature -> s

videoTimeCodeToString

Arguments

:: (HasCallStack, MonadIO m)

=> VideoTimeCode

tc: VideoTimeCode to convert

-> m Text

Returns: the SMPTE ST 2059-1:2015 string representation of tc. That will take the form hh:mm:ss:ff . The last separator (between seconds and frames) may vary:

';' for drop-frame, non-interlaced content and for drop-frame interlaced field 2 ',' for drop-frame interlaced field 1 ':' for non-drop-frame, non-interlaced content and for non-drop-frame interlaced field 2 '.' for non-drop-frame interlaced field 1

No description available in the introspection data.

Since: 1.10

Properties

config

getVideoTimeCodeConfig :: MonadIO m => VideoTimeCode -> m VideoTimeCodeConfig

videoTimeCode_config :: AttrLabelProxy "config"

fieldCount

getVideoTimeCodeFieldCount :: MonadIO m => VideoTimeCode -> m Word32

setVideoTimeCodeFieldCount :: MonadIO m => VideoTimeCode -> Word32 -> m ()

videoTimeCode_fieldCount :: AttrLabelProxy "fieldCount"

frames

getVideoTimeCodeFrames :: MonadIO m => VideoTimeCode -> m Word32

setVideoTimeCodeFrames :: MonadIO m => VideoTimeCode -> Word32 -> m ()

videoTimeCode_frames :: AttrLabelProxy "frames"

hours

getVideoTimeCodeHours :: MonadIO m => VideoTimeCode -> m Word32

setVideoTimeCodeHours :: MonadIO m => VideoTimeCode -> Word32 -> m ()

videoTimeCode_hours :: AttrLabelProxy "hours"

minutes

getVideoTimeCodeMinutes :: MonadIO m => VideoTimeCode -> m Word32

setVideoTimeCodeMinutes :: MonadIO m => VideoTimeCode -> Word32 -> m ()

videoTimeCode_minutes :: AttrLabelProxy "minutes"

seconds

getVideoTimeCodeSeconds :: MonadIO m => VideoTimeCode -> m Word32

setVideoTimeCodeSeconds :: MonadIO m => VideoTimeCode -> Word32 -> m ()

videoTimeCode_seconds :: AttrLabelProxy "seconds"