Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
Pads managed by a GstAggregor
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
- aggregatorPadPeekBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m Buffer
- aggregatorPadPopBuffer :: (HasCallStack, MonadIO m, IsAggregatorPad a) => a -> m 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 ()
- type C_AggregatorPadBufferConsumedCallback = Ptr () -> Ptr Buffer -> Ptr () -> IO ()
- afterAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> AggregatorPadBufferConsumedCallback -> m SignalHandlerId
- genClosure_AggregatorPadBufferConsumed :: MonadIO m => AggregatorPadBufferConsumedCallback -> m (GClosure C_AggregatorPadBufferConsumedCallback)
- mk_AggregatorPadBufferConsumedCallback :: C_AggregatorPadBufferConsumedCallback -> IO (FunPtr C_AggregatorPadBufferConsumedCallback)
- noAggregatorPadBufferConsumedCallback :: Maybe AggregatorPadBufferConsumedCallback
- onAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => a -> AggregatorPadBufferConsumedCallback -> m SignalHandlerId
- wrap_AggregatorPadBufferConsumedCallback :: AggregatorPadBufferConsumedCallback -> C_AggregatorPadBufferConsumedCallback
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 glibType :: IO GType | |
IsGValue AggregatorPad Source # | Convert |
Defined in GI.GstBase.Objects.AggregatorPad toGValue :: AggregatorPad -> IO GValue fromGValue :: GValue -> IO AggregatorPad | |
HasParentTypes AggregatorPad Source # | |
Defined in GI.GstBase.Objects.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
Overloaded methods
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 | Returns: |
No description available in the introspection data.
peekBuffer
aggregatorPadPeekBuffer Source #
:: (HasCallStack, MonadIO m, IsAggregatorPad a) | |
=> a |
|
-> m 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 Buffer | Returns: The buffer in |
Steal the ref to the buffer currently queued in pad
.
Properties
emitSignals
Enables the emission of signals such as 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.
type C_AggregatorPadBufferConsumedCallback = Ptr () -> Ptr Buffer -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
afterAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => 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
genClosure_AggregatorPadBufferConsumed :: MonadIO m => AggregatorPadBufferConsumedCallback -> m (GClosure C_AggregatorPadBufferConsumedCallback) Source #
Wrap the callback into a GClosure
.
mk_AggregatorPadBufferConsumedCallback :: C_AggregatorPadBufferConsumedCallback -> IO (FunPtr C_AggregatorPadBufferConsumedCallback) Source #
Generate a function pointer callable from C code, from a C_AggregatorPadBufferConsumedCallback
.
noAggregatorPadBufferConsumedCallback :: Maybe AggregatorPadBufferConsumedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
AggregatorPadBufferConsumedCallback
onAggregatorPadBufferConsumed :: (IsAggregatorPad a, MonadIO m) => 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