gstreamer/gst-libs/gst/sdp/gstsdp.h
Wim Taymans ee42361c89 Document the SDP library.
Original commit message from CVS:
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/sdp/gstsdp.h:
* gst-libs/gst/sdp/gstsdpmessage.c: (gst_sdp_message_set_origin),
(gst_sdp_message_set_connection), (gst_sdp_message_add_bandwidth),
(gst_sdp_message_add_time), (gst_sdp_message_add_zone),
(gst_sdp_message_set_key), (gst_sdp_message_get_attribute_val_n),
(gst_sdp_message_get_attribute_val),
(gst_sdp_message_add_attribute), (gst_sdp_media_new),
(gst_sdp_media_init), (gst_sdp_media_uninit), (gst_sdp_media_free),
(gst_sdp_media_get_media), (gst_sdp_media_set_media),
(gst_sdp_media_get_port), (gst_sdp_media_get_num_ports),
(gst_sdp_media_set_port_info), (gst_sdp_media_get_proto),
(gst_sdp_media_set_proto), (gst_sdp_media_formats_len),
(gst_sdp_media_get_format), (gst_sdp_media_add_format),
(gst_sdp_media_get_information), (gst_sdp_media_set_information),
(gst_sdp_media_connections_len), (gst_sdp_media_get_connection),
(gst_sdp_media_add_connection), (gst_sdp_media_bandwidths_len),
(gst_sdp_media_get_badwidth), (gst_sdp_media_add_bandwidth),
(gst_sdp_media_set_key), (gst_sdp_media_get_key),
(gst_sdp_media_attributes_len), (gst_sdp_media_add_attribute),
(gst_sdp_media_get_attribute_val_n),
(gst_sdp_media_get_attribute_val), (gst_sdp_message_parse_buffer),
(print_media), (gst_sdp_message_dump):
* gst-libs/gst/sdp/gstsdpmessage.h:
Document the SDP library.
Add some of the missing SDPMedia methods.
2007-07-24 17:37:03 +00:00

59 lines
2.3 KiB
C

/* GStreamer
* Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* Unless otherwise indicated, Source Code is licensed under MIT license.
* See further explanation attached in License Statement (distributed in the file
* LICENSE).
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef __GST_SDP_H__
#define __GST_SDP_H__
/**
* GstSDPResult:
* @GST_SDP_OK: A successful return value
* @GST_SDP_EINVAL: a function was given invalid parameters
*
* Return values for the SDP functions.
*/
typedef enum {
GST_SDP_OK = 0,
GST_SDP_EINVAL = -1
} GstSDPResult;
#endif /* __GST_SDP_H__ */