libgstrtspserver-1.0-doc 1.14.0-1 / usr / share / gtk-doc / html / gst-rtsp-server-1.0 / gst-rtsp-server-GstRTSPOnvifMedia.html

This file is indexed.

/usr/share/gtk-doc/html/gst-rtsp-server-1.0/gst-rtsp-server-GstRTSPOnvifMedia.html is in libgstrtspserver-1.0-doc 1.14.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstRTSPOnvifMedia: GStreamer RTSP Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer RTSP Server Reference Manual">
<link rel="up" href="ch01.html" title="">
<link rel="prev" href="gst-rtsp-server-GstRTSPOnvifMediaFactory.html" title="GstRTSPOnvifMediaFactory">
<link rel="next" href="rtsp-server-hierarchy.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-rtsp-server-GstRTSPOnvifMedia.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-rtsp-server-GstRTSPOnvifMediaFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="rtsp-server-hierarchy.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-rtsp-server-GstRTSPOnvifMedia"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-rtsp-server-GstRTSPOnvifMedia.top_of_page"></a>GstRTSPOnvifMedia</span></h2>
<p>GstRTSPOnvifMedia — The ONVIF media pipeline</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#gst-rtsp-onvif-media-collect-backchannel" title="gst_rtsp_onvif_media_collect_backchannel ()">gst_rtsp_onvif_media_collect_backchannel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#gst-rtsp-onvif-media-get-backchannel-bandwidth" title="gst_rtsp_onvif_media_get_backchannel_bandwidth ()">gst_rtsp_onvif_media_get_backchannel_bandwidth</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#gst-rtsp-onvif-media-set-backchannel-bandwidth" title="gst_rtsp_onvif_media_set_backchannel_bandwidth ()">gst_rtsp_onvif_media_set_backchannel_bandwidth</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia">GstRTSPOnvifMedia</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMediaClass" title="GstRTSPOnvifMediaClass">GstRTSPOnvifMediaClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.description"></a><h2>Description</h2>
<p>a <a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia"><span class="type">GstRTSPOnvifMedia</span></a> contains the complete GStreamer pipeline to manage the
streaming to the clients. The actual data transfer is done by the
<a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a> objects that are created and exposed by the <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>.</p>
<p>On top of <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> this subclass adds special ONVIF features.
Special ONVIF features that are currently supported is a backchannel for
the client to send back media to the server in a normal PLAY media. To
handle the ONVIF backchannel, a <a class="link" href="gst-rtsp-server-GstRTSPOnvifMediaFactory.html#GstRTSPOnvifMediaFactory" title="GstRTSPOnvifMediaFactory"><span class="type">GstRTSPOnvifMediaFactory</span></a> and
<a class="link" href="gst-rtsp-server-GstRTSPOnvifServer.html#GstRTSPOnvifServer" title="GstRTSPOnvifServer"><span class="type">GstRTSPOnvifServer</span></a> has to be used.</p>
</div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-rtsp-onvif-media-collect-backchannel"></a><h3>gst_rtsp_onvif_media_collect_backchannel ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gst_rtsp_onvif_media_collect_backchannel
                               (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia"><span class="type">GstRTSPOnvifMedia</span></a> *media</code></em>);</pre>
<p>Find the ONVIF backchannel depayloader element. It should be named
'depay_backchannel', be placed in a bin called 'onvif-backchannel'
and return all supported RTP caps on a caps query. Complete RTP caps with
at least the payload type, clock-rate and encoding-name are required.</p>
<p>A new <a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a> is created for the backchannel if found.</p>
<div class="refsect3">
<a name="gst-rtsp-onvif-media-collect-backchannel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>media</p></td>
<td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia"><span class="type">GstRTSPOnvifMedia</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtsp-onvif-media-collect-backchannel.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a backchannel stream could be found and created</p>
</div>
<p class="since">Since: 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-onvif-media-get-backchannel-bandwidth"></a><h3>gst_rtsp_onvif_media_get_backchannel_bandwidth ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gst_rtsp_onvif_media_get_backchannel_bandwidth
                               (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia"><span class="type">GstRTSPOnvifMedia</span></a> *media</code></em>);</pre>
<p>Get the configured/supported bandwidth of the ONVIF backchannel pipeline in
bits per second.</p>
<div class="refsect3">
<a name="gst-rtsp-onvif-media-get-backchannel-bandwidth.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>factory</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-rtsp-onvif-media-get-backchannel-bandwidth.returns"></a><h4>Returns</h4>
<p> the configured/supported backchannel bandwidth.</p>
</div>
<p class="since">Since: 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-rtsp-onvif-media-set-backchannel-bandwidth"></a><h3>gst_rtsp_onvif_media_set_backchannel_bandwidth ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_rtsp_onvif_media_set_backchannel_bandwidth
                               (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPOnvifMedia.html#GstRTSPOnvifMedia" title="GstRTSPOnvifMedia"><span class="type">GstRTSPOnvifMedia</span></a> *media</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> bandwidth</code></em>);</pre>
<p>Set the configured/supported bandwidth of the ONVIF backchannel pipeline in
bits per second.</p>
<div class="refsect3">
<a name="gst-rtsp-onvif-media-set-backchannel-bandwidth.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>factory</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bandwidth</p></td>
<td class="parameter_description"><p>the bandwidth in bits per second</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.14</p>
</div>
</div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstRTSPOnvifMedia"></a><h3>GstRTSPOnvifMedia</h3>
<pre class="programlisting">typedef struct GstRTSPOnvifMedia GstRTSPOnvifMedia;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GstRTSPOnvifMediaClass"></a><h3>GstRTSPOnvifMediaClass</h3>
<pre class="programlisting">typedef struct GstRTSPOnvifMediaClass GstRTSPOnvifMediaClass;
</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-rtsp-server-GstRTSPOnvifMedia.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a>, <a class="link" href="gst-rtsp-server-GstRTSPOnvifMediaFactory.html#GstRTSPOnvifMediaFactory" title="GstRTSPOnvifMediaFactory"><span class="type">GstRTSPOnvifMediaFactory</span></a>, <a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a>, <a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a>,
    <a class="link" href="GstRTSPSessionMedia.html" title="GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.