farsight_codec_init ()

void
farsight_codec_init (FarsightCodec *codec,
                     int id,
                     const char *encoding_name,
                     FarsightMediaType media_type,
                     guint clock_rate);

Initialises a FarsightCodec structure

farsight_codec_destroy ()

void
farsight_codec_destroy (FarsightCodec *codec);

Deletes a FarsightCodec structure and all its data

farsight_codec_copy ()

FarsightCodec *
farsight_codec_copy (FarsightCodec *codec);

Copies a FarsightCodec structure.

farsight_codec_list_destroy ()

void
farsight_codec_list_destroy (GList *codec_list);

Deletes a list of FarsightCodec structures and the list itself

farsight_codec_list_copy ()

GList *
farsight_codec_list_copy (const GList *codec_list);

Copies a list of FarsightCodec structures.

farsight_codec_list_from_keyfile ()

GList *
farsight_codec_list_from_keyfile (const gchar *filename);

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

Example:

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

[audio/codec1]
clock-rate=8000

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

[audio/codec2]
one_param=QCIF
another_param=WOW

[audio/codec3]
id=-1

If "id" is set to a negative value, it means that it will prevent the system for auto-offering any codec matching the entry

farsight_codec_to_string ()

gchar *
farsight_codec_to_string (FarsightCodec *codec);

Returns a newly-allocated string representing the codec

farsight_media_type_to_string ()

const gchar *
farsight_media_type_to_string (FarsightMediaType media_type);

struct FarsightCodec

struct FarsightCodec {
  gint id;
  char *encoding_name;
  FarsightMediaType media_type;
  guint clock_rate;
  guint channels;
  GList *optional_params;
};

struct FarsightCodecParameter

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

Used to store arbitary parameters for a codec

struct FarsightCodecPreference

struct FarsightCodecPreference {
    gchar *encoding_name;
    gint clock_rate;
};

Used to give a preferece for what type of codec to use.

enum FarsightMediaType

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