Blame docs/gst/html/GstSample.html

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

GstSample

Packit Service 963350

GstSample — A media sample

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Functions

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

Types and Values

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
 
Packit Service 963350
GstSample
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Object Hierarchy

Packit Service 963350
    GBoxed
Packit Service 963350
    ╰── GstSample
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Includes

Packit Service 963350
#include <gst/gst.h>
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Description

Packit Service 963350

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

Packit Service 963350
extra arbitrary information.

Packit Service 963350
Packit Service 963350
Packit Service 963350

Functions

Packit Service 963350
Packit Service 963350

gst_sample_get_buffer ()

Packit Service 963350
GstBuffer *
Packit Service 963350
gst_sample_get_buffer (GstSample *sample);
Packit Service 963350

Get the buffer associated with sample

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the buffer of sample

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

Packit Service 963350

[transfer none][nullable]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_get_buffer_list ()

Packit Service 963350
GstBufferList *
Packit Service 963350
gst_sample_get_buffer_list (GstSample *sample);
Packit Service 963350

Get the buffer list associated with sample

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the buffer list of sample

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

Packit Service 963350

[transfer none][nullable]

Packit Service 963350
Packit Service 963350

Since: 1.6

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_get_caps ()

Packit Service 963350
GstCaps *
Packit Service 963350
gst_sample_get_caps (GstSample *sample);
Packit Service 963350

Get the caps associated with sample

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the caps of sample

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

Packit Service 963350

[transfer none][nullable]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_get_info ()

Packit Service 963350
const GstStructure *
Packit Service 963350
gst_sample_get_info (GstSample *sample);
Packit Service 963350

Get extra information associated with sample

Packit Service 963350
.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the extra info of sample

Packit Service 963350
.
Packit Service 963350
The info remains valid as long as sample
Packit Service 963350
is valid. 

Packit Service 963350

[transfer none][nullable]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_get_segment ()

Packit Service 963350
GstSegment *
Packit Service 963350
gst_sample_get_segment (GstSample *sample);
Packit Service 963350

Get the segment associated with sample

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the segment of sample

Packit Service 963350
.
Packit Service 963350
The segment remains valid as long as sample
Packit Service 963350
is valid. 

Packit Service 963350

[transfer none]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_set_buffer_list ()

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

Set the buffer list associated with sample

Packit Service 963350

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350

buffer_list

Packit Service 963350

a GstBufferList

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Since: 1.6

Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_new ()

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

Create a new GstSample with the provided details.

Packit Service 963350

Free-function: gst_sample_unref

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

buffer

Packit Service 963350

a GstBuffer, or NULL.

Packit Service 963350
[transfer none][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350

caps

Packit Service 963350

a GstCaps, or NULL.

Packit Service 963350
[transfer none][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350

segment

Packit Service 963350

a GstSegment, or NULL.

Packit Service 963350
[transfer none][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350

info

Packit Service 963350

a GstStructure, or NULL.

Packit Service 963350
[transfer full][allow-none]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

the new GstSample. gst_sample_unref()

Packit Service 963350
after usage. 

Packit Service 963350

[transfer full]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_ref ()

Packit Service 963350
GstSample *
Packit Service 963350
gst_sample_ref (GstSample *sample);
Packit Service 963350

Increases the refcount of the given sample by one.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

sample

Packit Service 963350
. 

Packit Service 963350

[transfer full]

Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_unref ()

Packit Service 963350
void
Packit Service 963350
gst_sample_unref (GstSample *sample);
Packit Service 963350

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

Packit Service 963350
sample will be freed.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

sample

Packit Service 963350

a GstSample.

Packit Service 963350
[transfer full]
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Packit Service 963350
Packit Service 963350

gst_sample_copy ()

Packit Service 963350
GstSample *
Packit Service 963350
gst_sample_copy (const GstSample *buf);
Packit Service 963350

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

Packit Service 963350
copy of the data the source sample contains.

Packit Service 963350
Packit Service 963350

Parameters

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

buf

Packit Service 963350

a GstSample.

Packit Service 963350
 
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Returns

Packit Service 963350

a new copy of buf

Packit Service 963350
. 

Packit Service 963350

[transfer full]

Packit Service 963350
Packit Service 963350

Since: 1.2

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

Types and Values

Packit Service 963350
Packit Service 963350

GstSample

Packit Service 963350
typedef struct _GstSample GstSample;
Packit Service 963350

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

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

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

See Also

Packit Service 963350

GstBuffer, GstCaps, GstSegment

Packit Service 963350
Packit Service 963350
Packit Service 963350
Packit Service 963350

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