usr/src/man/man3commputil/sdp_find_media.3commputil

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SDP_FIND_MEDIA 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_find_media \- find the specified media from the media list
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
  13 #include <sdp.h>
  14
  15 \fBsdp_media_t *\fR\fBsdp_find_media\fR(\fBsdp_media_t *\fR\fImedia\fR, \fBconst char *\fR\fIname\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsdp_find_media()\fR function searches the media list for the media
  22 specified by \fIname\fR. If the media is found it returns the pointer to the
  23 media. Otherwise it returns \fINULL\fR.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBsdp_find_media()\fR function returns the media (\fBsdp_media_t *\fR) on
  28 success and \fINULL\fR when the search fails or the mandatory input parameters
  29 are \fINULL\fR.
  30 .SH EXAMPLES
  31 .LP
  32 \fBExample 1 \fRAn (incomplete) SDP description that contains two media
  33 sections: audio and video.
  34 .sp
  35 .in +2
  36 .nf
  37 m=audio 49170 RTP/AVP 0 8
  38 a=rtpmap:0 PCMU/8000
  39 a=rtpmap:8 PCMA/8000
  40 m=video 51372 RTP/AVP 31 32
  41 a=rtpmap:31 H261/90000
  42 a=rtpmap:32 MPV/90000
  43
  44 /*
  45  * Assuming that above description is parsed using sdp_parse() and that
  46  * the parsed structure is in "session" sdp_session_t structure.
  47  */
  48
  49 sdp_media_t     *my_media;
  50 my_media = sdp_find_media(session->s_media, "video");
  51
  52 /*
  53  * my_media now points to the structure containg video media section
  54  * information
  55  */
  56 .fi
  57 .in -2
  58
  59 .SH ATTRIBUTES
  60 .sp
  61 .LP
  62 See \fBattributes\fR(5) for descriptions of the following attributes:
  63 .sp
  64
  65 .sp
  66 .TS
  67 box;
  68 c | c
  69 l | l .
  70 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  71 _
  72 Interface Stability     Committed
  73 _
  74 MT-Level        Safe
  75 .TE
  76
  77 .SH SEE ALSO
  78 .sp
  79 .LP
  80 \fBlibcommputil\fR(3LIB), \fBsdp_parse\fR(3COMMPUTIL), \fBattributes\fR(5)