GI.Gst.Structs.Sample

A Sample is a small object containing data, a type, timing and extra arbitrary information.

Exported types

newtype Sample

Memory-managed wrapper type.

Constructors

Sample (ManagedPtr Sample)

Instances

BoxedObject Sample

Defined in GI.Gst.Structs.Sample

Methods

boxedType :: Sample -> IO GType

noSample :: Maybe Sample

A convenience alias for Nothing :: Maybe Sample.

Methods

getBuffer

sampleGetBuffer

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m (Maybe Buffer)

Returns: the buffer of sample or Nothing when there is no buffer. The buffer remains valid as long as sample is valid. If you need to hold on to it for longer than that, take a ref to the buffer with gst_buffer_ref().

Get the buffer associated with sample

getBufferList

sampleGetBufferList

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m (Maybe BufferList)

Returns: the buffer list of sample or Nothing when there is no buffer list. The buffer list remains valid as long as sample is valid. If you need to hold on to it for longer than that, take a ref to the buffer list with gst_mini_object_ref ().

Get the buffer list associated with sample

Since: 1.6

getCaps

sampleGetCaps

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m (Maybe Caps)

Returns: the caps of sample or Nothing when there is no caps. The caps remain valid as long as sample is valid. If you need to hold on to the caps for longer than that, take a ref to the caps with gst_caps_ref().

Get the caps associated with sample

getInfo

sampleGetInfo

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m (Maybe Structure)

Returns: the extra info of sample. The info remains valid as long as sample is valid.

Get extra information associated with sample.

getSegment

sampleGetSegment

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m Segment

Returns: the segment of sample. The segment remains valid as long as sample is valid.

Get the segment associated with sample

new

sampleNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Buffer

buffer: a Buffer, or Nothing

-> Maybe Caps

caps: a Caps, or Nothing

-> Maybe Segment

segment: a Segment, or Nothing

-> Maybe Structure

info: a Structure, or Nothing

-> m Sample

Returns: the new Sample. gst_sample_unref() after usage.

Create a new Sample with the provided details.

Free-function: gst_sample_unref

setBuffer

sampleSetBuffer

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: A Sample

-> Buffer

buffer: A Buffer

-> m ()

Set the buffer associated with sample. sample must be writable.

Since: 1.16

setBufferList

sampleSetBufferList

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> BufferList

bufferList: a BufferList

-> m ()

Set the buffer list associated with sample. sample must be writable.

Since: 1.6

setCaps

sampleSetCaps

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: A Sample

-> Caps

caps: A Caps

-> m ()

Set the caps associated with sample. sample must be writable.

Since: 1.16

setInfo

sampleSetInfo

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: A Sample

-> Structure

info: A 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

setSegment

sampleSetSegment

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: A Sample

-> Segment

segment: A Segment

-> m ()

Set the segment associated with sample. sample must be writable.

Since: 1.16