GI.GES.Objects.TestClip

Useful for testing purposes.

Asset

The default asset ID is GESTestClip, but the framerate and video size can be overridden using an ID of the form:

framerate=60/1, width=1920, height=1080, max-duration=5.0

Note: max-duration can be provided in seconds as float, or as GstClockTime as guint64 or gint.

Exported types

newtype TestClip

Memory-managed wrapper type.

Constructors

TestClip (ManagedPtr TestClip)

Instances

Eq TestClip

Defined in GI.GES.Objects.TestClip

Methods

(==) :: TestClip -> TestClip -> Bool

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

GObject TestClip

Defined in GI.GES.Objects.TestClip

ManagedPtrNewtype TestClip

Defined in GI.GES.Objects.TestClip

Methods

toManagedPtr :: TestClip -> ManagedPtr TestClip

TypedObject TestClip

Defined in GI.GES.Objects.TestClip

Methods

glibType :: IO GType

HasParentTypes TestClip

Defined in GI.GES.Objects.TestClip

IsGValue (Maybe TestClip)

Convert TestClip to and from GValue. See toGValue and fromGValue.

Defined in GI.GES.Objects.TestClip

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TestClip -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TestClip)

type ParentTypes TestClip

Defined in GI.GES.Objects.TestClip

type ParentTypes TestClip = '[SourceClip, Clip, Container, TimelineElement, Object, Extractable, MetaContainer]

class (GObject o, IsDescendantOf TestClip o) => IsTestClip o

Type class for types which can be safely cast to TestClip, for instance with toTestClip.

Instances

(GObject o, IsDescendantOf TestClip o) => IsTestClip o

Defined in GI.GES.Objects.TestClip

toTestClip :: (MonadIO m, IsTestClip o) => o -> m TestClip

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

Methods

Click to display all available methods, including inherited ones

Methods

add, addAsset, addChildProperty, addChildToTrack, addMetasFromString, addTopEffect, bindProperty, bindPropertyFull, checkMetaRegistered, copy, edit, editFull, findTrackElement, findTrackElements, forceFloating, foreach, freezeNotify, getv, isFloating, isMuted, listChildrenProperties, lookupChild, metasToString, moveToLayer, moveToLayerFull, notify, notifyByPspec, paste, ref, refSink, registerMeta, registerMetaBoolean, registerMetaDate, registerMetaDateTime, registerMetaDouble, registerMetaFloat, registerMetaInt, registerMetaInt64, registerMetaString, registerMetaUint, registerMetaUint64, registerStaticMeta, remove, removeChildProperty, removeTopEffect, ripple, rippleEnd, rollEnd, rollStart, runDispose, split, splitFull, stealData, stealQdata, thawNotify, trim, ungroup, unref, watchClosure.

Getters

getAsset, getBoolean, getChildProperty, getChildPropertyByPspec, getChildren, getData, getDate, getDateTime, getDouble, getDuration, getDurationLimit, getFloat, getFrequency, getId, getInpoint, getInt, getInt64, getInternalTimeFromTimelineTime, getLayer, getLayerPriority, getMarkerList, getMaxDuration, getMeta, getName, getNaturalFramerate, getParent, getPriority, getProperty, getQdata, getStart, getString, getSupportedFormats, getTimeline, getTimelineTimeFromInternalTime, getTimelineTimeFromSourceFrame, getTopEffectIndex, getTopEffectPosition, getTopEffects, getToplevelParent, getTrackTypes, getUint, getUint64, getVolume, getVpattern.

Setters

setAsset, setBoolean, setChildProperty, setChildPropertyByPspec, setChildPropertyFull, setData, setDataFull, setDate, setDateTime, setDouble, setDuration, setFloat, setFrequency, setInpoint, setInt, setInt64, setMarkerList, setMaxDuration, setMeta, setMute, setName, setParent, setPriority, setProperty, setStart, setString, setSupportedFormats, setTimeline, setTopEffectIndex, setTopEffectIndexFull, setTopEffectPriority, setUint, setUint64, setVolume, setVpattern.

getFrequency

testClipGetFrequency

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: a TestClip

-> m Double

Returns: The frequency self generates. See audiotestsrc element.

Get the frequency self generates.

getVolume

testClipGetVolume

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: a TestClip

-> m Double

Returns: The volume of the test audio signal applied on self.

Get the volume of the test audio signal applied on self.

getVpattern

testClipGetVpattern

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: a TestClip

-> m VideoTestPattern

Returns: The VideoTestPattern which is applied on self.

Get the VideoTestPattern which is applied on self.

isMuted

testClipIsMuted

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: a TestClip

-> m Bool

Returns: Whether the audio track of self is muted or not.

Let you know if the audio track of self is muted or not.

new

testClipNew

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe TestClip)

Returns: The newly created TestClip, or Nothing if there was an error.

Creates a new TestClip.

newForNick

testClipNewForNick

Arguments

:: (HasCallStack, MonadIO m)

=> Text

nick: the nickname for which to create the TestClip

-> m (Maybe TestClip)

Returns: The newly created TestClip, or Nothing if there was an error.

Creates a new TestClip for the provided nick.

setFrequency

testClipSetFrequency

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: the TestClip to set the frequency on

-> Double

freq: the frequency you want to use on self

-> m ()

Sets the frequency to generate. See audiotestsrc element.

setMute

testClipSetMute

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: the TestClip on which to mute or unmute the audio track

-> Bool

mute: True to mute the audio track, False to unmute it

-> m ()

Sets whether the audio track of this clip is muted or not.

setVolume

testClipSetVolume

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: the TestClip to set the volume on

-> Double

volume: the volume of the audio signal you want to use on self

-> m ()

Sets the volume of the test audio signal.

setVpattern

testClipSetVpattern

Arguments

:: (HasCallStack, MonadIO m, IsTestClip a)

=> a

self: the TestClip to set the pattern on

-> VideoTestPattern

vpattern: the VideoTestPattern to use on self

-> m ()

Sets which video pattern to display on self.

Properties

freq

The frequency to generate for audio track elements.

constructTestClipFreq :: (IsTestClip o, MonadIO m) => Double -> m (GValueConstruct o)

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

getTestClipFreq :: (MonadIO m, IsTestClip o) => o -> m Double

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

get testClip #freq

setTestClipFreq :: (MonadIO m, IsTestClip o) => o -> Double -> m ()

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

set testClip [ #freq := value ]

mute

Whether the sound will be played or not.

constructTestClipMute :: (IsTestClip o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getTestClipMute :: (MonadIO m, IsTestClip o) => o -> m Bool

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

get testClip #mute

setTestClipMute :: (MonadIO m, IsTestClip o) => o -> Bool -> m ()

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

set testClip [ #mute := value ]

volume

The volume for the audio track elements.

constructTestClipVolume :: (IsTestClip o, MonadIO m) => Double -> m (GValueConstruct o)

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

getTestClipVolume :: (MonadIO m, IsTestClip o) => o -> m Double

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

get testClip #volume

setTestClipVolume :: (MonadIO m, IsTestClip o) => o -> Double -> m ()

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

set testClip [ #volume := value ]

vpattern

Video pattern to display in video track elements.

constructTestClipVpattern :: (IsTestClip o, MonadIO m) => VideoTestPattern -> m (GValueConstruct o)

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

getTestClipVpattern :: (MonadIO m, IsTestClip o) => o -> m VideoTestPattern

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

get testClip #vpattern

setTestClipVpattern :: (MonadIO m, IsTestClip o) => o -> VideoTestPattern -> m ()

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

set testClip [ #vpattern := value ]