![]() |
![]() |
![]() |
Farsight2 Reference Manual | ![]() |
---|---|---|---|---|
enum FsMediaType; const gchar* fs_media_type_to_string (FsMediaType media_type); FsCodec; FsCodecParameter; FsCodecPreference; #define FS_CODEC_ID_ANY #define FS_CODEC_ID_DISABLE FsCodec* fs_codec_new (int id, const char *encoding_name, FsMediaType media_type, guint clock_rate); void fs_codec_destroy (FsCodec *codec); FsCodec* fs_codec_copy (const FsCodec *codec); void fs_codec_list_destroy (GList *codec_list); GList* fs_codec_list_copy (const GList *codec_list); GList* fs_codec_list_from_keyfile (const gchar *filename, GError **error); gchar* fs_codec_to_string (const FsCodec *codec); gboolean fs_codec_are_equal (const FsCodec *codec1, const FsCodec *codec2); GstCaps* fs_codec_to_gst_caps (const FsCodec *codec);
An FsCodec is a way to exchange codec information between the client and Farsight. The information specified in this structure is usually representative of the codec information exchanged in the signaling.
typedef enum { FS_MEDIA_TYPE_AUDIO, FS_MEDIA_TYPE_VIDEO, FS_MEDIA_TYPE_APPLICATION, FS_MEDIA_TYPE_LAST = FS_MEDIA_TYPE_APPLICATION } FsMediaType;
Enum used to signify the media type of a codec or stream.
A media type that encodes audio. | |
A media type that encodes video. | |
A media type that ??? | |
Largest valid FsMediaType |
const gchar* fs_media_type_to_string (FsMediaType media_type);
Gives a user-printable string representing the media type
|
A media type |
Returns : |
a static string representing the media type |
typedef struct { /* TODO Should this be made into a GstStructure? */ gint id; char *encoding_name; FsMediaType media_type; guint clock_rate; guint channels; GList *optional_params; } FsCodec;
This structure reprensents one codec that can be offered or received
gint |
numeric identifier for encoding, eg. PT for SDP |
char * |
the name of the codec |
FsMediaType |
type of media this codec is for |
guint |
clock rate of this stream |
guint |
Number of channels codec should decode |
GList * |
key pairs of param name to param data |
typedef struct { gchar *name; gchar *value; } FsCodecParameter;
Used to store arbitary parameters for a codec
typedef struct { gchar *encoding_name; gint clock_rate; } FsCodecPreference;
Used to give a preferece for what type of codec to use.
#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
#define FS_CODEC_ID_DISABLE (-2)
If the id of a FsCodec is FS_CODEC_ID_DISABLE, then this codec will not be used
FsCodec* fs_codec_new (int id, const char *encoding_name, FsMediaType media_type, guint clock_rate);
Allocates and initializes a FsCodec structure
|
codec identifier, if RTP this should be based on IETF RTP payload types |
|
Name of media type this encodes |
|
FsMediaType for type of codec |
|
The clock rate this codec encodes at, if applicable |
Returns : |
A newly allocated FsCodec |
void fs_codec_destroy (FsCodec *codec);
Deletes a FsCodec structure and all its data
|
FsCodec structure to free |
FsCodec* fs_codec_copy (const FsCodec *codec);
Copies a FsCodec structure.
|
codec to copy |
Returns : |
a copy of the codec |
void fs_codec_list_destroy (GList *codec_list);
Deletes a list of FsCodec structures and the list itself
|
a GList of FsCodec to delete |
GList* fs_codec_list_copy (const GList *codec_list);
Copies a list of FsCodec structures.
|
a GList of FsCodec to copy |
Returns : |
The new list. |
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:
[audio/codec1] clock-rate=8000 [audio/codec1:1] clock-rate=16000 [audio/codec2] one_param=QCIF another_param=WOW
gchar* fs_codec_to_string (const FsCodec *codec);
Returns a newly-allocated string representing the codec
|
A farsight codec |
Returns : |
the newly-allocated string |
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.
|
First codec |
|
Second codec |
Returns : |
TRUE of the codecs are identical, FALSE otherwise |