The GstSDPMessage helper functions makes it easy to parse and create SDP messages.

enum GstSDPResult

typedef enum {
  GST_SDP_OK     = 0,
  GST_SDP_EINVAL = -1
} GstSDPResult;

Return values for the SDP functions.

GstSDPOrigin

typedef struct {
  gchar *username;
  gchar *sess_id;
  gchar *sess_version;
  gchar *nettype;
  gchar *addrtype;
  gchar *addr;
} GstSDPOrigin;

The contents of the SDP "o=" field which gives the originator of the session (their username and the address of the user's host) plus a session id and session version number.

GstSDPConnection

typedef struct {
  gchar *nettype;
  gchar *addrtype;
  gchar *address;
  guint  ttl;
  guint  addr_number;
} GstSDPConnection;

The contents of the SDP "c=" field which contains connection data.

GST_SDP_BWTYPE_CT

#define GST_SDP_BWTYPE_CT               "CT"

The Conference Total bandwidth modifier.

GST_SDP_BWTYPE_AS

#define GST_SDP_BWTYPE_AS               "AS"

The Application-Specific Maximum bandwidth modifier.

GST_SDP_BWTYPE_EXT_PREFIX

#define GST_SDP_BWTYPE_EXT_PREFIX       "X-"

The extension prefix bandwidth modifier.

GST_SDP_BWTYPE_RR

#define GST_SDP_BWTYPE_RR               "RR"

RTCP bandwidth allocated to data receivers (RFC 3556).

Since 0.10.15

GST_SDP_BWTYPE_RS

#define GST_SDP_BWTYPE_RS               "RS"

RTCP bandwidth allocated to active data senders (RFC 3556).

Since 0.10.15

GST_SDP_BWTYPE_TIAS

#define GST_SDP_BWTYPE_TIAS             "TIAS"

Transport Independent Application Specific Maximum bandwidth (RFC 3890).

Since 0.10.30

GstSDPBandwidth

typedef struct {
  gchar *bwtype;
  guint  bandwidth;
} GstSDPBandwidth;

The contents of the SDP "b=" field which specifies the proposed bandwidth to be used by the session or media.

GstSDPTime

typedef struct {
  gchar  *start;
  gchar  *stop;
  GArray *repeat;
} GstSDPTime;

The contents of the SDP "t=" field which specify the start and stop times for a conference session.

GstSDPZone

typedef struct {
  gchar *time;
  gchar *typed_time;
} GstSDPZone;

The contents of the SDP "z=" field which allows the sender to specify a list of time zone adjustments and offsets from the base time.

GstSDPKey

typedef struct {
  gchar *type;
  gchar *data;
} GstSDPKey;

The contents of the SDP "k=" field which is used to convey encryption keys.

GstSDPAttribute

typedef struct {
  gchar *key;
  gchar *value;
} GstSDPAttribute;

The contents of the SDP "a=" field which contains a key/value pair.

GstSDPMedia

typedef struct {
  gchar            *media;
  guint             port;
  guint             num_ports;
  gchar            *proto;
  GArray           *fmts;
  gchar            *information;
  GArray           *connections;
  GArray           *bandwidths;
  GstSDPKey         key;
  GArray           *attributes;
} GstSDPMedia;

The contents of the SDP "m=" field with all related fields.

GstSDPMessage

typedef struct {
  gchar            *version;
  GstSDPOrigin      origin;
  gchar            *session_name;
  gchar            *information;
  gchar            *uri;
  GArray           *emails;
  GArray           *phones;
  GstSDPConnection  connection;
  GArray           *bandwidths;
  GArray           *times;
  GArray           *zones;
  GstSDPKey         key;
  GArray           *attributes;
  GArray           *medias;
} GstSDPMessage;

The contents of the SDP message.

gst_sdp_message_new ()

GstSDPResult        gst_sdp_message_new                 (GstSDPMessage **msg);

Allocate a new GstSDPMessage and store the result in msg.

gst_sdp_message_init ()

GstSDPResult        gst_sdp_message_init                (GstSDPMessage *msg);

Initialize msg so that its contents are as if it was freshly allocated with gst_sdp_message_new(). This function is mostly used to initialize a message allocated on the stack. gst_sdp_message_uninit() undoes this operation.

When this function is invoked on newly allocated data (with malloc or on the stack), its contents should be set to 0 before calling this function.

gst_sdp_message_uninit ()

GstSDPResult        gst_sdp_message_uninit              (GstSDPMessage *msg);

Free all resources allocated in msg. msg should not be used anymore after this function. This function should be used when msg was allocated on the stack and initialized with gst_sdp_message_init().

gst_sdp_message_free ()

GstSDPResult        gst_sdp_message_free                (GstSDPMessage *msg);

Free all resources allocated by msg. msg should not be used anymore after this function. This function should be used when msg was dynamically allocated with gst_sdp_message_new().

gst_sdp_message_parse_buffer ()

GstSDPResult        gst_sdp_message_parse_buffer        (const guint8 *data,
                                                         guint size,
                                                         GstSDPMessage *msg);

Parse the contents of size bytes pointed to by data and store the result in msg.

gst_sdp_message_as_text ()

gchar *                   gst_sdp_message_as_text       (const GstSDPMessage *msg);

Convert the contents of msg to a text string.

gst_sdp_message_parse_uri ()

GstSDPResult        gst_sdp_message_parse_uri           (const gchar *uri,
                                                         GstSDPMessage *msg);

Parse the null-terminated uri and store the result in msg.

The uri should be of the form:

scheme://[address[:ttl=ttl][:noa=noa]]/[sessionname] [type=value *[&type=value]]

where value is url encoded. This looslely resembles http://tools.ietf.org/html/draft-fujikawa-sdp-url-01

Since 0.10.31

gst_sdp_message_as_uri ()

gchar *                   gst_sdp_message_as_uri        (const gchar *scheme,
                                                         const GstSDPMessage *msg);

Creates a uri from msg with the given scheme. The uri has the format:

scheme:///[type=value *[&type=value]]

Where each value is url encoded.

Since 0.10.31

gst_sdp_address_is_multicast ()

gboolean            gst_sdp_address_is_multicast        (const gchar *nettype,
                                                         const gchar *addrtype,
                                                         const gchar *addr);

Check if the given addr is a multicast address.

Since 0.10.32

gst_sdp_message_get_version ()

const gchar *             gst_sdp_message_get_version   (const GstSDPMessage *msg);

Get the version in msg.

gst_sdp_message_set_version ()

GstSDPResult        gst_sdp_message_set_version         (GstSDPMessage *msg,
                                                         const gchar *version);

Set the version in msg.

gst_sdp_message_get_origin ()

const GstSDPOrigin *      gst_sdp_message_get_origin    (const GstSDPMessage *msg);

Get the origin of msg.

gst_sdp_message_set_origin ()

GstSDPResult        gst_sdp_message_set_origin          (GstSDPMessage *msg,
                                                         const gchar *username,
                                                         const gchar *sess_id,
                                                         const gchar *sess_version,
                                                         const gchar *nettype,
                                                         const gchar *addrtype,
                                                         const gchar *addr);

Configure the SDP origin in msg with the given parameters.

gst_sdp_message_get_session_name ()

const gchar *             gst_sdp_message_get_session_name
                                                        (const GstSDPMessage *msg);

Get the session name in msg.

gst_sdp_message_set_session_name ()

GstSDPResult        gst_sdp_message_set_session_name    (GstSDPMessage *msg,
                                                         const gchar *session_name);

Set the session name in msg.

gst_sdp_message_get_information ()

const gchar *             gst_sdp_message_get_information
                                                        (const GstSDPMessage *msg);

Get the information in msg.

gst_sdp_message_set_information ()

GstSDPResult        gst_sdp_message_set_information     (GstSDPMessage *msg,
                                                         const gchar *information);

Set the information in msg.

gst_sdp_message_get_uri ()

const gchar *             gst_sdp_message_get_uri       (const GstSDPMessage *msg);

Get the URI in msg.

gst_sdp_message_set_uri ()

GstSDPResult        gst_sdp_message_set_uri             (GstSDPMessage *msg,
                                                         const gchar *uri);

Set the URI in msg.

gst_sdp_message_emails_len ()

guint               gst_sdp_message_emails_len          (const GstSDPMessage *msg);

Get the number of emails in msg.

gst_sdp_message_get_email ()

const gchar *             gst_sdp_message_get_email     (const GstSDPMessage *msg,
                                                         guint idx);

Get the email with number idx from msg.

gst_sdp_message_add_email ()

GstSDPResult        gst_sdp_message_add_email           (GstSDPMessage *msg,
                                                         const gchar *email);

Add email to the list of emails in msg.

gst_sdp_message_phones_len ()

guint               gst_sdp_message_phones_len          (const GstSDPMessage *msg);

Get the number of phones in msg.

gst_sdp_message_get_phone ()

const gchar *             gst_sdp_message_get_phone     (const GstSDPMessage *msg,
                                                         guint idx);

Get the phone with number idx from msg.

gst_sdp_message_add_phone ()

GstSDPResult        gst_sdp_message_add_phone           (GstSDPMessage *msg,
                                                         const gchar *phone);

Add phone to the list of phones in msg.

gst_sdp_message_get_connection ()

const GstSDPConnection *  gst_sdp_message_get_connection
                                                        (const GstSDPMessage *msg);

Get the connection of msg.

gst_sdp_message_set_connection ()

GstSDPResult        gst_sdp_message_set_connection      (GstSDPMessage *msg,
                                                         const gchar *nettype,
                                                         const gchar *addrtype,
                                                         const gchar *address,
                                                         guint ttl,
                                                         guint addr_number);

Configure the SDP connection in msg with the given parameters.

gst_sdp_message_bandwidths_len ()

guint               gst_sdp_message_bandwidths_len      (const GstSDPMessage *msg);

Get the number of bandwidth information in msg.

gst_sdp_message_get_bandwidth ()

const GstSDPBandwidth *   gst_sdp_message_get_bandwidth (const GstSDPMessage *msg,
                                                         guint idx);

Get the bandwidth at index idx from msg.

gst_sdp_message_add_bandwidth ()

GstSDPResult        gst_sdp_message_add_bandwidth       (GstSDPMessage *msg,
                                                         const gchar *bwtype,
                                                         guint bandwidth);

Add the specified bandwidth information to msg.

gst_sdp_message_times_len ()

guint               gst_sdp_message_times_len           (const GstSDPMessage *msg);

Get the number of time information entries in msg.

gst_sdp_message_get_time ()

const GstSDPTime *        gst_sdp_message_get_time      (const GstSDPMessage *msg,
                                                         guint idx);

Get time information with index idx from msg.

gst_sdp_message_add_time ()

GstSDPResult        gst_sdp_message_add_time            (GstSDPMessage *msg,
                                                         const gchar *start,
                                                         const gchar *stop,
                                                         const gchar **repeat);

Add time information start and stop to msg.

gst_sdp_message_zones_len ()

guint               gst_sdp_message_zones_len           (const GstSDPMessage *msg);

Get the number of time zone information entries in msg.

gst_sdp_message_get_zone ()

const GstSDPZone *        gst_sdp_message_get_zone      (const GstSDPMessage *msg,
                                                         guint idx);

Get time zone information with index idx from msg.

gst_sdp_message_add_zone ()

GstSDPResult        gst_sdp_message_add_zone            (GstSDPMessage *msg,
                                                         const gchar *adj_time,
                                                         const gchar *typed_time);

Add time zone information to msg.

gst_sdp_message_get_key ()

const GstSDPKey *         gst_sdp_message_get_key       (const GstSDPMessage *msg);

Get the encryption information from msg.

gst_sdp_message_set_key ()

GstSDPResult        gst_sdp_message_set_key             (GstSDPMessage *msg,
                                                         const gchar *type,
                                                         const gchar *data);

Adds the encryption information to msg.

gst_sdp_message_attributes_len ()

guint               gst_sdp_message_attributes_len      (const GstSDPMessage *msg);

Get the number of attributes in msg.

gst_sdp_message_get_attribute ()

const GstSDPAttribute *   gst_sdp_message_get_attribute (const GstSDPMessage *msg,
                                                         guint idx);

Get the attribute at position idx in msg.

gst_sdp_message_get_attribute_val ()

const gchar *             gst_sdp_message_get_attribute_val
                                                        (const GstSDPMessage *msg,
                                                         const gchar *key);

Get the first attribute with key key in msg.

gst_sdp_message_get_attribute_val_n ()

const gchar *             gst_sdp_message_get_attribute_val_n
                                                        (const GstSDPMessage *msg,
                                                         const gchar *key,
                                                         guint nth);

Get the nth attribute with key key in msg.

gst_sdp_message_add_attribute ()

GstSDPResult        gst_sdp_message_add_attribute       (GstSDPMessage *msg,
                                                         const gchar *key,
                                                         const gchar *value);

Add the attribute with key and value to msg.

gst_sdp_message_medias_len ()

guint               gst_sdp_message_medias_len          (const GstSDPMessage *msg);

Get the number of media descriptions in msg.

gst_sdp_message_get_media ()

const GstSDPMedia *       gst_sdp_message_get_media     (const GstSDPMessage *msg,
                                                         guint idx);

Get the media description at index idx in msg.

gst_sdp_message_add_media ()

GstSDPResult        gst_sdp_message_add_media           (GstSDPMessage *msg,
                                                         GstSDPMedia *media);

Adds media to the array of medias in msg. This function takes ownership of the contents of media so that media will have to be reinitialized with gst_media_init() before it can be used again.

gst_sdp_message_dump ()

GstSDPResult        gst_sdp_message_dump                (const GstSDPMessage *msg);

Dump the parsed contents of msg to stdout.

gst_sdp_media_new ()

GstSDPResult        gst_sdp_media_new                   (GstSDPMedia **media);

Allocate a new GstSDPMedia and store the result in media.

gst_sdp_media_init ()

GstSDPResult        gst_sdp_media_init                  (GstSDPMedia *media);

Initialize media so that its contents are as if it was freshly allocated with gst_sdp_media_new(). This function is mostly used to initialize a media allocated on the stack. gst_sdp_media_uninit() undoes this operation.

When this function is invoked on newly allocated data (with malloc or on the stack), its contents should be set to 0 before calling this function.

gst_sdp_media_uninit ()

GstSDPResult        gst_sdp_media_uninit                (GstSDPMedia *media);

Free all resources allocated in media. media should not be used anymore after this function. This function should be used when media was allocated on the stack and initialized with gst_sdp_media_init().

gst_sdp_media_free ()

GstSDPResult        gst_sdp_media_free                  (GstSDPMedia *media);

Free all resources allocated by media. media should not be used anymore after this function. This function should be used when media was dynamically allocated with gst_sdp_media_new().

gst_sdp_media_get_media ()

const gchar *             gst_sdp_media_get_media       (const GstSDPMedia *media);

Get the media description of media.

gst_sdp_media_set_media ()

GstSDPResult        gst_sdp_media_set_media             (GstSDPMedia *media,
                                                         const gchar *med);

Set the media description of media to med.

gst_sdp_media_get_port ()

guint               gst_sdp_media_get_port              (const GstSDPMedia *media);

Get the port number for media.

gst_sdp_media_get_num_ports ()

guint               gst_sdp_media_get_num_ports         (const GstSDPMedia *media);

Get the number of ports for media.

gst_sdp_media_set_port_info ()

GstSDPResult        gst_sdp_media_set_port_info         (GstSDPMedia *media,
                                                         guint port,
                                                         guint num_ports);

Set the port information in media.

gst_sdp_media_get_proto ()

const gchar *             gst_sdp_media_get_proto       (const GstSDPMedia *media);

Get the transport protocol of media

gst_sdp_media_set_proto ()

GstSDPResult        gst_sdp_media_set_proto             (GstSDPMedia *media,
                                                         const gchar *proto);

Set the media transport protocol of media to proto.

gst_sdp_media_formats_len ()

guint               gst_sdp_media_formats_len           (const GstSDPMedia *media);

Get the number of formats in media.

gst_sdp_media_get_format ()

const gchar *             gst_sdp_media_get_format      (const GstSDPMedia *media,
                                                         guint idx);

Get the format information at position idx in media.

gst_sdp_media_add_format ()

GstSDPResult        gst_sdp_media_add_format            (GstSDPMedia *media,
                                                         const gchar *format);

Add the format information to media.

gst_sdp_media_get_information ()

const gchar *             gst_sdp_media_get_information (const GstSDPMedia *media);

Get the information of media

gst_sdp_media_set_information ()

GstSDPResult        gst_sdp_media_set_information       (GstSDPMedia *media,
                                                         const gchar *information);

Set the media information of media to information.

gst_sdp_media_connections_len ()

guint               gst_sdp_media_connections_len       (const GstSDPMedia *media);

Get the number of connection fields in media.

gst_sdp_media_get_connection ()

const GstSDPConnection *  gst_sdp_media_get_connection  (const GstSDPMedia *media,
                                                         guint idx);

Get the connection at position idx in media.

gst_sdp_media_add_connection ()

GstSDPResult        gst_sdp_media_add_connection        (GstSDPMedia *media,
                                                         const gchar *nettype,
                                                         const gchar *addrtype,
                                                         const gchar *address,
                                                         guint ttl,
                                                         guint addr_number);

Add the given connection parameters to media.

gst_sdp_media_bandwidths_len ()

guint               gst_sdp_media_bandwidths_len        (const GstSDPMedia *media);

Get the number of bandwidth fields in media.

gst_sdp_media_get_bandwidth ()

const GstSDPBandwidth *   gst_sdp_media_get_bandwidth   (const GstSDPMedia *media,
                                                         guint idx);

Get the bandwidth at position idx in media.

gst_sdp_media_add_bandwidth ()

GstSDPResult        gst_sdp_media_add_bandwidth         (GstSDPMedia *media,
                                                         const gchar *bwtype,
                                                         guint bandwidth);

Add the bandwidth information with bwtype and bandwidth to media.

gst_sdp_media_get_key ()

const GstSDPKey *         gst_sdp_media_get_key         (const GstSDPMedia *media);

Get the encryption information from media.

gst_sdp_media_set_key ()

GstSDPResult        gst_sdp_media_set_key               (GstSDPMedia *media,
                                                         const gchar *type,
                                                         const gchar *data);

Adds the encryption information to media.

gst_sdp_media_attributes_len ()

guint               gst_sdp_media_attributes_len        (const GstSDPMedia *media);

Get the number of attribute fields in media.

gst_sdp_media_get_attribute ()

const GstSDPAttribute *  gst_sdp_media_get_attribute    (const GstSDPMedia *media,
                                                         guint idx);

Get the attribute at position idx in media.

gst_sdp_media_get_attribute_val ()

const gchar *             gst_sdp_media_get_attribute_val
                                                        (const GstSDPMedia *media,
                                                         const gchar *key);

Get the first attribute value for key in media.

gst_sdp_media_get_attribute_val_n ()

const gchar *             gst_sdp_media_get_attribute_val_n
                                                        (const GstSDPMedia *media,
                                                         const gchar *key,
                                                         guint nth);

Get the nth attribute value for key in media.

gst_sdp_media_add_attribute ()

GstSDPResult        gst_sdp_media_add_attribute         (GstSDPMedia *media,
                                                         const gchar *key,
                                                         const gchar *value);

Add the attribute with key and value to media.

gst_sdp_media_as_text ()

gchar *                   gst_sdp_media_as_text         (const GstSDPMedia *media);

Convert the contents of media to a text string.