GI.Gst.Objects.ControlBinding

A base class for value mapping objects that attaches control sources to gobject properties. Such an object is taking one or more ControlSource instances, combines them and maps the resulting value to the type and value range of the bound property.

Exported types

newtype ControlBinding

Constructors

ControlBinding (ManagedPtr ControlBinding)

Instances

GObject ControlBinding

Methods

gobjectType :: ControlBinding -> IO GType

IsObject ControlBinding

IsObject ControlBinding

IsControlBinding ControlBinding

((~) * info (ResolveControlBindingMethod t ControlBinding), MethodInfo * info ControlBinding p) => IsLabel t (ControlBinding -> p)

Methods

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

((~) * info (ResolveControlBindingMethod t ControlBinding), MethodInfo * info ControlBinding p) => IsLabelProxy t (ControlBinding -> p)

Methods

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

HasAttributeList * ControlBinding

type AttributeList ControlBinding

type AttributeList ControlBinding

type SignalList ControlBinding

type SignalList ControlBinding

class GObject o => IsControlBinding o

Instances

(GObject a, UnknownAncestorError Constraint ControlBinding a) => IsControlBinding a

IsControlBinding ControlBinding

toControlBinding :: IsControlBinding o => o -> IO ControlBinding

noControlBinding :: Maybe ControlBinding

Methods

getGValueArray

data ControlBindingGetGValueArrayMethodInfo

Instances

((~) * signature (Word64 -> Word64 -> [GValue] -> m Bool), MonadIO m, IsControlBinding a) => MethodInfo * ControlBindingGetGValueArrayMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ControlBindingGetGValueArrayMethodInfo a -> signature -> s

controlBindingGetGValueArray

Arguments

:: (HasCallStack, MonadIO m, IsControlBinding a)

=> a

binding: the control binding

-> Word64

timestamp: the time that should be processed

-> Word64

interval: the time spacing between subsequent values

-> [GValue]

values: array to put control-values in

-> m Bool

Returns: True if the given array could be filled, False otherwise

Gets a number of GValues for the given controlled property starting at the requested time. The array values need to hold enough space for nValues of Value.

This function is useful if one wants to e.g. draw a graph of the control curve or apply a control curve sample by sample.

getValue

data ControlBindingGetValueMethodInfo

Instances

((~) * signature (Word64 -> m (Maybe GValue)), MonadIO m, IsControlBinding a) => MethodInfo * ControlBindingGetValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ControlBindingGetValueMethodInfo a -> signature -> s

controlBindingGetValue

Arguments

:: (HasCallStack, MonadIO m, IsControlBinding a)

=> a

binding: the control binding

-> Word64

timestamp: the time the control-change should be read from

-> m (Maybe GValue)

Returns: the GValue of the property at the given time, or Nothing if the property isn't controlled.

Gets the value for the given controlled property at the requested time.

isDisabled

data ControlBindingIsDisabledMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsControlBinding a) => MethodInfo * ControlBindingIsDisabledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ControlBindingIsDisabledMethodInfo a -> signature -> s

controlBindingIsDisabled

Arguments

:: (HasCallStack, MonadIO m, IsControlBinding a)

=> a

binding: the control binding

-> m Bool

Returns: True if the binding is inactive

Check if the control binding is disabled.

setDisabled

data ControlBindingSetDisabledMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsControlBinding a) => MethodInfo * ControlBindingSetDisabledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ControlBindingSetDisabledMethodInfo a -> signature -> s

controlBindingSetDisabled

Arguments

:: (HasCallStack, MonadIO m, IsControlBinding a)

=> a

binding: the control binding

-> Bool

disabled: boolean that specifies whether to disable the controller or not.

-> m ()

This function is used to disable a control binding for some time, i.e. objectSyncValues will do nothing.

syncValues

data ControlBindingSyncValuesMethodInfo

Instances

((~) * signature (b -> Word64 -> Word64 -> m Bool), MonadIO m, IsControlBinding a, IsObject b) => MethodInfo * ControlBindingSyncValuesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ControlBindingSyncValuesMethodInfo a -> signature -> s

controlBindingSyncValues

Arguments

:: (HasCallStack, MonadIO m, IsControlBinding a, IsObject b)

=> a

binding: the control binding

-> b

object: the object that has controlled properties

-> Word64

timestamp: the time that should be processed

-> Word64

lastSync: the last time this was called

