diff options
author | Michael Ruprecht <maiku@pidgin.im> | 2009-11-13 21:46:01 +0000 |
---|---|---|
committer | Michael Ruprecht <maiku@pidgin.im> | 2009-11-13 21:46:01 +0000 |
commit | 2067a7ee0a17e328531512cdc3d92790f5fe4ea9 (patch) | |
tree | c30b7a7071c157f1b3eee657229cc2c44e374d6d /libpurple/media | |
parent | 74fa2ba4dcd898901a0200cdfa2557209c5184c9 (diff) | |
download | pidgin-2067a7ee0a17e328531512cdc3d92790f5fe4ea9.tar.gz |
Document the remaining functions.
Diffstat (limited to 'libpurple/media')
-rw-r--r-- | libpurple/media/codec.h | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/libpurple/media/codec.h b/libpurple/media/codec.h index a075b3a79a..0a64d997c6 100644 --- a/libpurple/media/codec.h +++ b/libpurple/media/codec.h @@ -70,10 +70,61 @@ GType purple_media_codec_get_type(void); PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name, PurpleMediaSessionType media_type, guint clock_rate); +/** + * Gets the codec id. + * + * @param The codec to get the id from. + * + * @return The codec id. + * + * @since 2.6.0 + */ guint purple_media_codec_get_id(PurpleMediaCodec *codec); + +/** + * Gets the encoding name. + * + * @param The codec to get the encoding name from. + * + * @return The encoding name. + * + * @since 2.6.0 + */ gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec); + +/** + * Gets the clock rate. + * + * @param The codec to get the clock rate from. + * + * @return The clock rate. + * + * @since 2.6.0 + */ guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec); + +/** + * Gets the number of channels. + * + * @param The codec to get the number of channels from. + * + * @return The number of channels. + * + * @since 2.6.0 + */ guint purple_media_codec_get_channels(PurpleMediaCodec *codec); + +/** + * Gets a list of the optional parameters. + * + * The list consists of PurpleKeyValuePair's. + * + * @param The codec to get the optional parameters from. + * + * @return The list of optional parameters. + * + * @since 2.6.0 + */ GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec); /** |