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 |
Pads managed by a Aggregator
subclass.
This class used to live in gst-plugins-bad and was moved to core.
Since: 1.14
Synopsis
- newtype AggregatorPad = AggregatorPad (ManagedPtr AggregatorPad)
- class (GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o
- toAggregatorPad :: (MonadIO m, IsAggregatorPad o) => o -> m AggregatorPad
- aggregatorPadDropBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m Bool
- aggregatorPadHasBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m Bool
- aggregatorPadIsEos :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m Bool
- aggregatorPadIsInactive :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m Bool
- aggregatorPadPeekBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m (Maybe Buffer)
- aggregatorPadPopBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m (Maybe Buffer)
- constructAggregatorPadEmitSignals :: (IsAggregatorPad o, MonadIO m) => Bool -> m (GValueConstruct o)
- getAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> m Bool
- setAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> Bool -> m ()
- type AggregatorPadBufferConsumedCallback = Buffer -> IO ()
- afterAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> ((?self :: a) => AggregatorPadBufferConsumedCallback) -> m SignalHandlerId
- onAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> ((?self :: a) => AggregatorPadBufferConsumedCallback) -> m SignalHandlerId
Exported types
newtype AggregatorPad Source #
Memory-managed wrapper type.
AggregatorPad (ManagedPtr AggregatorPad) |
Instances
Eq AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad (==) :: AggregatorPad -> AggregatorPad -> Bool # (/=) :: AggregatorPad -> AggregatorPad -> Bool # | |
GObject AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad | |
ManagedPtrNewtype AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad toManagedPtr :: AggregatorPad -> ManagedPtr AggregatorPad | |
TypedObject AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad | |
HasParentTypes AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad | |
IsGValue (Maybe AggregatorPad) Source # | Convert |
Defined in GI.GstBase.Objects.AggregatorPad gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe AggregatorPad -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe AggregatorPad) | |
type ParentTypes AggregatorPad Source # | |
Defined in GI.GstBase.Objects.AggregatorPad type ParentTypes AggregatorPad = '[Pad, Object, Object] |
class (GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o Source #
Type class for types which can be safely cast to AggregatorPad
, for instance with toAggregatorPad
.
Instances
(GObject o, IsDescendantOf AggregatorPad o) => IsAggregatorPad o Source # | |
Defined in GI.GstBase.Objects.AggregatorPad |
toAggregatorPad :: (MonadIO m, IsAggregatorPad o) => o -> m AggregatorPad Source #
Cast to AggregatorPad
, 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
activateMode, addControlBinding, addProbe, bindProperty, bindPropertyFull, canLink, chain, chainList, checkReconfigure, createStreamId, defaultError, dropBuffer, eventDefault, forceFloating, forward, freezeNotify, getv, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, hasBuffer, hasCurrentCaps, isActive, isBlocked, isBlocking, isEos, isFloating, isInactive, isLinked, iterateInternalLinks, iterateInternalLinksDefault, link, linkFull, linkMaybeGhosting, linkMaybeGhostingFull, markReconfigure, needsReconfigure, notify, notifyByPspec, pauseTask, peekBuffer, peerQuery, peerQueryAcceptCaps, peerQueryCaps, peerQueryConvert, peerQueryDuration, peerQueryPosition, popBuffer, proxyQueryAcceptCaps, proxyQueryCaps, pullRange, push, pushEvent, pushList, query, queryAcceptCaps, queryCaps, queryConvert, queryDefault, queryDuration, queryPosition, ref, refSink, removeControlBinding, removeProbe, runDispose, sendEvent, startTask, stealData, stealQdata, stickyEventsForeach, stopTask, storeStickyEvent, suggestNextSync, syncValues, thawNotify, unlink, unparent, unref, useFixedCaps, watchClosure.
Getters
getAllowedCaps, getControlBinding, getControlRate, getCurrentCaps, getData, getDirection, getElementPrivate, getGValueArray, getLastFlowReturn, getName, getOffset, getPadTemplate, getPadTemplateCaps, getParent, getParentElement, getPathString, getPeer, getProperty, getQdata, getRange, getSingleInternalLink, getStickyEvent, getStream, getStreamId, getTaskState, getValue.
Setters
setActivateFunctionFull, setActivatemodeFunctionFull, setActive, setChainFunctionFull, setChainListFunctionFull, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setElementPrivate, setEventFullFunctionFull, setEventFunctionFull, setGetrangeFunctionFull, setIterateInternalLinksFunctionFull, setLinkFunctionFull, setName, setOffset, setParent, setProperty, setQueryFunctionFull, setUnlinkFunctionFull.
dropBuffer
aggregatorPadDropBuffer Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m Bool | Returns: TRUE if there was a buffer queued in |
Drop the buffer currently queued in pad
.
hasBuffer
aggregatorPadHasBuffer Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m Bool | Returns: |
This checks if a pad has a buffer available that will be returned by
a call to aggregatorPadPeekBuffer
or
aggregatorPadPopBuffer
.
Since: 1.14.1
isEos
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m Bool |
No description available in the introspection data.
isInactive
aggregatorPadIsInactive Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m Bool | Returns: |
It is only valid to call this method from AggregatorClass
::aggregate
()
Since: 1.20
peekBuffer
aggregatorPadPeekBuffer Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m (Maybe Buffer) | Returns: A reference to the buffer in |
No description available in the introspection data.
popBuffer
aggregatorPadPopBuffer Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m (Maybe Buffer) | Returns: The buffer in |
Steal the ref to the buffer currently queued in pad
.
Properties
emitSignals
Enables the emission of signals such as AggregatorPad::bufferConsumed
Since: 1.16
constructAggregatorPadEmitSignals :: (IsAggregatorPad o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “emit-signals
” property. This is rarely needed directly, but it is used by new
.
getAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> m Bool Source #
Get the value of the “emit-signals
” property.
When overloading is enabled, this is equivalent to
get
aggregatorPad #emitSignals
setAggregatorPadEmitSignals :: (MonadIO m, IsAggregatorPad o) => o -> Bool -> m () Source #
Set the value of the “emit-signals
” property.
When overloading is enabled, this is equivalent to
set
aggregatorPad [ #emitSignals:=
value ]
Signals
bufferConsumed
type AggregatorPadBufferConsumedCallback = Buffer -> IO () Source #
No description available in the introspection data.
afterAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> ((?self :: a) => AggregatorPadBufferConsumedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the bufferConsumed signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
aggregatorPad #bufferConsumed callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> ((?self :: a) => AggregatorPadBufferConsumedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the bufferConsumed signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
aggregatorPad #bufferConsumed callback