• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>GstWebRTCSessionDescription: GStreamer Bad Plugins 1.0 Library Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual">
8<link rel="up" href="webrtc.html" title="WebRTC Library">
9<link rel="prev" href="GstWebRTCRTPSender.html" title="GstWebRTCRTPSender">
10<link rel="next" href="GstWebRTCRTPTransceiver.html" title="GstWebRTCRTPTransceiver">
11<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#GstWebRTCSessionDescription.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#GstWebRTCSessionDescription.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20</td>
21<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22<td><a accesskey="u" href="webrtc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23<td><a accesskey="p" href="GstWebRTCRTPSender.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24<td><a accesskey="n" href="GstWebRTCRTPTransceiver.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25</tr></table>
26<div class="refentry">
27<a name="GstWebRTCSessionDescription"></a><div class="titlepage"></div>
28<div class="refnamediv"><table width="100%"><tr>
29<td valign="top">
30<h2><span class="refentrytitle"><a name="GstWebRTCSessionDescription.top_of_page"></a>GstWebRTCSessionDescription</span></h2>
31<p>GstWebRTCSessionDescription — RTCSessionDescription object</p>
32</td>
33<td class="gallery_image" valign="top" align="right"></td>
34</tr></table></div>
35<div class="refsect1">
36<a name="GstWebRTCSessionDescription.functions"></a><h2>Functions</h2>
37<div class="informaltable"><table class="informaltable" width="100%" border="0">
38<colgroup>
39<col width="150px" class="functions_return">
40<col class="functions_name">
41</colgroup>
42<tbody>
43<tr>
44<td class="function_type">
45<a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="returnvalue">GstWebRTCSessionDescription</span></a> *
46</td>
47<td class="function_name">
48<a class="link" href="GstWebRTCSessionDescription.html#gst-webrtc-session-description-new" title="gst_webrtc_session_description_new ()">gst_webrtc_session_description_new</a> <span class="c_punctuation">()</span>
49</td>
50</tr>
51<tr>
52<td class="function_type">
53<a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="returnvalue">GstWebRTCSessionDescription</span></a> *
54</td>
55<td class="function_name">
56<a class="link" href="GstWebRTCSessionDescription.html#gst-webrtc-session-description-copy" title="gst_webrtc_session_description_copy ()">gst_webrtc_session_description_copy</a> <span class="c_punctuation">()</span>
57</td>
58</tr>
59<tr>
60<td class="function_type">
61<span class="returnvalue">void</span>
62</td>
63<td class="function_name">
64<a class="link" href="GstWebRTCSessionDescription.html#gst-webrtc-session-description-free" title="gst_webrtc_session_description_free ()">gst_webrtc_session_description_free</a> <span class="c_punctuation">()</span>
65</td>
66</tr>
67</tbody>
68</table></div>
69</div>
70<div class="refsect1">
71<a name="GstWebRTCSessionDescription.other"></a><h2>Types and Values</h2>
72<div class="informaltable"><table class="informaltable" width="100%" border="0">
73<colgroup>
74<col width="150px" class="name">
75<col class="description">
76</colgroup>
77<tbody><tr>
78<td class="datatype_keyword"> </td>
79<td class="function_name"><a class="link" href="GstWebRTCSessionDescription.html#GstWebRTCSessionDescription-struct" title="GstWebRTCSessionDescription">GstWebRTCSessionDescription</a></td>
80</tr></tbody>
81</table></div>
82</div>
83<div class="refsect1">
84<a name="GstWebRTCSessionDescription.object-hierarchy"></a><h2>Object Hierarchy</h2>
85<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
86    <span class="lineart">╰──</span> GstWebRTCSessionDescription
87</pre>
88</div>
89<div class="refsect1">
90<a name="GstWebRTCSessionDescription.includes"></a><h2>Includes</h2>
91<pre class="synopsis">#include &lt;gst/codecparsers/gstmpeg4parser.h&gt;
92</pre>
93</div>
94<div class="refsect1">
95<a name="GstWebRTCSessionDescription.description"></a><h2>Description</h2>
96<a class="ulink" href="https://www.w3.org/TR/webrtc/#rtcsessiondescription-class" target="_top">https://www.w3.org/TR/webrtc/#rtcsessiondescription-class</a>
97</div>
98<div class="refsect1">
99<a name="GstWebRTCSessionDescription.functions_details"></a><h2>Functions</h2>
100<div class="refsect2">
101<a name="gst-webrtc-session-description-new"></a><h3>gst_webrtc_session_description_new ()</h3>
102<pre class="programlisting"><a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="returnvalue">GstWebRTCSessionDescription</span></a> *
103gst_webrtc_session_description_new (<em class="parameter"><code><span class="type">GstWebRTCSDPType</span> type</code></em>,
104                                    <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstSDPMessage.html#GstSDPMessage"><span class="type">GstSDPMessage</span></a> *sdp</code></em>);</pre>
105<div class="refsect3">
106<a name="gst-webrtc-session-description-new.parameters"></a><h4>Parameters</h4>
107<div class="informaltable"><table class="informaltable" width="100%" border="0">
108<colgroup>
109<col width="150px" class="parameters_name">
110<col class="parameters_description">
111<col width="200px" class="parameters_annotations">
112</colgroup>
113<tbody>
114<tr>
115<td class="parameter_name"><p>type</p></td>
116<td class="parameter_description"><p>a <span class="type">GstWebRTCSDPType</span></p></td>
117<td class="parameter_annotations"> </td>
118</tr>
119<tr>
120<td class="parameter_name"><p>sdp</p></td>
121<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstSDPMessage.html#GstSDPMessage"><span class="type">GstSDPMessage</span></a>. </p></td>
122<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
123</tr>
124</tbody>
125</table></div>
126</div>
127<div class="refsect3">
128<a name="gst-webrtc-session-description-new.returns"></a><h4>Returns</h4>
129<p>a new <a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="type">GstWebRTCSessionDescription</span></a> from <em class="parameter"><code>type</code></em>
130and <em class="parameter"><code>sdp</code></em>
131. </p>
132<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
133</div>
134</div>
135<hr>
136<div class="refsect2">
137<a name="gst-webrtc-session-description-copy"></a><h3>gst_webrtc_session_description_copy ()</h3>
138<pre class="programlisting"><a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="returnvalue">GstWebRTCSessionDescription</span></a> *
139gst_webrtc_session_description_copy (<em class="parameter"><code>const <a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="type">GstWebRTCSessionDescription</span></a> *src</code></em>);</pre>
140<div class="refsect3">
141<a name="gst-webrtc-session-description-copy.parameters"></a><h4>Parameters</h4>
142<div class="informaltable"><table class="informaltable" width="100%" border="0">
143<colgroup>
144<col width="150px" class="parameters_name">
145<col class="parameters_description">
146<col width="200px" class="parameters_annotations">
147</colgroup>
148<tbody><tr>
149<td class="parameter_name"><p>src</p></td>
150<td class="parameter_description"><p>a <a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="type">GstWebRTCSessionDescription</span></a>. </p></td>
151<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
152</tr></tbody>
153</table></div>
154</div>
155<div class="refsect3">
156<a name="gst-webrtc-session-description-copy.returns"></a><h4>Returns</h4>
157<p>a new copy of <em class="parameter"><code>src</code></em>
158. </p>
159<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
160</div>
161</div>
162<hr>
163<div class="refsect2">
164<a name="gst-webrtc-session-description-free"></a><h3>gst_webrtc_session_description_free ()</h3>
165<pre class="programlisting"><span class="returnvalue">void</span>
166gst_webrtc_session_description_free (<em class="parameter"><code><a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="type">GstWebRTCSessionDescription</span></a> *desc</code></em>);</pre>
167<p>Free <em class="parameter"><code>desc</code></em>
168 and all associated resources</p>
169<div class="refsect3">
170<a name="gst-webrtc-session-description-free.parameters"></a><h4>Parameters</h4>
171<div class="informaltable"><table class="informaltable" width="100%" border="0">
172<colgroup>
173<col width="150px" class="parameters_name">
174<col class="parameters_description">
175<col width="200px" class="parameters_annotations">
176</colgroup>
177<tbody><tr>
178<td class="parameter_name"><p>desc</p></td>
179<td class="parameter_description"><p>a <a class="link" href="GstWebRTCSessionDescription.html" title="GstWebRTCSessionDescription"><span class="type">GstWebRTCSessionDescription</span></a>. </p></td>
180<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
181</tr></tbody>
182</table></div>
183</div>
184</div>
185</div>
186<div class="refsect1">
187<a name="GstWebRTCSessionDescription.other_details"></a><h2>Types and Values</h2>
188<div class="refsect2">
189<a name="GstWebRTCSessionDescription-struct"></a><h3>GstWebRTCSessionDescription</h3>
190<pre class="programlisting">typedef struct {
191  GstWebRTCSDPType       type;
192  GstSDPMessage         *sdp;
193} GstWebRTCSessionDescription;
194</pre>
195<p>See <a class="ulink" href="https://www.w3.org/TR/webrtc/#rtcsessiondescription-class" target="_top">https://www.w3.org/TR/webrtc/<span class="type">rtcsessiondescription-class</span></a></p>
196<div class="refsect3">
197<a name="GstWebRTCSessionDescription.members"></a><h4>Members</h4>
198<div class="informaltable"><table class="informaltable" width="100%" border="0">
199<colgroup>
200<col width="300px" class="struct_members_name">
201<col class="struct_members_description">
202<col width="200px" class="struct_members_annotations">
203</colgroup>
204<tbody>
205<tr>
206<td class="struct_member_name"><p><span class="type">GstWebRTCSDPType</span> <em class="structfield"><code><a name="GstWebRTCSessionDescription-struct.type"></a>type</code></em>;</p></td>
207<td class="struct_member_description"><p>the <span class="type">GstWebRTCSDPType</span> of the description</p></td>
208<td class="struct_member_annotations"> </td>
209</tr>
210<tr>
211<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstSDPMessage.html#GstSDPMessage"><span class="type">GstSDPMessage</span></a> *<em class="structfield"><code><a name="GstWebRTCSessionDescription-struct.sdp"></a>sdp</code></em>;</p></td>
212<td class="struct_member_description"><p>the <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstSDPMessage.html#GstSDPMessage"><span class="type">GstSDPMessage</span></a> of the description</p></td>
213<td class="struct_member_annotations"> </td>
214</tr>
215</tbody>
216</table></div>
217</div>
218</div>
219</div>
220</div>
221<div class="footer">
222<hr>Generated by GTK-Doc V1.28</div>
223</body>
224</html>