FS_CODEC_ID_ANY

#define FS_CODEC_ID_ANY            (-1)

If the id of a FsCodec is FS_CODEC_ID_ANY, then it will be replaced with a dynamic payload type at runtime

FS_CODEC_ID_DISABLE

#define FS_CODEC_ID_DISABLE        (-2)

If the id of a FsCodec is FS_CODEC_ID_DISABLE, then this codec will not be used

fs_codec_new ()

FsCodec *
fs_codec_new (int id,
              const char *encoding_name,
              FsMediaType media_type,
              guint clock_rate);

Allocates and initializes a FsCodec structure

fs_codec_destroy ()

void
fs_codec_destroy (FsCodec *codec);

Deletes a FsCodec structure and all its data. Is a no-op on NULL codec

[skip]

fs_codec_copy ()

FsCodec *
fs_codec_copy (const FsCodec *codec);

Copies a FsCodec structure.

fs_codec_are_equal ()

gboolean
fs_codec_are_equal (const FsCodec *codec1,
                    const FsCodec *codec2);

Compare two codecs, it will declare two codecs to be identical even if their optional parameters are in a different order. NULL encoding names are ignored.

fs_codec_list_from_keyfile ()

GList *
fs_codec_list_from_keyfile (const gchar *filename,
                            GError **error);

Reads the content of a GKeyFile of the following format into a GList of FsCodec structures.

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

[audio/codec1]
clock-rate=8000

[audio/codec1:1]
clock-rate=16000

[audio/codec2]
one_param=QCIF
another_param=WOW

[video/codec3]
wierd_param=42
feedback:nack/pli=1
feedback:tfrc=

fs_codec_list_destroy ()

void
fs_codec_list_destroy (GList *codec_list);

Deletes a list of FsCodec structures and the list itself. Does nothing on NULL lists.

[skip]

fs_codec_list_copy ()

GList *
fs_codec_list_copy (const GList *codec_list);

Copies a list of FsCodec structures.

fs_codec_list_are_equal ()

gboolean
fs_codec_list_are_equal (GList *list1,
                         GList *list2);

Verifies if two glist of fscodecs are identical

fs_codec_to_string ()

gchar *
fs_codec_to_string (const FsCodec *codec);

Returns a newly-allocated string representing the codec

fs_codec_add_optional_parameter ()

void
fs_codec_add_optional_parameter (FsCodec *codec,
                                 const gchar *name,
                                 const gchar *value);

This function adds an new optional parameter to a FsCodec

fs_codec_remove_optional_parameter ()

void
fs_codec_remove_optional_parameter (FsCodec *codec,
                                    FsCodecParameter *param);

Removes an optional parameter from a codec.

NULL param will do nothing.

fs_codec_get_optional_parameter ()

FsCodecParameter *
fs_codec_get_optional_parameter (FsCodec *codec,
                                 const gchar *name,
                                 const gchar *value);

Finds the FsCodecParameter in the FsCodec that has the requested name and, if not NULL, the requested value

fs_codec_parameter_copy ()

FsCodecParameter *
fs_codec_parameter_copy (const FsCodecParameter *param);

Makes a copy of a FsCodecParameter

fs_codec_parameter_free ()

void
fs_codec_parameter_free (FsCodecParameter *param);

Frees a FsCodecParameter

fs_codec_add_feedback_parameter ()

void
fs_codec_add_feedback_parameter (FsCodec *codec,
                                 const gchar *type,
                                 const gchar *subtype,
                                 const gchar *extra_params);

This function adds an new feedback parameter to a FsCodec

fs_codec_get_feedback_parameter ()

FsFeedbackParameter *
fs_codec_get_feedback_parameter (FsCodec *codec,
                                 const gchar *type,
                                 const gchar *subtype,
                                 const gchar *extra_params);

Finds the FsFeedbackParameter in the FsCodec that has the requested subtype, type and extra_params. One of which must be non-NULL;

fs_codec_remove_feedback_parameter ()

void
fs_codec_remove_feedback_parameter (FsCodec *codec,
                                    GList *item);

Removes an optional parameter from a codec.

NULL param will do nothing.

fs_feedback_parameter_copy ()

FsFeedbackParameter *
fs_feedback_parameter_copy (const FsFeedbackParameter *param);

Makes a copy of a FsFeedbackParameter

fs_feedback_parameter_free ()

void
fs_feedback_parameter_free (FsFeedbackParameter *param);

Frees a FsFeedbackParameter

FS_CODEC_ARGS()

#define             FS_CODEC_ARGS(codec)

Formats the codec in args for FS_CODEC_FORMAT

fs_media_type_to_string ()

const gchar *
fs_media_type_to_string (FsMediaType media_type);

Gives a user-printable string representing the media type

struct FsCodec

struct FsCodec {
  gint id;
  char *encoding_name;
  FsMediaType media_type;
  guint clock_rate;
  guint channels;
  guint minimum_reporting_interval;
  GList *optional_params;
  GList *feedback_params;
};

This structure reprensents one codec that can be offered or received

enum FsMediaType

Enum used to signify the media type of a codec or stream.

struct FsCodecParameter

struct FsCodecParameter {
    gchar *name;
    gchar *value;
};

Used to store arbitary parameters for a codec

struct FsFeedbackParameter

struct FsFeedbackParameter {
  gchar *type;
  gchar *subtype;
  gchar *extra_params;
};

Use to store feedback parameters

FS_CODEC_FORMAT

#define FS_CODEC_FORMAT "%d: %s %s clock:%d channels:%d params:%p"

A format that can be used in printf like format strings to format a FsCodec