GI.Gst.Structs.ReferenceTimestampMeta

ReferenceTimestampMeta can be used to attach alternative timestamps and possibly durations to a Buffer. These are generally not according to the pipeline clock and could be e.g. the NTP timestamp when the media was captured.

The reference is stored as a Caps in reference. Examples of valid references would be

• timestamp/x-drivername-stream: for timestamps that are locally generated by some driver named drivername when generating the stream, e.g. based on a frame counter
• timestamp/x-ntp, host=pool.ntp.org, port=123: for timestamps based on a specific NTP server. Note that the host/port parameters might not always be given.
• timestamp/x-ptp, version=IEEE1588-2008, domain=1: for timestamps based on a given PTP clock.
• timestamp/x-unix: for timestamps based on the UNIX epoch according to the local clock.

Since 1.24 it can be serialized using metaSerialize and metaDeserialize.

Since: 1.14

Exported types

newtype ReferenceTimestampMeta

Memory-managed wrapper type.

Constructors

ReferenceTimestampMeta (ManagedPtr ReferenceTimestampMeta)

Instances

Eq ReferenceTimestampMeta

Defined in GI.Gst.Structs.ReferenceTimestampMeta

Methods

(==) :: ReferenceTimestampMeta -> ReferenceTimestampMeta -> Bool

(/=) :: ReferenceTimestampMeta -> ReferenceTimestampMeta -> Bool

BoxedPtr ReferenceTimestampMeta

Defined in GI.Gst.Structs.ReferenceTimestampMeta

Methods

boxedPtrCopy :: ReferenceTimestampMeta -> IO ReferenceTimestampMeta

boxedPtrFree :: ReferenceTimestampMeta -> IO ()

CallocPtr ReferenceTimestampMeta

Defined in GI.Gst.Structs.ReferenceTimestampMeta

Methods

boxedPtrCalloc :: IO (Ptr ReferenceTimestampMeta)

ManagedPtrNewtype ReferenceTimestampMeta

Defined in GI.Gst.Structs.ReferenceTimestampMeta

Methods

toManagedPtr :: ReferenceTimestampMeta -> ManagedPtr ReferenceTimestampMeta

tag ~ 'AttrSet => Constructible ReferenceTimestampMeta tag

Defined in GI.Gst.Structs.ReferenceTimestampMeta

Methods

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

newZeroReferenceTimestampMeta :: MonadIO m => m ReferenceTimestampMeta

Construct a ReferenceTimestampMeta struct initialized to zero.

Methods

getInfo

referenceTimestampMetaGetInfo

Arguments

:: (HasCallStack, MonadIO m)

=> m MetaInfo

Returns: The MetaInfo

Gets the global MetaInfo describing the ReferenceTimestampMeta meta.

Since: 1.14

Properties

duration

duration, or CLOCK_TIME_NONE

getReferenceTimestampMetaDuration :: MonadIO m => ReferenceTimestampMeta -> m Word64

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

get referenceTimestampMeta #duration

setReferenceTimestampMetaDuration :: MonadIO m => ReferenceTimestampMeta -> Word64 -> m ()

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

set referenceTimestampMeta [ #duration := value ]

parent

the parent Meta structure

getReferenceTimestampMetaParent :: MonadIO m => ReferenceTimestampMeta -> m Meta

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

get referenceTimestampMeta #parent

reference

identifier for the timestamp reference.

clearReferenceTimestampMetaReference :: MonadIO m => ReferenceTimestampMeta -> m ()

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

clear #reference

getReferenceTimestampMetaReference :: MonadIO m => ReferenceTimestampMeta -> m (Maybe Caps)

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

get referenceTimestampMeta #reference

setReferenceTimestampMetaReference :: MonadIO m => ReferenceTimestampMeta -> Ptr Caps -> m ()

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

set referenceTimestampMeta [ #reference := value ]

timestamp

timestamp

getReferenceTimestampMetaTimestamp :: MonadIO m => ReferenceTimestampMeta -> m Word64

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

get referenceTimestampMeta #timestamp

setReferenceTimestampMetaTimestamp :: MonadIO m => ReferenceTimestampMeta -> Word64 -> m ()

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

set referenceTimestampMeta [ #timestamp := value ]