Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Gst.Objects.ControlSource
Description
The ControlSource
is a base class for control value sources that could
be used to get timestamp-value pairs. A control source essentially is a
function over time.
A ControlSource
is used by first getting an instance of a specific
control-source, creating a binding for the control-source to the target property
of the element and then adding the binding to the element. The binding will
convert the data types and value range to fit to the bound property.
For implementing a new ControlSource
one has to implement
ControlSourceGetValue
and ControlSourceGetValueArray
functions.
These are then used by controlSourceControlSourceGetValue
and
controlSourceControlSourceGetValueArray
to get values for specific timestamps.
Synopsis
- newtype ControlSource = ControlSource (ManagedPtr ControlSource)
- class (GObject o, IsDescendantOf ControlSource o) => IsControlSource o
- toControlSource :: (MonadIO m, IsControlSource o) => o -> m ControlSource
- controlSourceControlSourceGetValue :: (HasCallStack, MonadIO m, IsControlSource a) => a -> Word64 -> m (Bool, Double)
- controlSourceControlSourceGetValueArray :: (HasCallStack, MonadIO m, IsControlSource a) => a -> Word64 -> Word64 -> [Double] -> m Bool
Exported types
newtype ControlSource Source #
Memory-managed wrapper type.
Constructors
ControlSource (ManagedPtr ControlSource) |
Instances
Eq ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource Methods (==) :: ControlSource -> ControlSource -> Bool # (/=) :: ControlSource -> ControlSource -> Bool # | |
GObject ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource | |
ManagedPtrNewtype ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource Methods | |
TypedObject ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource | |
HasParentTypes ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource | |
IsGValue (Maybe ControlSource) Source # | Convert |
Defined in GI.Gst.Objects.ControlSource Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe ControlSource -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe ControlSource) # | |
type ParentTypes ControlSource Source # | |
Defined in GI.Gst.Objects.ControlSource |
class (GObject o, IsDescendantOf ControlSource o) => IsControlSource o Source #
Type class for types which can be safely cast to ControlSource
, for instance with toControlSource
.
Instances
(GObject o, IsDescendantOf ControlSource o) => IsControlSource o Source # | |
Defined in GI.Gst.Objects.ControlSource |
toControlSource :: (MonadIO m, IsControlSource o) => o -> m ControlSource Source #
Cast to ControlSource
, 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
addControlBinding, bindProperty, bindPropertyFull, controlSourceGetValue, controlSourceGetValueArray, defaultError, forceFloating, freezeNotify, getv, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, isFloating, notify, notifyByPspec, ref, refSink, removeControlBinding, runDispose, stealData, stealQdata, suggestNextSync, syncValues, thawNotify, unparent, unref, watchClosure.
Getters
getControlBinding, getControlRate, getData, getGValueArray, getName, getParent, getPathString, getProperty, getQdata, getValue.
Setters
setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setName, setParent, setProperty.
controlSourceGetValue
controlSourceControlSourceGetValue Source #
Arguments
:: (HasCallStack, MonadIO m, IsControlSource a) | |
=> a |
|
-> Word64 |
|
-> m (Bool, Double) | Returns: |
Gets the value for this ControlSource
at a given timestamp.
controlSourceGetValueArray
controlSourceControlSourceGetValueArray Source #
Arguments
:: (HasCallStack, MonadIO m, IsControlSource a) | |
=> a |
|
-> Word64 |
|
-> Word64 |
|
-> [Double] |
|
-> m Bool | Returns: |
Gets an array of values for for this ControlSource
. Values that are
undefined contain NANs.