Merge commit 'dc97a43d4a70c8773a619f11b95b07a787f6f5b7' into merges
[unleashed.git] / share / man / man3commputil / sdp_find_media_rtpmap.3commputil
blob86db8e07c107e71c2159530fce7357662fea362c
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_RTPMAP 3COMMPUTIL "Oct 12, 2007"
7 .SH NAME
8 sdp_find_media_rtpmap \- find the rtpmap attribute in the specified media
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
13 #include <sdp.h>
15 \fBsdp_attr_t *\fR\fBsdp_find_media_rtpmap\fR(\fBsdp_media_t *\fR\fImedia\fR,
16      \fBconst char *\fR\fIformat\fR);
17 .fi
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The \fBsdp_find_media_rtpmap()\fR function searches the attribute list of the
23 specified media structure, \fImedia\fR, for the specified \fIformat\fR. If the
24 search is successful a pointer to that \fIrtpmap\fR attribute is returned.
25 Otherwise it returns \fINULL\fR.
26 .SH RETURN VALUES
27 .sp
28 .LP
29 The \fBsdp_find_media_rtpmap()\fR function returns the attribute (\fBsdp_attr_t
30 *\fR) on success and \fINULL\fR when the search fails or the mandatory input
31 parameters are \fINULL\fR.
32 .SH EXAMPLES
33 .LP
34 \fBExample 1 \fRAn (incomplete) SDP description that contains two media
35 sections: audio and video.
36 .sp
37 .in +2
38 .nf
39 m=audio 49170 RTP/AVP 0 8
40 a=rtpmap:0 PCMU/8000
41 a=rtpmap:8 PCMA/8000
42 m=video 51372 RTP/AVP 31 32
43 a=rtpmap:31 H261/90000
44 a=rtpmap:32 MPV/90000
47  * Assuming that above description is parsed using sdp_parse() and that
48  * the parsed structure is in "session" sdp_session_t structure.
49  */
51 sdp_media_t     *video;
52 sdp_attr_t      *mpv;
54 video = sdp_find_media(session->s_media, "video);
55 mpv = sdp_find_media_rtpmap(video, "32");
58  * Now the attribute structure sdp_attr_t, mpv will be having
59  * values from the attribute field "a=rtpmap:32 MPV/90000"
60  */
61 .fi
62 .in -2
64 .SH ATTRIBUTES
65 .sp
66 .LP
67 See \fBattributes\fR(5) for descriptions of the following attributes:
68 .sp
70 .sp
71 .TS
72 box;
73 c | c
74 l | l .
75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
77 Interface Stability     Committed
79 MT-Level        Safe
80 .TE
82 .SH SEE ALSO
83 .sp
84 .LP
85 \fBlibcommputil\fR(3LIB), \fBsdp_parse\fR(3COMMPUTIL), \fBattributes\fR(5)