parser.h

Go to the documentation of this file.
00001 /*
00002   This file is part of FreeSDP
00003   Copyright (C) 2001,2002,2003,2004 Federico Montesino Pouzols <fedemp@altern.org>
00004 
00005   FreeSDP is free software; you can redistribute it and/or modify it
00006   under the terms of the GNU General Public License as published by
00007   the Free Software Foundation; either version 2 of the License, or
00008   (at your option) any later version.
00009 
00010   FreeSDP is distributed in the hope that it will be useful,
00011   but WITHOUT ANY WARRANTY; without even the implied warranty of
00012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013   GNU General Public License for more details.
00014 
00015   You should have received a copy of the GNU General Public License
00016   along with this program; if not, write to the Free Software
00017   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 */
00019 
00026 #ifndef FSDP_PARSER_H
00027 #define FSDP_PARSER_H
00028 
00029 #include <freesdp/common.h>
00030 
00031 BEGIN_C_DECLS
00032 
00056 fsdp_error_t
00057 fsdp_parse(const char *description, fsdp_description_t *dsc);
00058 
00069 const char *
00070 fsdp_get_wrong_string(const fsdp_description_t *dsc);
00071   
00077 unsigned int
00078 fsdp_get_version(const fsdp_description_t *dsc);
00079 
00086 const char *
00087 fsdp_get_owner_username(const fsdp_description_t *dsc);
00088 
00095 const char*
00096 fsdp_get_session_id(const fsdp_description_t *dsc);
00097 
00105 const char*
00106 fsdp_get_announcement_version(const fsdp_description_t *dsc);
00107 
00115 fsdp_network_type_t
00116 fsdp_get_owner_network_type(const fsdp_description_t *dsc);
00117 
00125 fsdp_address_type_t
00126 fsdp_get_owner_address_type(const fsdp_description_t *dsc);
00127 
00135 const char *
00136 fsdp_get_owner_address(const fsdp_description_t *dsc);
00137 
00144 const char *
00145 fsdp_get_name(const fsdp_description_t *dsc);
00146 
00154 const char *
00155 fsdp_get_information(const fsdp_description_t *dsc);
00156 
00165 const char *
00166 fsdp_get_uri(const fsdp_description_t *dsc);
00167 
00175 unsigned int
00176 fsdp_get_emails_count(const fsdp_description_t *dsc);
00177 
00188 const char *
00189 fsdp_get_email(const fsdp_description_t *dsc, unsigned int index);
00190 
00198 unsigned int
00199 fsdp_get_phones_count(const fsdp_description_t *dsc);
00200 
00211 const char *
00212 fsdp_get_phone(const fsdp_description_t *dsc, unsigned int index);
00213 
00223 fsdp_network_type_t
00224 fsdp_get_global_conn_network_type(const fsdp_description_t *dsc);
00225 
00235 fsdp_address_type_t
00236 fsdp_get_global_conn_address_type(const fsdp_description_t *dsc);
00237 
00244 const char *
00245 fsdp_get_global_conn_address(const fsdp_description_t *dsc);
00246 
00247 unsigned int
00248 fsdp_get_global_conn_address_ttl(const fsdp_description_t *dsc);
00249 
00250 unsigned int
00251 fsdp_get_global_conn_addresses_count(const fsdp_description_t *dsc);
00252 
00259 unsigned int
00260 fsdp_get_bw_modifiers_count(const fsdp_description_t *dsc);
00261 
00276 fsdp_bw_modifier_type_t
00277 fsdp_get_bw_modifier_type(const fsdp_description_t *dsc, unsigned int index);
00278 
00289 const char *
00290 fsdp_get_bw_modifier_type_unknown(const fsdp_description_t *dsc, 
00291                       unsigned int index);
00292 
00302 unsigned long int
00303 fsdp_get_bw_value(const fsdp_description_t *dsc, unsigned int index);
00304 
00311 unsigned long int
00312 fsdp_get_periods_count(const fsdp_description_t *dsc);
00313 
00323 time_t
00324 fsdp_get_period_start(const fsdp_description_t *dsc, unsigned int index);
00325 
00335 time_t
00336 fsdp_get_period_stop(const fsdp_description_t *dsc, unsigned int index);
00337 
00347 unsigned int
00348 fsdp_get_period_repeats_count(const fsdp_description_t *dsc, 
00349                      unsigned int index);
00350 
00362 unsigned long int
00363 fsdp_get_period_repeat_interval(const fsdp_description_t *dsc, 
00364                     unsigned int index, unsigned int rindex);
00365 
00377 unsigned long int
00378 fsdp_get_period_repeat_duration(const fsdp_description_t *dsc, 
00379                      unsigned int index, unsigned int rindex);
00380 
00392 unsigned long int
00393 fsdp_get_period_repeat_offsets_count(const fsdp_description_t *dsc, 
00394                          unsigned int index, unsigned int rindex);
00395 
00408 unsigned long int
00409 fsdp_get_period_repeat_offsets(const fsdp_description_t *dsc, 
00410                       unsigned int index, unsigned int rindex, 
00411                       unsigned int oindex);
00412 
00420 fsdp_encryption_method_t
00421 fsdp_get_encryption_method(const fsdp_description_t *dsc);
00422 
00432 const char *
00433 fsdp_get_encryption_content(const fsdp_description_t *dsc);
00434 
00443 const char *
00444 fsdp_get_timezone_adj(const fsdp_description_t *dsc);
00445 
00449 unsigned int
00450 fsdp_get_unidentified_attributes_count(const fsdp_description_t *dsc);
00451 
00455 const char *
00456 fsdp_get_unidentified_attribute(const fsdp_description_t *dsc,
00457                     unsigned int index);
00458 
00462 unsigned int
00463 fsdp_get_media_rtpmap_count(const fsdp_media_description_t *mdsc);
00464 
00468 const char *
00469 fsdp_get_media_rtpmap_payload_type(const fsdp_media_description_t *mdsc,
00470                        unsigned int index);
00471 
00475 const char *
00476 fsdp_get_media_rtpmap_encoding_name(const fsdp_media_description_t *mdsc,
00477                         unsigned int index);
00478 
00482 unsigned int
00483 fsdp_get_media_rtpmap_clock_rate(const fsdp_media_description_t *mdsc,
00484                      unsigned int index);
00485 
00489 const char *
00490 fsdp_get_media_rtpmap_encoding_parameters(const fsdp_description_t *mdsc, 
00491                            unsigned int index);
00492 
00506 const char *
00507 fsdp_get_str_att(const fsdp_description_t *dsc, fsdp_session_str_att_t att);
00508 
00512 unsigned int
00513 fsdp_get_sdplang_count(const fsdp_description_t *dsc);
00514 
00518 const char *
00519 fsdp_get_sdplang(const fsdp_description_t *dsc, unsigned int index);
00520 
00529 fsdp_sendrecv_mode_t
00530 fsdp_get_sendrecv_mode(const fsdp_description_t *dsc);
00531 
00540 fsdp_session_type_t
00541 fsdp_get_session_type(const fsdp_description_t *dsc);
00542 
00546 unsigned int
00547 fsdp_get_media_count(const fsdp_description_t *dsc);
00548 
00552 const fsdp_media_description_t*
00553 fsdp_get_media(const fsdp_description_t *dsc, unsigned int index);
00554 
00558 fsdp_media_t
00559 fsdp_get_media_type(const fsdp_media_description_t *dsc);
00560 
00564 unsigned int
00565 fsdp_get_media_port(const fsdp_media_description_t *dsc);
00566 
00567 unsigned int
00568 fsdp_get_media_ports_count(const fsdp_media_description_t *dsc);
00569 
00573 fsdp_transport_protocol_t
00574 fsdp_get_media_transport_protocol(const fsdp_media_description_t *dsc);
00575 
00579 const char *
00580 fsdp_get_media_formats(const fsdp_media_description_t *dsc);
00581 
00585 const char *
00586 fsdp_get_media_title(const fsdp_media_description_t *dsc);
00587 
00591 fsdp_network_type_t
00592 fsdp_get_media_network_type(const fsdp_media_description_t *dsc);
00593 
00597 fsdp_address_type_t
00598 fsdp_get_media_address_type(const fsdp_media_description_t *dsc);
00599 
00603 const char *
00604 fsdp_get_media_address(const fsdp_media_description_t *dsc);
00605 
00606 unsigned int
00607 fsdp_get_media_address_ttl(const fsdp_media_description_t *mdsc);
00608 
00609 unsigned int
00610 fsdp_get_media_addresses_count(const fsdp_media_description_t *mdsc);
00611 
00615 fsdp_bw_modifier_type_t
00616 fsdp_get_media_bw_modifier_type(const fsdp_media_description_t *dsc, 
00617                     unsigned int index);
00618 
00622 const char *
00623 fsdp_get_media_bw_modifier_type_unknown(const fsdp_media_description_t *dsc, 
00624                          unsigned int index);
00625 
00629 unsigned long int
00630 fsdp_get_media_bw_value(const fsdp_media_description_t *dsc, 
00631                unsigned int index);
00632 
00636 fsdp_encryption_method_t
00637 fsdp_get_media_encryption_method(const fsdp_media_description_t *dsc);
00638 
00642 const char *
00643 fsdp_get_media_encryption_content(const fsdp_media_description_t *dsc);
00644 
00648 unsigned int 
00649 fsdp_get_media_ptime(const fsdp_media_description_t *dsc);
00650 
00654 unsigned int
00655 fsdp_get_media_maxptime(const fsdp_media_description_t *dsc);
00656 
00660 unsigned int
00661 fsdp_get_media_fmtp_count(const fsdp_media_description_t *mdsc);
00662 
00666 const char *
00667 fsdp_get_media_fmtp(const fsdp_media_description_t *mdsc, unsigned int index);
00668 
00672 unsigned int
00673 fsdp_get_media_sdplang_count(const fsdp_media_description_t *dsc);
00674 
00678 const char *
00679 fsdp_get_media_sdplang(const fsdp_media_description_t *dsc, 
00680                  unsigned int index);
00681 
00685 unsigned int
00686 fsdp_get_media_lang_count(const fsdp_media_description_t *dsc);
00687 
00691 const char *
00692 fsdp_get_media_lang(const fsdp_media_description_t *dsc, 
00693               unsigned int index);
00694 
00698 fsdp_orient_t
00699 fsdp_get_media_orient(const fsdp_media_description_t *dsc);
00700 
00704 fsdp_sendrecv_mode_t
00705 fsdp_get_media_sendrecv(const fsdp_media_description_t *dsc);
00706 
00710 float
00711 fsdp_get_media_framerate(const fsdp_media_description_t *dsc);
00712 
00716 unsigned int
00717 fsdp_get_media_quality(const fsdp_media_description_t *dsc);
00718 
00722 unsigned int
00723 fsdp_get_media_rtcp_port(const fsdp_media_description_t *dsc);
00724 
00728 fsdp_network_type_t
00729 fsdp_get_media_rtcp_network_type(const fsdp_media_description_t *dsc);
00730 
00734 fsdp_address_type_t
00735 fsdp_get_media_rtcp_address_type(const fsdp_media_description_t *dsc);
00736 
00740 const char*
00741 fsdp_get_media_rtcp_address(const fsdp_media_description_t *dsc);
00742 
00746 unsigned int
00747 fsdp_get_media_unidentified_attributes_count(const fsdp_media_description_t 
00748                              *mdsc);
00749 
00753 const char *
00754 fsdp_get_media_unidentified_attribute(const fsdp_media_description_t *mdsc,
00755                           unsigned int index);
00756 
00757  /* closes parser group */
00759 
00760 END_C_DECLS
00761 
00762 #endif /* FSDP_PARSER_H */

Generated on Wed May 3 13:49:06 2006 for FreeSDP by  doxygen 1.4.6