GI.GES.Objects.UriClip

Represents all the output streams from a particular uri. It is assumed that the URI points to a file of some type.

Exported types

newtype UriClip

Memory-managed wrapper type.

Constructors

UriClip (ManagedPtr UriClip)

Instances

Eq UriClip

Defined in GI.GES.Objects.UriClip

Methods

(==) :: UriClip -> UriClip -> Bool

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

GObject UriClip

Defined in GI.GES.Objects.UriClip

ManagedPtrNewtype UriClip

Defined in GI.GES.Objects.UriClip

Methods

toManagedPtr :: UriClip -> ManagedPtr UriClip

TypedObject UriClip

Defined in GI.GES.Objects.UriClip

Methods

glibType :: IO GType

HasParentTypes UriClip

Defined in GI.GES.Objects.UriClip

IsGValue (Maybe UriClip)

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

Defined in GI.GES.Objects.UriClip

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes UriClip

Defined in GI.GES.Objects.UriClip

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

class (GObject o, IsDescendantOf UriClip o) => IsUriClip o

Type class for types which can be safely cast to UriClip, for instance with toUriClip.

Instances

(GObject o, IsDescendantOf UriClip o) => IsUriClip o

Defined in GI.GES.Objects.UriClip

toUriClip :: (MonadIO m, IsUriClip o) => o -> m UriClip

Cast to UriClip, 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, isImage, 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, 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, getUri.

Setters

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

getUri

uriClipGetUri

Arguments

:: (HasCallStack, MonadIO m, IsUriClip a)

=> a

self: the UriClip

-> m Text

Returns: The location of the resource.

Get the location of the resource.

isImage

uriClipIsImage

Arguments

:: (HasCallStack, MonadIO m, IsUriClip a)

=> a

self: the UriClip

-> m Bool

Returns: True if self is a still image False otherwise.

Lets you know if self is an image or not.

isMuted

uriClipIsMuted

Arguments

:: (HasCallStack, MonadIO m, IsUriClip a)

=> a

self: the UriClip

-> m Bool

Returns: True if the audio track of self is muted, False otherwise.

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

new

uriClipNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

uri: the URI the source should control

-> m (Maybe UriClip)

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

Creates a new UriClip for the provided uri.

**WARNING**: This function might \'discover\` /@uri@/ **synchrounously**, it is
an IO and processing intensive task that you probably don\'t want to run in
an application mainloop. Have a look at @/ges_asset_request_async/@ to see how
to make that operation happen **asynchronously**.

setIsImage

uriClipSetIsImage

Arguments

:: (HasCallStack, MonadIO m, IsUriClip a)

=> a

self: the UriClip

-> Bool

isImage: True if self is a still image, False otherwise

-> m ()

Sets whether the clip is a still image or not.

setMute

uriClipSetMute

Arguments

:: (HasCallStack, MonadIO m, IsUriClip a)

=> a

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

-> Bool

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

-> m ()

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

Properties

isImage

Whether this uri clip represents a still image or not. This must be set before create_track_elements is called.

constructUriClipIsImage :: (IsUriClip o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getUriClipIsImage :: (MonadIO m, IsUriClip o) => o -> m Bool

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

get uriClip #isImage

setUriClipIsImage :: (MonadIO m, IsUriClip o) => o -> Bool -> m ()

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

set uriClip [ #isImage := value ]

mute

Whether the sound will be played or not.

constructUriClipMute :: (IsUriClip 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.

getUriClipMute :: (MonadIO m, IsUriClip o) => o -> m Bool

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

get uriClip #mute

setUriClipMute :: (MonadIO m, IsUriClip o) => o -> Bool -> m ()

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

set uriClip [ #mute := value ]

supportedFormats

No description available in the introspection data.

constructUriClipSupportedFormats :: (IsUriClip o, MonadIO m) => [TrackType] -> m (GValueConstruct o)

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

getUriClipSupportedFormats :: (MonadIO m, IsUriClip o) => o -> m [TrackType]

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

get uriClip #supportedFormats

setUriClipSupportedFormats :: (MonadIO m, IsUriClip o) => o -> [TrackType] -> m ()

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

set uriClip [ #supportedFormats := value ]

uri

The location of the file/resource to use.

constructUriClipUri :: (IsUriClip o, MonadIO m) => Text -> m (GValueConstruct o)

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

getUriClipUri :: (MonadIO m, IsUriClip o) => o -> m Text

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

get uriClip #uri