Blame docs/gst/html/GstSample.html

Packit f546b1
Packit f546b1
<html>
Packit f546b1
<head>
Packit f546b1
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit f546b1
<title>GstSample: GStreamer 1.0 Core Reference Manual</title>
Packit f546b1
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit f546b1
<link rel="home" href="index.html" title="GStreamer 1.0 Core Reference Manual">
Packit f546b1
<link rel="up" href="libgstreamer.html" title="GStreamer Core Library">
Packit f546b1
<link rel="prev" href="GstCapsFeatures.html" title="GstCapsFeatures">
Packit f546b1
<link rel="next" href="GstChildProxy.html" title="GstChildProxy">
Packit f546b1
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit f546b1
<link rel="stylesheet" href="style.css" type="text/css">
Packit f546b1
</head>
Packit f546b1
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit f546b1
Packit f546b1
Packit f546b1
Top  | 
Packit f546b1
                  Description  | 
Packit f546b1
                  Object Hierarchy
Packit f546b1
Packit f546b1
Home
Packit f546b1
Up
Packit f546b1
Prev
Packit f546b1
Next
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

GstSample

Packit f546b1

GstSample — A media sample

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstBuffer *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_get_buffer ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstBufferList *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_get_buffer_list ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstCaps *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_get_caps ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
const GstStructure *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_get_info ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstSegment *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_get_segment ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_set_buffer_list ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstSample *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_new ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstSample *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_ref ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
void
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_unref ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
GstSample *
Packit f546b1
Packit f546b1
Packit f546b1
gst_sample_copy ()
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
 
Packit f546b1
GstSample
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Object Hierarchy

Packit f546b1
    GBoxed
Packit f546b1
    ╰── GstSample
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Includes

Packit f546b1
#include <gst/gst.h>
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Description

Packit f546b1

A GstSample is a small object containing data, a type, timing and

Packit f546b1
extra arbitrary information.

Packit f546b1
Packit f546b1
Packit f546b1

Functions

Packit f546b1
Packit f546b1

gst_sample_get_buffer ()

Packit f546b1
GstBuffer *
Packit f546b1
gst_sample_get_buffer (GstSample *sample);
Packit f546b1

Get the buffer associated with sample

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the buffer of sample

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

Packit f546b1

[transfer none][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_get_buffer_list ()

Packit f546b1
GstBufferList *
Packit f546b1
gst_sample_get_buffer_list (GstSample *sample);
Packit f546b1

Get the buffer list associated with sample

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the buffer list of sample

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

Packit f546b1

[transfer none][nullable]

Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_get_caps ()

Packit f546b1
GstCaps *
Packit f546b1
gst_sample_get_caps (GstSample *sample);
Packit f546b1

Get the caps associated with sample

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the caps of sample

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

Packit f546b1

[transfer none][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_get_info ()

Packit f546b1
const GstStructure *
Packit f546b1
gst_sample_get_info (GstSample *sample);
Packit f546b1

Get extra information associated with sample

Packit f546b1
.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the extra info of sample

Packit f546b1
.
Packit f546b1
The info remains valid as long as sample
Packit f546b1
is valid. 

Packit f546b1

[transfer none][nullable]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_get_segment ()

Packit f546b1
GstSegment *
Packit f546b1
gst_sample_get_segment (GstSample *sample);
Packit f546b1

Get the segment associated with sample

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the segment of sample

Packit f546b1
.
Packit f546b1
The segment remains valid as long as sample
Packit f546b1
is valid. 

Packit f546b1

[transfer none]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_set_buffer_list ()

Packit f546b1
void
Packit f546b1
gst_sample_set_buffer_list (GstSample *sample,
Packit f546b1
                            GstBufferList *buffer_list);
Packit f546b1

Set the buffer list associated with sample

Packit f546b1

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1

buffer_list

Packit f546b1

a GstBufferList

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Since: 1.6

Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_new ()

Packit f546b1
GstSample *
Packit f546b1
gst_sample_new (GstBuffer *buffer,
Packit f546b1
                GstCaps *caps,
Packit f546b1
                const GstSegment *segment,
Packit f546b1
                GstStructure *info);
Packit f546b1

Create a new GstSample with the provided details.

Packit f546b1

Free-function: gst_sample_unref

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

buffer

Packit f546b1

a GstBuffer, or NULL.

Packit f546b1
[transfer none][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1

caps

Packit f546b1

a GstCaps, or NULL.

Packit f546b1
[transfer none][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1

segment

Packit f546b1

a GstSegment, or NULL.

Packit f546b1
[transfer none][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1

info

Packit f546b1

a GstStructure, or NULL.

Packit f546b1
[transfer full][allow-none]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

the new GstSample. gst_sample_unref()

Packit f546b1
after usage. 

Packit f546b1

[transfer full]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_ref ()

Packit f546b1
GstSample *
Packit f546b1
gst_sample_ref (GstSample *sample);
Packit f546b1

Increases the refcount of the given sample by one.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

sample

Packit f546b1
. 

Packit f546b1

[transfer full]

Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_unref ()

Packit f546b1
void
Packit f546b1
gst_sample_unref (GstSample *sample);
Packit f546b1

Decreases the refcount of the sample. If the refcount reaches 0, the

Packit f546b1
sample will be freed.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

sample

Packit f546b1

a GstSample.

Packit f546b1
[transfer full]
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Packit f546b1
Packit f546b1

gst_sample_copy ()

Packit f546b1
GstSample *
Packit f546b1
gst_sample_copy (const GstSample *buf);
Packit f546b1

Create a copy of the given sample. This will also make a newly allocated

Packit f546b1
copy of the data the source sample contains.

Packit f546b1
Packit f546b1

Parameters

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

buf

Packit f546b1

a GstSample.

Packit f546b1
 
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Returns

Packit f546b1

a new copy of buf

Packit f546b1
. 

Packit f546b1

[transfer full]

Packit f546b1
Packit f546b1

Since: 1.2

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Types and Values

Packit f546b1
Packit f546b1

GstSample

Packit f546b1
typedef struct _GstSample GstSample;
Packit f546b1

The opaque structure of a GstSample. A sample contains a typed memory

Packit f546b1
block and the associated timing information. It is mainly used to
Packit f546b1
exchange buffers with an application.

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

See Also

Packit f546b1

GstBuffer, GstCaps, GstSegment

Packit f546b1
Packit f546b1
Packit f546b1
Packit f546b1

Generated by GTK-Doc V1.27
Packit f546b1
</body>
Packit f546b1
</html>