GI.Gst.Structs.Sample

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

Exported types

newtype Sample

Constructors

Sample (ManagedPtr Sample)

Instances

BoxedObject Sample

Methods

boxedType :: Sample -> IO GType

((~) * info (ResolveSampleMethod t Sample), MethodInfo * info Sample p) => IsLabel t (Sample -> p)

Methods

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

((~) * info (ResolveSampleMethod t Sample), MethodInfo * info Sample p) => IsLabelProxy t (Sample -> p)

Methods

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

HasAttributeList * Sample

((~) * signature (BufferList -> m ()), MonadIO m) => MethodInfo * SampleSetBufferListMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleSetBufferListMethodInfo Sample -> signature -> s

((~) * signature (m Segment), MonadIO m) => MethodInfo * SampleGetSegmentMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetSegmentMethodInfo Sample -> signature -> s

((~) * signature (m Structure), MonadIO m) => MethodInfo * SampleGetInfoMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetInfoMethodInfo Sample -> signature -> s

((~) * signature (m (Maybe Caps)), MonadIO m) => MethodInfo * SampleGetCapsMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetCapsMethodInfo Sample -> signature -> s

((~) * signature (m (Maybe BufferList)), MonadIO m) => MethodInfo * SampleGetBufferListMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetBufferListMethodInfo Sample -> signature -> s

((~) * signature (m (Maybe Buffer)), MonadIO m) => MethodInfo * SampleGetBufferMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetBufferMethodInfo Sample -> signature -> s

type AttributeList Sample

type AttributeList Sample

noSample :: Maybe Sample

Methods

getBuffer

data SampleGetBufferMethodInfo

Instances

((~) * signature (m (Maybe Buffer)), MonadIO m) => MethodInfo * SampleGetBufferMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetBufferMethodInfo Sample -> signature -> s

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

data SampleGetBufferListMethodInfo

Instances

((~) * signature (m (Maybe BufferList)), MonadIO m) => MethodInfo * SampleGetBufferListMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetBufferListMethodInfo Sample -> signature -> s

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

data SampleGetCapsMethodInfo

Instances

((~) * signature (m (Maybe Caps)), MonadIO m) => MethodInfo * SampleGetCapsMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetCapsMethodInfo Sample -> signature -> s

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

data SampleGetInfoMethodInfo

Instances

((~) * signature (m Structure), MonadIO m) => MethodInfo * SampleGetInfoMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetInfoMethodInfo Sample -> signature -> s

sampleGetInfo

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> m Structure

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

Get extra information associated with sample.

getSegment

data SampleGetSegmentMethodInfo

Instances

((~) * signature (m Segment), MonadIO m) => MethodInfo * SampleGetSegmentMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleGetSegmentMethodInfo Sample -> signature -> s

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

setBufferList

data SampleSetBufferListMethodInfo

Instances

((~) * signature (BufferList -> m ()), MonadIO m) => MethodInfo * SampleSetBufferListMethodInfo Sample signature

Methods

overloadedMethod :: MethodProxy SampleSetBufferListMethodInfo Sample -> signature -> s

sampleSetBufferList

Arguments

:: (HasCallStack, MonadIO m)

=> Sample

sample: a Sample

-> BufferList

bufferList: a BufferList

-> m ()

Set the buffer list associated with sample

Since: 1.6