Blame docs/libs/html/GstRTPBaseAudioPayload.html

Packit 0652a1
Packit 0652a1
<html>
Packit 0652a1
<head>
Packit 0652a1
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 0652a1
<title>GstRTPBaseAudioPayload: GStreamer Base Plugins 1.0 Library Reference Manual</title>
Packit 0652a1
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 0652a1
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
Packit 0652a1
<link rel="up" href="gstreamer-rtp.html" title="RTP Library">
Packit 0652a1
<link rel="prev" href="gst-plugins-base-libs-GstMeta-for-RTP.html" title="GstMeta for RTP">
Packit 0652a1
<link rel="next" href="GstRTPBaseDepayload.html" title="GstRTPBaseDepayload">
Packit 0652a1
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit 0652a1
<link rel="stylesheet" href="style.css" type="text/css">
Packit 0652a1
</head>
Packit 0652a1
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 0652a1
Packit 0652a1
Packit 0652a1
Top  | 
Packit 0652a1
                  Description  | 
Packit 0652a1
                  Object Hierarchy  | 
Packit 0652a1
                  Properties
Packit 0652a1
Packit 0652a1
Home
Packit 0652a1
Up
Packit 0652a1
Prev
Packit 0652a1
Next
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

GstRTPBaseAudioPayload

Packit 0652a1

GstRTPBaseAudioPayload — Base class for audio RTP payloader

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Functions

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
void
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_set_frame_based ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
void
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_set_frame_options ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
void
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_based ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
void
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_options ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
GstAdapter *
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_get_adapter ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
GstFlowReturn
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_push ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
GstFlowReturn
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_flush ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
void
Packit 0652a1
Packit 0652a1
Packit 0652a1
gst_rtp_base_audio_payload_set_samplebits_options ()
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Properties

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
gboolean
Packit 0652a1
buffer-list
Packit 0652a1
Read / Write
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Types and Values

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
struct
Packit 0652a1
GstRTPBaseAudioPayload
Packit 0652a1
Packit 0652a1
Packit 0652a1
struct
Packit 0652a1
GstRTPBaseAudioPayloadClass
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Object Hierarchy

Packit 0652a1
    GObject
Packit 0652a1
    ╰── GInitiallyUnowned
Packit 0652a1
        ╰── GstObject
Packit 0652a1
            ╰── GstElement
Packit 0652a1
                ╰── GstRTPBasePayload
Packit 0652a1
                    ╰── GstRTPBaseAudioPayload
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Includes

Packit 0652a1
#include <gst/rtp/rtp.h>
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Description

Packit 0652a1

Provides a base class for audio RTP payloaders for frame or sample based

Packit 0652a1
audio codecs (constant bitrate)

Packit 0652a1

This class derives from GstRTPBasePayload. It can be used for payloading

Packit 0652a1
audio codecs. It will only work with constant bitrate codecs. It supports
Packit 0652a1
both frame based and sample based codecs. It takes care of packing up the
Packit 0652a1
audio data into RTP packets and filling up the headers accordingly. The
Packit 0652a1
payloading is done based on the maximum MTU (mtu) and the maximum time per
Packit 0652a1
packet (max-ptime). The general idea is to divide large data buffers into
Packit 0652a1
smaller RTP packets. The RTP packet size is the minimum of either the MTU,
Packit 0652a1
max-ptime (if set) or available data. The RTP packet size is always larger or
Packit 0652a1
equal to min-ptime (if set). If min-ptime is not set, any residual data is
Packit 0652a1
sent in a last RTP packet. In the case of frame based codecs, the resulting
Packit 0652a1
RTP packets always contain full frames.

Packit 0652a1
Packit 0652a1

Usage

Packit 0652a1

To use this base class, your child element needs to call either

Packit 0652a1
gst_rtp_base_audio_payload_set_frame_based() or
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_based(). This is usually done in the
Packit 0652a1
element's _init() function. Then, the child element must call either
Packit 0652a1
gst_rtp_base_audio_payload_set_frame_options(),
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_options() or
Packit 0652a1
gst_rtp_base_audio_payload_set_samplebits_options. Since
Packit 0652a1
GstRTPBaseAudioPayload derives from GstRTPBasePayload, the child element
Packit 0652a1
must set any variables or call/override any functions required by that base
Packit 0652a1
class. The child element does not need to override any other functions
Packit 0652a1
specific to GstRTPBaseAudioPayload.

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Functions

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_set_frame_based ()

Packit 0652a1
void
Packit 0652a1
gst_rtp_base_audio_payload_set_frame_based
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload);
Packit 0652a1

Tells GstRTPBaseAudioPayload that the child element is for a frame based

Packit 0652a1
audio codec

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a pointer to the element.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_set_frame_options ()

Packit 0652a1
void
Packit 0652a1
gst_rtp_base_audio_payload_set_frame_options
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload,
Packit 0652a1
                                gint frame_duration,
