Mercurial > pidgin.yaz

comparison libpurple/media/codec.h @ 29635:9549d3f8f7c2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document the remaining functions.
author maiku@pidgin.im
date Fri, 13 Nov 2009 21:46:01 +0000
parents e18c1d347e37
children a52831eada67
comparison
equal deleted inserted replaced
29634:ffcc5c128553 29635:9549d3f8f7c2
68 * @since 2.6.0 68 * @since 2.6.0
69 */ 69 */
70 PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name, 70 PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name,
71 PurpleMediaSessionType media_type, guint clock_rate); 71 PurpleMediaSessionType media_type, guint clock_rate);
72 72
73 /**
74 * Gets the codec id.
75 *
76 * @param The codec to get the id from.
77 *
78 * @return The codec id.
79 *
80 * @since 2.6.0
81 */
73 guint purple_media_codec_get_id(PurpleMediaCodec *codec); 82 guint purple_media_codec_get_id(PurpleMediaCodec *codec);
83
84 /**
85 * Gets the encoding name.
86 *
87 * @param The codec to get the encoding name from.
88 *
89 * @return The encoding name.
90 *
91 * @since 2.6.0
92 */
74 gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec); 93 gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec);
94
95 /**
96 * Gets the clock rate.
97 *
98 * @param The codec to get the clock rate from.
99 *
100 * @return The clock rate.
101 *
102 * @since 2.6.0
103 */
75 guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec); 104 guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec);
105
106 /**
107 * Gets the number of channels.
108 *
109 * @param The codec to get the number of channels from.
110 *
111 * @return The number of channels.
112 *
113 * @since 2.6.0
114 */
76 guint purple_media_codec_get_channels(PurpleMediaCodec *codec); 115 guint purple_media_codec_get_channels(PurpleMediaCodec *codec);
116
117 /**
118 * Gets a list of the optional parameters.
119 *
120 * The list consists of PurpleKeyValuePair's.
121 *
122 * @param The codec to get the optional parameters from.
123 *
124 * @return The list of optional parameters.
125 *
126 * @since 2.6.0
127 */
77 GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec); 128 GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec);
78 129
79 /** 130 /**
80 * Adds an optional parameter to the codec. 131 * Adds an optional parameter to the codec.
81 * 132 *