Initial release including wifi display based on gst-rtsp-server-1.4.1
[platform/upstream/gstreamer.git] / docs / libs / html / gst-rtsp-server-GstRTSPSessionMedia.html
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>GStreamer RTSP Server Reference Manual: GstRTSPSessionMedia</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="GStreamer RTSP Server Reference Manual">
8 <link rel="up" href="ch01.html" title="">
9 <link rel="prev" href="GstRTSPSession.html" title="GstRTSPSession">
10 <link rel="next" href="gst-rtsp-server-GstRTSPStreamTransport.html" title="GstRTSPStreamTransport">
11 <meta name="generator" content="GTK-Doc V1.21 (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">|</span> 
18                   <a href="#gst-rtsp-server-GstRTSPSessionMedia.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="GstRTSPSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gst-rtsp-server-GstRTSPStreamTransport.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="gst-rtsp-server-GstRTSPSessionMedia"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="gst-rtsp-server-GstRTSPSessionMedia.top_of_page"></a>GstRTSPSessionMedia</span></h2>
30 <p>GstRTSPSessionMedia — Media managed in a session</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="gst-rtsp-server-GstRTSPSessionMedia.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-new" title="gst_rtsp_session_media_new ()">gst_rtsp_session_media_new</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
53 </td>
54 <td class="function_name">
55 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-matches" title="gst_rtsp_session_media_matches ()">gst_rtsp_session_media_matches</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="returnvalue">GstRTSPMedia</span></a> *
61 </td>
62 <td class="function_name">
63 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-media" title="gst_rtsp_session_media_get_media ()">gst_rtsp_session_media_get_media</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
69 </td>
70 <td class="function_name">
71 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-base-time" title="gst_rtsp_session_media_get_base_time ()">gst_rtsp_session_media_get_base_time</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
77 </td>
78 <td class="function_name">
79 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-rtpinfo" title="gst_rtsp_session_media_get_rtpinfo ()">gst_rtsp_session_media_get_rtpinfo</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
85 </td>
86 <td class="function_name">
87 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-set-state" title="gst_rtsp_session_media_set_state ()">gst_rtsp_session_media_set_state</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState"><span class="returnvalue">GstRTSPState</span></a>
93 </td>
94 <td class="function_name">
95 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-rtsp-state" title="gst_rtsp_session_media_get_rtsp_state ()">gst_rtsp_session_media_get_rtsp_state</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">void</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-set-rtsp-state" title="gst_rtsp_session_media_set_rtsp_state ()">gst_rtsp_session_media_set_rtsp_state</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="returnvalue">GstRTSPStreamTransport</span></a> *
109 </td>
110 <td class="function_name">
111 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-transport" title="gst_rtsp_session_media_get_transport ()">gst_rtsp_session_media_get_transport</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="returnvalue">GstRTSPStreamTransport</span></a> *
117 </td>
118 <td class="function_name">
119 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-set-transport" title="gst_rtsp_session_media_set_transport ()">gst_rtsp_session_media_set_transport</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
125 </td>
126 <td class="function_name">
127 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-alloc-channels" title="gst_rtsp_session_media_alloc_channels ()">gst_rtsp_session_media_alloc_channels</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 </tbody>
131 </table></div>
132 </div>
133 <div class="refsect1">
134 <a name="gst-rtsp-server-GstRTSPSessionMedia.other"></a><h2>Types and Values</h2>
135 <div class="informaltable"><table width="100%" border="0">
136 <colgroup>
137 <col width="150px" class="name">
138 <col class="description">
139 </colgroup>
140 <tbody>
141 <tr>
142 <td class="datatype_keyword">struct</td>
143 <td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia">GstRTSPSessionMedia</a></td>
144 </tr>
145 <tr>
146 <td class="datatype_keyword">struct</td>
147 <td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMediaClass" title="struct GstRTSPSessionMediaClass">GstRTSPSessionMediaClass</a></td>
148 </tr>
149 </tbody>
150 </table></div>
151 </div>
152 <div class="refsect1">
153 <a name="gst-rtsp-server-GstRTSPSessionMedia.description"></a><h2>Description</h2>
154 <p>The <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> object manages a <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> with a given path.</p>
155 <p>With <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-get-transport" title="gst_rtsp_session_media_get_transport ()"><code class="function">gst_rtsp_session_media_get_transport()</code></a> and
156 <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-set-transport" title="gst_rtsp_session_media_set_transport ()"><code class="function">gst_rtsp_session_media_set_transport()</code></a> the transports of a <a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a> of
157 the managed <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> can be retrieved and configured.</p>
158 <p>Use <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#gst-rtsp-session-media-set-state" title="gst_rtsp_session_media_set_state ()"><code class="function">gst_rtsp_session_media_set_state()</code></a> to control the media state and
159 transports.</p>
160 <p>Last reviewed on 2013-07-16 (1.0.0)</p>
161 </div>
162 <div class="refsect1">
163 <a name="gst-rtsp-server-GstRTSPSessionMedia.functions_details"></a><h2>Functions</h2>
164 <div class="refsect2">
165 <a name="gst-rtsp-session-media-new"></a><h3>gst_rtsp_session_media_new ()</h3>
166 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="returnvalue">GstRTSPSessionMedia</span></a> *
167 gst_rtsp_session_media_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
168                             <em class="parameter"><code><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> *media</code></em>);</pre>
169 <p>Create a new <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> that manages the streams
170 in <em class="parameter"><code>media</code></em>
171  for <em class="parameter"><code>path</code></em>
172 . <em class="parameter"><code>media</code></em>
173  should be prepared.</p>
174 <p>Ownership is taken of <em class="parameter"><code>media</code></em>
175 .</p>
176 <div class="refsect3">
177 <a name="id-1.2.11.6.2.6"></a><h4>Parameters</h4>
178 <div class="informaltable"><table width="100%" border="0">
179 <colgroup>
180 <col width="150px" class="parameters_name">
181 <col class="parameters_description">
182 <col width="200px" class="parameters_annotations">
183 </colgroup>
184 <tbody>
185 <tr>
186 <td class="parameter_name"><p>path</p></td>
187 <td class="parameter_description"><p>the path</p></td>
188 <td class="parameter_annotations"> </td>
189 </tr>
190 <tr>
191 <td class="parameter_name"><p>media</p></td>
192 <td class="parameter_description"><p> the <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>. </p></td>
193 <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>
194 </tr>
195 </tbody>
196 </table></div>
197 </div>
198 <div class="refsect3">
199 <a name="id-1.2.11.6.2.7"></a><h4>Returns</h4>
200 <p> a new <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a>. </p>
201 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
202 </div>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="gst-rtsp-session-media-matches"></a><h3>gst_rtsp_session_media_matches ()</h3>
207 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
208 gst_rtsp_session_media_matches (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
209                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
210                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *matched</code></em>);</pre>
211 <p>Check if the path of <em class="parameter"><code>media</code></em>
212  matches <em class="parameter"><code>path</code></em>
213 . It <em class="parameter"><code>path</code></em>
214  matches, the amount of
215 matched characters is returned in <em class="parameter"><code>matched</code></em>
216 .</p>
217 <div class="refsect3">
218 <a name="id-1.2.11.6.3.5"></a><h4>Parameters</h4>
219 <div class="informaltable"><table width="100%" border="0">
220 <colgroup>
221 <col width="150px" class="parameters_name">
222 <col class="parameters_description">
223 <col width="200px" class="parameters_annotations">
224 </colgroup>
225 <tbody>
226 <tr>
227 <td class="parameter_name"><p>media</p></td>
228 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
229 <td class="parameter_annotations"> </td>
230 </tr>
231 <tr>
232 <td class="parameter_name"><p>path</p></td>
233 <td class="parameter_description"><p>a path</p></td>
234 <td class="parameter_annotations"> </td>
235 </tr>
236 <tr>
237 <td class="parameter_name"><p>matched</p></td>
238 <td class="parameter_description"><p> the amount of matched characters of <em class="parameter"><code>path</code></em>
239 . </p></td>
240 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
241 </tr>
242 </tbody>
243 </table></div>
244 </div>
245 <div class="refsect3">
246 <a name="id-1.2.11.6.3.6"></a><h4>Returns</h4>
247 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when <em class="parameter"><code>path</code></em>
248 matches the path of <em class="parameter"><code>media</code></em>
249 .</p>
250 <p></p>
251 </div>
252 </div>
253 <hr>
254 <div class="refsect2">
255 <a name="gst-rtsp-session-media-get-media"></a><h3>gst_rtsp_session_media_get_media ()</h3>
256 <pre class="programlisting"><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="returnvalue">GstRTSPMedia</span></a> *
257 gst_rtsp_session_media_get_media (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>);</pre>
258 <p>Get the <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> that was used when constructing <em class="parameter"><code>media</code></em>
259 </p>
260 <div class="refsect3">
261 <a name="id-1.2.11.6.4.5"></a><h4>Parameters</h4>
262 <div class="informaltable"><table width="100%" border="0">
263 <colgroup>
264 <col width="150px" class="parameters_name">
265 <col class="parameters_description">
266 <col width="200px" class="parameters_annotations">
267 </colgroup>
268 <tbody><tr>
269 <td class="parameter_name"><p>media</p></td>
270 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
271 <td class="parameter_annotations"> </td>
272 </tr></tbody>
273 </table></div>
274 </div>
275 <div class="refsect3">
276 <a name="id-1.2.11.6.4.6"></a><h4>Returns</h4>
277 <p> the <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> of <em class="parameter"><code>media</code></em>
278 . Remains valid as long
279 as <em class="parameter"><code>media</code></em>
280 is valid. </p>
281 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
282 </div>
283 </div>
284 <hr>
285 <div class="refsect2">
286 <a name="gst-rtsp-session-media-get-base-time"></a><h3>gst_rtsp_session_media_get_base_time ()</h3>
287 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="returnvalue">GstClockTime</span></a>
288 gst_rtsp_session_media_get_base_time (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>);</pre>
289 <p>Get the base_time of the <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> in <em class="parameter"><code>media</code></em>
290 </p>
291 <div class="refsect3">
292 <a name="id-1.2.11.6.5.5"></a><h4>Parameters</h4>
293 <div class="informaltable"><table width="100%" border="0">
294 <colgroup>
295 <col width="150px" class="parameters_name">
296 <col class="parameters_description">
297 <col width="200px" class="parameters_annotations">
298 </colgroup>
299 <tbody><tr>
300 <td class="parameter_name"><p>media</p></td>
301 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
302 <td class="parameter_annotations"> </td>
303 </tr></tbody>
304 </table></div>
305 </div>
306 <div class="refsect3">
307 <a name="id-1.2.11.6.5.6"></a><h4>Returns</h4>
308 <p> the base_time of the media.</p>
309 <p></p>
310 </div>
311 </div>
312 <hr>
313 <div class="refsect2">
314 <a name="gst-rtsp-session-media-get-rtpinfo"></a><h3>gst_rtsp_session_media_get_rtpinfo ()</h3>
315 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
316 gst_rtsp_session_media_get_rtpinfo (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>);</pre>
317 <p>Retrieve the RTP-Info header string for all streams in <em class="parameter"><code>media</code></em>
318
319 with configured transports.</p>
320 <div class="refsect3">
321 <a name="id-1.2.11.6.6.5"></a><h4>Parameters</h4>
322 <div class="informaltable"><table width="100%" border="0">
323 <colgroup>
324 <col width="150px" class="parameters_name">
325 <col class="parameters_description">
326 <col width="200px" class="parameters_annotations">
327 </colgroup>
328 <tbody><tr>
329 <td class="parameter_name"><p>media</p></td>
330 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
331 <td class="parameter_annotations"> </td>
332 </tr></tbody>
333 </table></div>
334 </div>
335 <div class="refsect3">
336 <a name="id-1.2.11.6.6.6"></a><h4>Returns</h4>
337 <p> The RTP-Info as a string or
338 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when no RTP-Info could be generated, <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after usage. </p>
339 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
340 </div>
341 </div>
342 <hr>
343 <div class="refsect2">
344 <a name="gst-rtsp-session-media-set-state"></a><h3>gst_rtsp_session_media_set_state ()</h3>
345 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
346 gst_rtsp_session_media_set_state (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
347                                   <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html#GstState"><span class="type">GstState</span></a> state</code></em>);</pre>
348 <p>Tell the media object <em class="parameter"><code>media</code></em>
349  to change to <em class="parameter"><code>state</code></em>
350 .</p>
351 <div class="refsect3">
352 <a name="id-1.2.11.6.7.5"></a><h4>Parameters</h4>
353 <div class="informaltable"><table width="100%" border="0">
354 <colgroup>
355 <col width="150px" class="parameters_name">
356 <col class="parameters_description">
357 <col width="200px" class="parameters_annotations">
358 </colgroup>
359 <tbody>
360 <tr>
361 <td class="parameter_name"><p>media</p></td>
362 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
363 <td class="parameter_annotations"> </td>
364 </tr>
365 <tr>
366 <td class="parameter_name"><p>state</p></td>
367 <td class="parameter_description"><p>the new state</p></td>
368 <td class="parameter_annotations"> </td>
369 </tr>
370 </tbody>
371 </table></div>
372 </div>
373 <div class="refsect3">
374 <a name="id-1.2.11.6.7.6"></a><h4>Returns</h4>
375 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
376 <p></p>
377 </div>
378 </div>
379 <hr>
380 <div class="refsect2">
381 <a name="gst-rtsp-session-media-get-rtsp-state"></a><h3>gst_rtsp_session_media_get_rtsp_state ()</h3>
382 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState"><span class="returnvalue">GstRTSPState</span></a>
383 gst_rtsp_session_media_get_rtsp_state (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>);</pre>
384 <p>Get the current RTSP state of <em class="parameter"><code>media</code></em>
385 .</p>
386 <div class="refsect3">
387 <a name="id-1.2.11.6.8.5"></a><h4>Parameters</h4>
388 <div class="informaltable"><table width="100%" border="0">
389 <colgroup>
390 <col width="150px" class="parameters_name">
391 <col class="parameters_description">
392 <col width="200px" class="parameters_annotations">
393 </colgroup>
394 <tbody><tr>
395 <td class="parameter_name"><p>media</p></td>
396 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
397 <td class="parameter_annotations"> </td>
398 </tr></tbody>
399 </table></div>
400 </div>
401 <div class="refsect3">
402 <a name="id-1.2.11.6.8.6"></a><h4>Returns</h4>
403 <p> the current RTSP state of <em class="parameter"><code>media</code></em>
404 .</p>
405 <p></p>
406 </div>
407 </div>
408 <hr>
409 <div class="refsect2">
410 <a name="gst-rtsp-session-media-set-rtsp-state"></a><h3>gst_rtsp_session_media_set_rtsp_state ()</h3>
411 <pre class="programlisting"><span class="returnvalue">void</span>
412 gst_rtsp_session_media_set_rtsp_state (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
413                                        <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState"><span class="type">GstRTSPState</span></a> state</code></em>);</pre>
414 <p>Set the RTSP state of <em class="parameter"><code>media</code></em>
415  to <em class="parameter"><code>state</code></em>
416 .</p>
417 <div class="refsect3">
418 <a name="id-1.2.11.6.9.5"></a><h4>Parameters</h4>
419 <div class="informaltable"><table width="100%" border="0">
420 <colgroup>
421 <col width="150px" class="parameters_name">
422 <col class="parameters_description">
423 <col width="200px" class="parameters_annotations">
424 </colgroup>
425 <tbody>
426 <tr>
427 <td class="parameter_name"><p>media</p></td>
428 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
429 <td class="parameter_annotations"> </td>
430 </tr>
431 <tr>
432 <td class="parameter_name"><p>state</p></td>
433 <td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspdefs.html#GstRTSPState"><span class="type">GstRTSPState</span></a></p></td>
434 <td class="parameter_annotations"> </td>
435 </tr>
436 </tbody>
437 </table></div>
438 </div>
439 </div>
440 <hr>
441 <div class="refsect2">
442 <a name="gst-rtsp-session-media-get-transport"></a><h3>gst_rtsp_session_media_get_transport ()</h3>
443 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="returnvalue">GstRTSPStreamTransport</span></a> *
444 gst_rtsp_session_media_get_transport (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
445                                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> idx</code></em>);</pre>
446 <p>Get a previously created <a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="type">GstRTSPStreamTransport</span></a> for the stream at <em class="parameter"><code>idx</code></em>
447 .</p>
448 <div class="refsect3">
449 <a name="id-1.2.11.6.10.5"></a><h4>Parameters</h4>
450 <div class="informaltable"><table width="100%" border="0">
451 <colgroup>
452 <col width="150px" class="parameters_name">
453 <col class="parameters_description">
454 <col width="200px" class="parameters_annotations">
455 </colgroup>
456 <tbody>
457 <tr>
458 <td class="parameter_name"><p>media</p></td>
459 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
460 <td class="parameter_annotations"> </td>
461 </tr>
462 <tr>
463 <td class="parameter_name"><p>idx</p></td>
464 <td class="parameter_description"><p>the stream index</p></td>
465 <td class="parameter_annotations"> </td>
466 </tr>
467 </tbody>
468 </table></div>
469 </div>
470 <div class="refsect3">
471 <a name="id-1.2.11.6.10.6"></a><h4>Returns</h4>
472 <p> a <a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="type">GstRTSPStreamTransport</span></a> that is valid until the
473 session of <em class="parameter"><code>media</code></em>
474 is unreffed. </p>
475 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
476 </div>
477 </div>
478 <hr>
479 <div class="refsect2">
480 <a name="gst-rtsp-session-media-set-transport"></a><h3>gst_rtsp_session_media_set_transport ()</h3>
481 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="returnvalue">GstRTSPStreamTransport</span></a> *
482 gst_rtsp_session_media_set_transport (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
483                                       <em class="parameter"><code><a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a> *stream</code></em>,
484                                       <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport"><span class="type">GstRTSPTransport</span></a> *tr</code></em>);</pre>
485 <p>Configure the transport for <em class="parameter"><code>stream</code></em>
486  to <em class="parameter"><code>tr</code></em>
487  in <em class="parameter"><code>media</code></em>
488 .</p>
489 <div class="refsect3">
490 <a name="id-1.2.11.6.11.5"></a><h4>Parameters</h4>
491 <div class="informaltable"><table width="100%" border="0">
492 <colgroup>
493 <col width="150px" class="parameters_name">
494 <col class="parameters_description">
495 <col width="200px" class="parameters_annotations">
496 </colgroup>
497 <tbody>
498 <tr>
499 <td class="parameter_name"><p>media</p></td>
500 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
501 <td class="parameter_annotations"> </td>
502 </tr>
503 <tr>
504 <td class="parameter_name"><p>stream</p></td>
505 <td class="parameter_description"><p>a <a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a></p></td>
506 <td class="parameter_annotations"> </td>
507 </tr>
508 <tr>
509 <td class="parameter_name"><p>tr</p></td>
510 <td class="parameter_description"><p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtsptransport.html#GstRTSPTransport"><span class="type">GstRTSPTransport</span></a>. </p></td>
511 <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>
512 </tr>
513 </tbody>
514 </table></div>
515 </div>
516 <div class="refsect3">
517 <a name="id-1.2.11.6.11.6"></a><h4>Returns</h4>
518 <p> the new or updated <a class="link" href="gst-rtsp-server-GstRTSPStreamTransport.html#GstRTSPStreamTransport" title="struct GstRTSPStreamTransport"><span class="type">GstRTSPStreamTransport</span></a> for <em class="parameter"><code>stream</code></em>
519 . </p>
520 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
521 </div>
522 </div>
523 <hr>
524 <div class="refsect2">
525 <a name="gst-rtsp-session-media-alloc-channels"></a><h3>gst_rtsp_session_media_alloc_channels ()</h3>
526 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
527 gst_rtsp_session_media_alloc_channels (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *media</code></em>,
528                                        <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange"><span class="type">GstRTSPRange</span></a> *range</code></em>);</pre>
529 <p>Fill <em class="parameter"><code>range</code></em>
530  with the next available min and max channels for
531 interleaved transport.</p>
532 <div class="refsect3">
533 <a name="id-1.2.11.6.12.5"></a><h4>Parameters</h4>
534 <div class="informaltable"><table width="100%" border="0">
535 <colgroup>
536 <col width="150px" class="parameters_name">
537 <col class="parameters_description">
538 <col width="200px" class="parameters_annotations">
539 </colgroup>
540 <tbody>
541 <tr>
542 <td class="parameter_name"><p>media</p></td>
543 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p></td>
544 <td class="parameter_annotations"> </td>
545 </tr>
546 <tr>
547 <td class="parameter_name"><p>range</p></td>
548 <td class="parameter_description"><p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtsptransport.html#GstRTSPRange"><span class="type">GstRTSPRange</span></a>. </p></td>
549 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
550 </tr>
551 </tbody>
552 </table></div>
553 </div>
554 <div class="refsect3">
555 <a name="id-1.2.11.6.12.6"></a><h4>Returns</h4>
556 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
557 <p></p>
558 </div>
559 </div>
560 </div>
561 <div class="refsect1">
562 <a name="gst-rtsp-server-GstRTSPSessionMedia.other_details"></a><h2>Types and Values</h2>
563 <div class="refsect2">
564 <a name="GstRTSPSessionMedia"></a><h3>struct GstRTSPSessionMedia</h3>
565 <pre class="programlisting">struct GstRTSPSessionMedia {
566   GObject  parent;
567 };
568 </pre>
569 <p>State of a client session regarding a specific media identified by path.</p>
570 </div>
571 <hr>
572 <div class="refsect2">
573 <a name="GstRTSPSessionMediaClass"></a><h3>struct GstRTSPSessionMediaClass</h3>
574 <pre class="programlisting">struct GstRTSPSessionMediaClass {
575   GObjectClass  parent_class;
576 };
577 </pre>
578 </div>
579 </div>
580 <div class="refsect1">
581 <a name="gst-rtsp-server-GstRTSPSessionMedia.see-also"></a><h2>See Also</h2>
582 <p><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>, <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a></p>
583 </div>
584 </div>
585 <div class="footer">
586 <hr>
587           Generated by GTK-Doc V1.21</div>
588 </body>
589 </html>