-> m Bool

Returns: True if the controller value could be applied to the object property, False otherwise

Sets the property of the object, according to the GstControlSources that handle them and for the given timestamp.

If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly.

Properties

name

data ControlBindingNamePropertyInfo

Instances

AttrInfo ControlBindingNamePropertyInfo

Associated Types

type AttrAllowedOps ControlBindingNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ControlBindingNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ControlBindingNamePropertyInfo :: * -> Constraint

type AttrGetType ControlBindingNamePropertyInfo :: *

type AttrLabel ControlBindingNamePropertyInfo :: Symbol

type AttrOrigin ControlBindingNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ControlBindingNamePropertyInfo o => Proxy * ControlBindingNamePropertyInfo -> o -> IO (AttrGetType ControlBindingNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ControlBindingNamePropertyInfo o, AttrSetTypeConstraint ControlBindingNamePropertyInfo b) => Proxy * ControlBindingNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ControlBindingNamePropertyInfo o => Proxy * ControlBindingNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ControlBindingNamePropertyInfo o, AttrSetTypeConstraint ControlBindingNamePropertyInfo b) => Proxy * ControlBindingNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ControlBindingNamePropertyInfo

type AttrOrigin ControlBindingNamePropertyInfo = ControlBinding

type AttrLabel ControlBindingNamePropertyInfo

type AttrLabel ControlBindingNamePropertyInfo = "name"

type AttrGetType ControlBindingNamePropertyInfo

type AttrGetType ControlBindingNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint ControlBindingNamePropertyInfo

type AttrBaseTypeConstraint ControlBindingNamePropertyInfo = IsControlBinding

type AttrSetTypeConstraint ControlBindingNamePropertyInfo

type AttrSetTypeConstraint ControlBindingNamePropertyInfo = * ~ Text

type AttrAllowedOps ControlBindingNamePropertyInfo

type AttrAllowedOps ControlBindingNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructControlBindingName :: IsControlBinding o => Text -> IO (GValueConstruct o)

controlBindingName :: AttrLabelProxy "name"

getControlBindingName :: (MonadIO m, IsControlBinding o) => o -> m (Maybe Text)

object

data ControlBindingObjectPropertyInfo

Instances

AttrInfo ControlBindingObjectPropertyInfo

Associated Types

type AttrAllowedOps ControlBindingObjectPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ControlBindingObjectPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ControlBindingObjectPropertyInfo :: * -> Constraint

type AttrGetType ControlBindingObjectPropertyInfo :: *

type AttrLabel ControlBindingObjectPropertyInfo :: Symbol

type AttrOrigin ControlBindingObjectPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ControlBindingObjectPropertyInfo o => Proxy * ControlBindingObjectPropertyInfo -> o -> IO (AttrGetType ControlBindingObjectPropertyInfo)

attrSet :: (AttrBaseTypeConstraint ControlBindingObjectPropertyInfo o, AttrSetTypeConstraint ControlBindingObjectPropertyInfo b) => Proxy * ControlBindingObjectPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ControlBindingObjectPropertyInfo o => Proxy * ControlBindingObjectPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ControlBindingObjectPropertyInfo o, AttrSetTypeConstraint ControlBindingObjectPropertyInfo b) => Proxy * ControlBindingObjectPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ControlBindingObjectPropertyInfo

type AttrOrigin ControlBindingObjectPropertyInfo = ControlBinding

type AttrLabel ControlBindingObjectPropertyInfo

type AttrLabel ControlBindingObjectPropertyInfo = "object"

type AttrGetType ControlBindingObjectPropertyInfo

type AttrGetType ControlBindingObjectPropertyInfo = Maybe Object

type AttrBaseTypeConstraint ControlBindingObjectPropertyInfo

type AttrBaseTypeConstraint ControlBindingObjectPropertyInfo = IsControlBinding

type AttrSetTypeConstraint ControlBindingObjectPropertyInfo

type AttrSetTypeConstraint ControlBindingObjectPropertyInfo = IsObject

type AttrAllowedOps ControlBindingObjectPropertyInfo

type AttrAllowedOps ControlBindingObjectPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructControlBindingObject :: (IsControlBinding o, IsObject a) => a -> IO (GValueConstruct o)

controlBindingObject :: AttrLabelProxy "object"

getControlBindingObject :: (MonadIO m, IsControlBinding o) => o -> m (Maybe Object)