Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gst.Structs.Sample
Contents
Description
A Sample
is a small object containing data, a type, timing and
extra arbitrary information.
Synopsis
- newtype Sample = Sample (ManagedPtr Sample)
- noSample :: Maybe Sample
- sampleGetBuffer :: (HasCallStack, MonadIO m) => Sample -> m (Maybe Buffer)
- sampleGetBufferList :: (HasCallStack, MonadIO m) => Sample -> m (Maybe BufferList)
- sampleGetCaps :: (HasCallStack, MonadIO m) => Sample -> m (Maybe Caps)
- sampleGetInfo :: (HasCallStack, MonadIO m) => Sample -> m (Maybe Structure)
- sampleGetSegment :: (HasCallStack, MonadIO m) => Sample -> m Segment
- sampleNew :: (HasCallStack, MonadIO m) => Maybe Buffer -> Maybe Caps -> Maybe Segment -> Maybe Structure -> m Sample
- sampleSetBuffer :: (HasCallStack, MonadIO m) => Sample -> Buffer -> m ()
- sampleSetBufferList :: (HasCallStack, MonadIO m) => Sample -> BufferList -> m ()
- sampleSetCaps :: (HasCallStack, MonadIO m) => Sample -> Caps -> m ()
- sampleSetInfo :: (HasCallStack, MonadIO m) => Sample -> Structure -> m Bool
- sampleSetSegment :: (HasCallStack, MonadIO m) => Sample -> Segment -> m ()
Exported types
Memory-managed wrapper type.
Constructors
Sample (ManagedPtr Sample) |
Instances
BoxedObject Sample Source # | |
Methods
getBuffer
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> m (Maybe Buffer) | Returns: the buffer of |
Get the buffer associated with sample
getBufferList
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> m (Maybe BufferList) | Returns: the buffer list of |
Get the buffer list associated with sample
Since: 1.6
getCaps
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> m (Maybe Caps) | Returns: the caps of |
Get the caps associated with sample
getInfo
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> m (Maybe Structure) | Returns: the extra info of |
Get extra information associated with sample
.
getSegment
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> m Segment | Returns: the segment of |
Get the segment associated with sample
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> Maybe Buffer | |
-> Maybe Caps | |
-> Maybe Segment | |
-> Maybe Structure | |
-> m Sample | Returns: the new |
Create a new Sample
with the provided details.
Free-function: gst_sample_unref
setBuffer
Set the buffer associated with sample
. sample
must be writable.
Since: 1.16
setBufferList
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> BufferList |
|
-> m () |
Set the buffer list associated with sample
. sample
must be writable.
Since: 1.6
setCaps
Set the caps associated with sample
. sample
must be writable.
Since: 1.16
setInfo
Arguments
:: (HasCallStack, MonadIO m) | |
=> Sample |
|
-> Structure |
|
-> m Bool |
Set the info structure associated with sample
. sample
must be writable,
and info
must not have a parent set already.
Since: 1.16