* Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA #ifndef PURPLE_MEDIA_CODEC_H #define PURPLE_MEDIA_CODEC_H * @section_id: libpurple-codec * @short_description: <filename>media/codec.h</filename> * @title: Codec for Media API * An opaque structure representing an audio or video codec. typedef struct _PurpleMediaCodec PurpleMediaCodec; #define PURPLE_TYPE_MEDIA_CODEC purple_media_codec_get_type() * purple_media_codec_get_type: * Gets the type of the media codec structure. * Returns: The media codec's GType G_DECLARE_FINAL_TYPE(PurpleMediaCodec, purple_media_codec, PURPLE, * purple_media_codec_new: * @encoding_name: Name of the media type this encodes. * @media_type: PurpleMediaSessionType of this codec. * @clock_rate: The clock rate this codec encodes at, if applicable. * Creates a new PurpleMediaCodec instance. * Returns: The newly created PurpleMediaCodec. PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name, PurpleMediaSessionType media_type, guint clock_rate); * purple_media_codec_get_id: * @codec: The codec to get the id from. guint purple_media_codec_get_id(PurpleMediaCodec *codec); * purple_media_codec_get_encoding_name: * @codec: The codec to get the encoding name from. * Gets the encoding name. * Returns: The encoding name. gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec); * purple_media_codec_get_clock_rate: * @codec: The codec to get the clock rate from. * Returns: The clock rate. guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec); * purple_media_codec_get_channels: * @codec: The codec to get the number of channels from. * Gets the number of channels. * Returns: The number of channels. guint purple_media_codec_get_channels(PurpleMediaCodec *codec); * purple_media_codec_get_optional_parameters: * @codec: The codec to get the optional parameters from. * Gets a list of the optional parameters. * Returns: (element-type PurpleKeyValuePair) (transfer none): The list of GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec); * purple_media_codec_add_optional_parameter: * @codec: The codec to add the parameter to. * @name: The name of the parameter to add. * @value: The value of the parameter to add. * Adds an optional parameter to the codec. void purple_media_codec_add_optional_parameter(PurpleMediaCodec *codec, const gchar *name, const gchar *value); * purple_media_codec_remove_optional_parameter: * @codec: The codec to remove the parameter from. * @param: A pointer to the parameter to remove. * Removes an optional parameter from the codec. void purple_media_codec_remove_optional_parameter(PurpleMediaCodec *codec, PurpleKeyValuePair *param); * purple_media_codec_get_optional_parameter: * @codec: The codec to find the parameter in. * @name: The name of the parameter to search for. * @value: The value to search for or NULL. * Gets an optional parameter based on the values given. * Returns: The value found or NULL. PurpleKeyValuePair *purple_media_codec_get_optional_parameter( PurpleMediaCodec *codec, const gchar *name, * purple_media_codec_copy: * @codec: The codec to copy. * Copies a PurpleMediaCodec object. * Returns: (transfer full): The copy of the codec. PurpleMediaCodec *purple_media_codec_copy(PurpleMediaCodec *codec); * purple_media_codec_list_copy: * @codecs: (element-type PurpleMediaCodec) (transfer none): The list of codecs * Copies a GList of PurpleMediaCodec and its contents. * Returns: (element-type PurpleMediaCodec) (transfer full): The copy of the GList *purple_media_codec_list_copy(GList *codecs); * purple_media_codec_list_free: * @codecs: (element-type PurpleMediaCodec) (transfer full): The list of codecs * Frees a GList of PurpleMediaCodec and its contents. void purple_media_codec_list_free(GList *codecs); * purple_media_codec_to_string: * @codec: The codec to create the string of. * Creates a string representation of the codec. * Returns: The new string representation. gchar *purple_media_codec_to_string(PurpleMediaCodec *codec); #endif /* PURPLE_MEDIA_CODEC_H */