Packit 0652a1
                                gint frame_size);
Packit 0652a1

Sets the options for frame based audio codecs.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a pointer to the element.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

frame_duration

Packit 0652a1

The duraction of an audio frame in milliseconds.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

frame_size

Packit 0652a1

The size of an audio frame in bytes.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_set_sample_based ()

Packit 0652a1
void
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_based
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload);
Packit 0652a1

Tells GstRTPBaseAudioPayload that the child element is for a sample based

Packit 0652a1
audio codec

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a pointer to the element.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_set_sample_options ()

Packit 0652a1
void
Packit 0652a1
gst_rtp_base_audio_payload_set_sample_options
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload,
Packit 0652a1
                                gint sample_size);
Packit 0652a1

Sets the options for sample based audio codecs.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a pointer to the element.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

sample_size

Packit 0652a1

Size per sample in bytes.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_get_adapter ()

Packit 0652a1
GstAdapter *
Packit 0652a1
gst_rtp_base_audio_payload_get_adapter
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload);
Packit 0652a1

Gets the internal adapter used by the depayloader.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a GstRTPBaseAudioPayload

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Returns

Packit 0652a1

a GstAdapter.

Packit 0652a1

[transfer full]

Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_push ()

Packit 0652a1
GstFlowReturn
Packit 0652a1
gst_rtp_base_audio_payload_push (GstRTPBaseAudioPayload *baseaudiopayload,
Packit 0652a1
                                 const guint8 *data,
Packit 0652a1
                                 guint payload_len,
Packit 0652a1
                                 GstClockTime timestamp);
Packit 0652a1

Create an RTP buffer and store payload_len

Packit 0652a1
 bytes of data
Packit 0652a1
 as the
Packit 0652a1
payload. Set the timestamp on the new buffer to timestamp
Packit 0652a1
 before pushing
Packit 0652a1
the buffer downstream.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

baseaudiopayload

Packit 0652a1

a GstRTPBasePayload

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

data

Packit 0652a1

data to set as payload.

Packit 0652a1
[array length=payload_len]
Packit 0652a1
Packit 0652a1
Packit 0652a1

payload_len

Packit 0652a1

length of payload

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

timestamp

Packit 0652a1

a GstClockTime

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Returns

Packit 0652a1

a GstFlowReturn

Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_flush ()

Packit 0652a1
GstFlowReturn
Packit 0652a1
gst_rtp_base_audio_payload_flush (GstRTPBaseAudioPayload *baseaudiopayload,
Packit 0652a1
                                  guint payload_len,
Packit 0652a1
                                  GstClockTime timestamp);
Packit 0652a1

Create an RTP buffer and store payload_len

Packit 0652a1
 bytes of the adapter as the
Packit 0652a1
payload. Set the timestamp on the new buffer to timestamp
Packit 0652a1
 before pushing
Packit 0652a1
the buffer downstream.

Packit 0652a1

If payload_len

Packit 0652a1
 is -1, all pending bytes will be flushed. If timestamp
Packit 0652a1
 is
Packit 0652a1
-1, the timestamp will be calculated automatically.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

baseaudiopayload

Packit 0652a1

a GstRTPBasePayload

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

payload_len

Packit 0652a1

length of payload

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

timestamp

Packit 0652a1

a GstClockTime

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Returns

Packit 0652a1

a GstFlowReturn

Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

gst_rtp_base_audio_payload_set_samplebits_options ()

Packit 0652a1
void
Packit 0652a1
gst_rtp_base_audio_payload_set_samplebits_options
Packit 0652a1
                               (GstRTPBaseAudioPayload *rtpbaseaudiopayload,
Packit 0652a1
                                gint sample_size);
Packit 0652a1

Sets the options for sample based audio codecs.

Packit 0652a1
Packit 0652a1

Parameters

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

rtpbaseaudiopayload

Packit 0652a1

a pointer to the element.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1

sample_size

Packit 0652a1

Size per sample in bits.

Packit 0652a1
 
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Types and Values

Packit 0652a1
Packit 0652a1

struct GstRTPBaseAudioPayload

Packit 0652a1
struct GstRTPBaseAudioPayload;
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

struct GstRTPBaseAudioPayloadClass

Packit 0652a1
struct GstRTPBaseAudioPayloadClass {
Packit 0652a1
  GstRTPBasePayloadClass parent_class;
Packit 0652a1
};
Packit 0652a1
Packit 0652a1

Base class for audio RTP payloader.

Packit 0652a1
Packit 0652a1

Members

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Property Details

Packit 0652a1
Packit 0652a1

The “buffer-list” property

Packit 0652a1
  “buffer-list”              gboolean
Packit 0652a1

Use Buffer Lists.

Packit 0652a1

Flags: Read / Write

Packit 0652a1

Default value: FALSE

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Generated by GTK-Doc V1.28
Packit 0652a1
</body>
Packit 0652a1
</html>