docs: update docs
[platform/upstream/gstreamer.git] / docs / libs / gst-rtsp-server-sections.txt
1 <SECTION>
2 <FILE>rtsp-address-pool</FILE>
3 <TITLE>GstRTSPAddressPool</TITLE>
4 GST_RTSP_ADDRESS_POOL_ANY_IPV4
5 GST_RTSP_ADDRESS_POOL_ANY_IPV6
6 GstRTSPAddress
7 GstRTSPAddressFlags
8 gst_rtsp_address_copy
9 gst_rtsp_address_free
10
11 GstRTSPAddressPool
12 GstRTSPAddressPoolClass
13 gst_rtsp_address_pool_new
14 gst_rtsp_address_pool_clear
15 gst_rtsp_address_pool_dump
16 gst_rtsp_address_pool_add_range
17 gst_rtsp_address_pool_add_range_unicast
18 gst_rtsp_address_pool_has_unicast_addresses
19 gst_rtsp_address_pool_acquire_address
20 gst_rtsp_address_pool_reserve_address
21 <SUBSECTION Standard>
22 GST_RTSP_ADDRESS_POOL_CAST
23 GST_RTSP_ADDRESS_POOL_CLASS_CAST
24 GST_IS_RTSP_ADDRESS_POOL
25 GST_IS_RTSP_ADDRESS_POOL_CLASS
26 GST_RTSP_ADDRESS_POOL
27 GST_RTSP_ADDRESS_POOL_CLASS
28 GST_RTSP_ADDRESS_POOL_GET_CLASS
29 GST_TYPE_RTSP_ADDRESS_POOL
30 GstRTSPAddressPoolPrivate
31 gst_rtsp_address_get_type
32 gst_rtsp_address_pool_get_type
33 </SECTION>
34
35 <SECTION>
36 <FILE>rtsp-auth</FILE>
37 <TITLE>GstRTSPAuth</TITLE>
38 GstRTSPAuth
39 GstRTSPAuthClass
40 gst_rtsp_auth_new
41
42 gst_rtsp_auth_make_basic
43 gst_rtsp_auth_add_basic
44 gst_rtsp_auth_remove_basic
45 gst_rtsp_auth_setup
46 gst_rtsp_auth_check
47
48 GST_RTSP_AUTH_CHECK_URL
49 GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS
50 GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT
51
52 GST_RTSP_MEDIA_FACTORY_ROLE
53 GST_RTSP_MEDIA_FACTORY_PERM_ACCESS
54 GST_RTSP_MEDIA_FACTORY_PERM_CONSTRUCT
55 <SUBSECTION Standard>
56 GST_RTSP_AUTH_CAST
57 GST_RTSP_AUTH_CLASS_CAST
58 GST_IS_RTSP_AUTH
59 GST_IS_RTSP_AUTH_CLASS
60 GST_RTSP_AUTH
61 GST_RTSP_AUTH_CLASS
62 GST_RTSP_AUTH_GET_CLASS
63 GST_TYPE_RTSP_AUTH
64 GstRTSPAuthPrivate
65 gst_rtsp_auth_get_type
66 </SECTION>
67
68 <SECTION>
69 <FILE>rtsp-client</FILE>
70 <TITLE>GstRTSPClient</TITLE>
71 GstRTSPClientState
72 gst_rtsp_client_state_get_current
73
74 GstRTSPClient
75 GstRTSPClientClass
76
77 gst_rtsp_client_new
78
79 gst_rtsp_client_get_session_pool
80 gst_rtsp_client_set_session_pool
81
82 gst_rtsp_client_get_mount_points
83 gst_rtsp_client_set_mount_points
84
85 gst_rtsp_client_get_use_client_settings
86 gst_rtsp_client_set_use_client_settings
87
88 gst_rtsp_client_get_auth
89 gst_rtsp_client_set_auth
90
91 gst_rtsp_client_get_thread_pool
92 gst_rtsp_client_set_thread_pool
93
94 gst_rtsp_client_get_connection
95 gst_rtsp_client_set_connection
96
97 GstRTSPClientSendFunc
98 gst_rtsp_client_set_send_func
99
100 gst_rtsp_client_handle_message
101 gst_rtsp_client_send_request
102 gst_rtsp_client_attach
103
104 GstRTSPClientSessionFilterFunc
105 gst_rtsp_client_session_filter
106 <SUBSECTION Standard>
107 GST_RTSP_CLIENT_CAST
108 GST_RTSP_CLIENT_CLASS_CAST
109 GST_IS_RTSP_CLIENT
110 GST_IS_RTSP_CLIENT_CLASS
111 GST_RTSP_CLIENT
112 GST_RTSP_CLIENT_CLASS
113 GST_RTSP_CLIENT_GET_CLASS
114 GST_TYPE_RTSP_CLIENT
115 GstRTSPClientPrivate
116 gst_rtsp_client_get_type
117 </SECTION>
118
119 <SECTION>
120 <FILE>rtsp-media</FILE>
121 <TITLE>GstRTSPMedia</TITLE>
122 GstRTSPMediaStatus
123
124 GstRTSPMedia
125 GstRTSPMediaClass
126 gst_rtsp_media_new
127 gst_rtsp_media_get_element
128 gst_rtsp_media_take_pipeline
129 gst_rtsp_media_get_status
130
131 gst_rtsp_media_set_permissions
132 gst_rtsp_media_get_permissions
133
134 gst_rtsp_media_set_shared
135 gst_rtsp_media_is_shared
136
137 gst_rtsp_media_set_reusable
138 gst_rtsp_media_is_reusable
139
140 gst_rtsp_media_set_protocols
141 gst_rtsp_media_get_protocols
142
143 gst_rtsp_media_set_eos_shutdown
144 gst_rtsp_media_is_eos_shutdown
145
146 gst_rtsp_media_set_address_pool
147 gst_rtsp_media_get_address_pool
148
149 gst_rtsp_media_set_buffer_size
150 gst_rtsp_media_get_buffer_size
151
152 gst_rtsp_media_use_time_provider
153 gst_rtsp_media_is_time_provider
154 gst_rtsp_media_get_time_provider
155
156 gst_rtsp_media_prepare
157 gst_rtsp_media_unprepare
158
159 gst_rtsp_media_collect_streams
160 gst_rtsp_media_create_stream
161
162 gst_rtsp_media_get_clock
163 gst_rtsp_media_get_base_time
164 gst_rtsp_media_n_streams
165 gst_rtsp_media_get_stream
166 gst_rtsp_media_find_stream
167
168 gst_rtsp_media_seek
169 gst_rtsp_media_get_range_string
170
171 gst_rtsp_media_set_state
172 <SUBSECTION Standard>
173 GST_RTSP_MEDIA_CAST
174 GST_RTSP_MEDIA_CLASS_CAST
175 GST_IS_RTSP_MEDIA
176 GST_IS_RTSP_MEDIA_CLASS
177 GST_RTSP_MEDIA
178 GST_RTSP_MEDIA_CLASS
179 GST_RTSP_MEDIA_GET_CLASS
180 GST_TYPE_RTSP_MEDIA
181 GstRTSPMediaPrivate
182 gst_rtsp_media_get_type
183 </SECTION>
184
185 <SECTION>
186 <FILE>rtsp-media-factory</FILE>
187 <TITLE>GstRTSPMediaFactory</TITLE>
188 GstRTSPMediaFactory
189 GstRTSPMediaFactoryClass
190
191 gst_rtsp_media_factory_new
192
193 gst_rtsp_media_factory_construct
194 gst_rtsp_media_factory_create_element
195
196 gst_rtsp_media_factory_get_address_pool
197 gst_rtsp_media_factory_set_address_pool
198
199 gst_rtsp_media_factory_get_buffer_size
200 gst_rtsp_media_factory_set_buffer_size
201
202 gst_rtsp_media_factory_get_launch
203 gst_rtsp_media_factory_set_launch
204
205 gst_rtsp_media_factory_get_permissions
206 gst_rtsp_media_factory_set_permissions
207
208 gst_rtsp_media_factory_get_protocols
209 gst_rtsp_media_factory_set_protocols
210
211 gst_rtsp_media_factory_is_eos_shutdown
212 gst_rtsp_media_factory_set_eos_shutdown
213
214 gst_rtsp_media_factory_set_shared
215 gst_rtsp_media_factory_is_shared
216 <SUBSECTION Standard>
217 GST_RTSP_MEDIA_FACTORY_CAST
218 GST_RTSP_MEDIA_FACTORY_CLASS_CAST
219 GST_IS_RTSP_MEDIA_FACTORY
220 GST_IS_RTSP_MEDIA_FACTORY_CLASS
221 GST_RTSP_MEDIA_FACTORY
222 GST_RTSP_MEDIA_FACTORY_CLASS
223 GST_RTSP_MEDIA_FACTORY_GET_CLASS
224 GST_TYPE_RTSP_MEDIA_FACTORY
225 GstRTSPMediaFactoryPrivate
226 gst_rtsp_media_factory_get_type
227 </SECTION>
228
229 <SECTION>
230 <FILE>rtsp-media-factory-uri</FILE>
231 <TITLE>GstRTSPMediaFactoryURI</TITLE>
232 GstRTSPMediaFactoryURI
233 GstRTSPMediaFactoryURIClass
234 gst_rtsp_media_factory_uri_new
235 gst_rtsp_media_factory_uri_set_uri
236 gst_rtsp_media_factory_uri_get_uri
237 <SUBSECTION Standard>
238 GST_RTSP_MEDIA_FACTORY_URI_CAST
239 GST_RTSP_MEDIA_FACTORY_URI_CLASS_CAST
240 GST_IS_RTSP_MEDIA_FACTORY_URI
241 GST_IS_RTSP_MEDIA_FACTORY_URI_CLASS
242 GST_RTSP_MEDIA_FACTORY_URI
243 GST_RTSP_MEDIA_FACTORY_URI_CLASS
244 GST_RTSP_MEDIA_FACTORY_URI_GET_CLASS
245 GST_TYPE_RTSP_MEDIA_FACTORY_URI
246 GstRTSPMediaFactoryURIPrivate
247 gst_rtsp_media_factory_uri_get_type
248 </SECTION>
249
250 <SECTION>
251 <FILE>rtsp-mount-points</FILE>
252 <TITLE>GstRTSPMountPoints</TITLE>
253 GstRTSPMountPoints
254 GstRTSPMountPointsClass
255 gst_rtsp_mount_points_new
256 gst_rtsp_mount_points_add_factory
257 gst_rtsp_mount_points_remove_factory
258 gst_rtsp_mount_points_match
259 <SUBSECTION Standard>
260 GST_RTSP_MOUNT_POINTS_CAST
261 GST_RTSP_MOUNT_POINTS_CLASS_CAST
262 GST_IS_RTSP_MOUNT_POINTS
263 GST_IS_RTSP_MOUNT_POINTS_CLASS
264 GST_RTSP_MOUNT_POINTS
265 GST_RTSP_MOUNT_POINTS_CLASS
266 GST_RTSP_MOUNT_POINTS_GET_CLASS
267 GST_TYPE_RTSP_MOUNT_POINTS
268 GstRTSPMountPointsPrivate
269 gst_rtsp_mount_points_get_type
270 </SECTION>
271
272 <SECTION>
273 <FILE>rtsp-params</FILE>
274 <TITLE>GstRTSPParams</TITLE>
275 gst_rtsp_params_get
276 gst_rtsp_params_set
277 </SECTION>
278
279 <SECTION>
280 <FILE>rtsp-permissions</FILE>
281 <TITLE>GstRTSPPermissions</TITLE>
282 GstRTSPPermissions
283 gst_rtsp_permissions_new
284 gst_rtsp_permissions_ref
285 gst_rtsp_permissions_unref
286 gst_rtsp_permissions_add_role
287 gst_rtsp_permissions_remove_role
288 gst_rtsp_permissions_get_role
289 gst_rtsp_permissions_is_allowed
290 <SUBSECTION Standard>
291 GST_RTSP_PERMISSIONS_CAST
292 GST_IS_RTSP_PERMISSIONS
293 GST_RTSP_PERMISSIONS
294 GST_TYPE_RTSP_PERMISSIONS
295 gst_rtsp_permissions_get_type
296 </SECTION>
297
298 <SECTION>
299 <FILE>rtsp-sdp</FILE>
300 <TITLE>GstRTSPSdp</TITLE>
301 GstSDPInfo
302 gst_rtsp_sdp_from_media
303 </SECTION>
304
305 <SECTION>
306 <FILE>rtsp-server</FILE>
307 <TITLE>GstRTSPServer</TITLE>
308 GstRTSPServer
309 GstRTSPServerClass
310
311 gst_rtsp_server_new
312
313 gst_rtsp_server_get_address
314 gst_rtsp_server_set_address
315
316 gst_rtsp_server_get_service
317 gst_rtsp_server_set_service
318
319 gst_rtsp_server_get_bound_port
320
321 gst_rtsp_server_get_backlog
322 gst_rtsp_server_set_backlog
323
324 gst_rtsp_server_get_mount_points
325 gst_rtsp_server_set_mount_points
326
327 gst_rtsp_server_get_session_pool
328 gst_rtsp_server_set_session_pool
329
330 gst_rtsp_server_get_thread_pool
331 gst_rtsp_server_set_thread_pool
332
333 gst_rtsp_server_get_auth
334 gst_rtsp_server_set_auth
335
336 gst_rtsp_server_get_tls_certificate
337 gst_rtsp_server_set_tls_certificate
338
339 gst_rtsp_server_get_use_client_settings
340 gst_rtsp_server_set_use_client_settings
341
342 gst_rtsp_server_transfer_connection
343 gst_rtsp_server_io_func
344 gst_rtsp_server_create_socket
345 gst_rtsp_server_create_source
346 gst_rtsp_server_attach
347 <SUBSECTION Standard>
348 GST_IS_RTSP_SERVER
349 GST_RTSP_SERVER_CAST
350 GST_RTSP_SERVER_CLASS_CAST
351 GST_IS_RTSP_SERVER_CLASS
352 GST_RTSP_SERVER
353 GST_RTSP_SERVER_CLASS
354 GST_RTSP_SERVER_GET_CLASS
355 GST_TYPE_RTSP_SERVER
356 GstRTSPServerPrivate
357 gst_rtsp_server_get_type
358 </SECTION>
359
360 <SECTION>
361 <FILE>rtsp-session</FILE>
362 <TITLE>GstRTSPSession</TITLE>
363 GstRTSPSession
364 GstRTSPSessionClass
365
366 gst_rtsp_session_new
367 gst_rtsp_session_get_sessionid
368
369 gst_rtsp_session_get_header
370
371 gst_rtsp_session_set_timeout
372 gst_rtsp_session_get_timeout
373
374 gst_rtsp_session_touch
375 gst_rtsp_session_prevent_expire
376 gst_rtsp_session_allow_expire
377 gst_rtsp_session_next_timeout
378 gst_rtsp_session_is_expired
379
380 gst_rtsp_session_manage_media
381 gst_rtsp_session_release_media
382
383 gst_rtsp_session_get_media
384
385 GstRTSPFilterResult
386 GstRTSPSessionFilterFunc
387 gst_rtsp_session_filter
388 <SUBSECTION Standard>
389 GST_RTSP_SESSION_CAST
390 GST_RTSP_SESSION_CLASS_CAST
391 GST_IS_RTSP_SESSION
392 GST_IS_RTSP_SESSION_CLASS
393 GST_RTSP_SESSION
394 GST_RTSP_SESSION_CLASS
395 GST_RTSP_SESSION_GET_CLASS
396 GST_TYPE_RTSP_SESSION
397 GstRTSPSessionPrivate
398 gst_rtsp_session_get_type
399 </SECTION>
400
401 <SECTION>
402 <FILE>rtsp-session-media</FILE>
403 <TITLE>GstRTSPSessionMedia</TITLE>
404 GstRTSPSessionMedia
405 GstRTSPSessionMediaClass
406 gst_rtsp_session_media_new
407 gst_rtsp_session_media_matches
408
409 gst_rtsp_session_media_get_media
410 gst_rtsp_session_media_get_base_time
411
412 gst_rtsp_session_media_set_state
413
414 gst_rtsp_session_media_get_rtsp_state
415 gst_rtsp_session_media_set_rtsp_state
416
417 gst_rtsp_session_media_get_transport
418 gst_rtsp_session_media_set_transport
419
420 gst_rtsp_session_media_alloc_channels
421 <SUBSECTION Standard>
422 GST_RTSP_SESSION_MEDIA_CAST
423 GST_RTSP_SESSION_MEDIA_CLASS_CAST
424 GST_IS_RTSP_SESSION_MEDIA
425 GST_IS_RTSP_SESSION_MEDIA_CLASS
426 GST_RTSP_SESSION_MEDIA
427 GST_RTSP_SESSION_MEDIA_CLASS
428 GST_RTSP_SESSION_MEDIA_GET_CLASS
429 GST_TYPE_RTSP_SESSION_MEDIA
430 GstRTSPSessionMediaPrivate
431 gst_rtsp_session_media_get_type
432 </SECTION>
433
434 <SECTION>
435 <FILE>rtsp-session-pool</FILE>
436 <TITLE>GstRTSPSessionPool</TITLE>
437 GstRTSPSessionPool
438 GstRTSPSessionPoolClass
439 gst_rtsp_session_pool_new
440
441 gst_rtsp_session_pool_get_max_sessions
442 gst_rtsp_session_pool_set_max_sessions
443
444 gst_rtsp_session_pool_get_n_sessions
445
446 gst_rtsp_session_pool_create
447 gst_rtsp_session_pool_find
448 gst_rtsp_session_pool_remove
449
450 gst_rtsp_session_pool_cleanup
451
452 GstRTSPSessionPoolFunc
453 gst_rtsp_session_pool_create_watch
454
455 GstRTSPSessionPoolFilterFunc
456 gst_rtsp_session_pool_filter
457 <SUBSECTION Standard>
458 GST_RTSP_SESSION_POOL_CAST
459 GST_RTSP_SESSION_POOL_CLASS_CAST
460 GST_IS_RTSP_SESSION_POOL
461 GST_IS_RTSP_SESSION_POOL_CLASS
462 GST_RTSP_SESSION_POOL
463 GST_RTSP_SESSION_POOL_CLASS
464 GST_RTSP_SESSION_POOL_GET_CLASS
465 GST_TYPE_RTSP_SESSION_POOL
466 GstRTSPSessionPoolPrivate
467 gst_rtsp_session_pool_get_type
468 </SECTION>
469
470 <SECTION>
471 <FILE>rtsp-stream</FILE>
472 <TITLE>GstRTSPStream</TITLE>
473 GstRTSPStream
474 GstRTSPStreamClass
475 gst_rtsp_stream_new
476
477 gst_rtsp_stream_get_index
478 gst_rtsp_stream_get_srcpad
479
480 gst_rtsp_stream_get_control
481 gst_rtsp_stream_set_control
482 gst_rtsp_stream_has_control
483
484 gst_rtsp_stream_get_mtu
485 gst_rtsp_stream_set_mtu
486
487 gst_rtsp_stream_get_dscp_qos
488 gst_rtsp_stream_set_dscp_qos
489
490 gst_rtsp_stream_get_address_pool
491 gst_rtsp_stream_set_address_pool
492 gst_rtsp_stream_reserve_address
493
494 gst_rtsp_stream_join_bin
495 gst_rtsp_stream_leave_bin
496
497 gst_rtsp_stream_get_server_port
498 gst_rtsp_stream_get_multicast_address
499 gst_rtsp_stream_get_rtpsession
500 gst_rtsp_stream_get_ssrc
501 gst_rtsp_stream_get_rtpinfo
502 gst_rtsp_stream_get_caps
503
504 gst_rtsp_stream_recv_rtcp
505 gst_rtsp_stream_recv_rtp
506
507 gst_rtsp_stream_add_transport
508 gst_rtsp_stream_remove_transport
509 <SUBSECTION Standard>
510 GST_RTSP_STREAM_CAST
511 GST_RTSP_STREAM_CLASS_CAST
512 GST_IS_RTSP_STREAM
513 GST_IS_RTSP_STREAM_CLASS
514 GST_RTSP_STREAM
515 GST_RTSP_STREAM_CLASS
516 GST_RTSP_STREAM_GET_CLASS
517 GST_TYPE_RTSP_STREAM
518 GstRTSPStreamPrivate
519 gst_rtsp_stream_get_type
520 </SECTION>
521
522 <SECTION>
523 <FILE>rtsp-stream-transport</FILE>
524 <TITLE>GstRTSPStreamTransport</TITLE>
525 GstRTSPStreamTransport
526 GstRTSPStreamTransportClass
527 gst_rtsp_stream_transport_new
528
529 gst_rtsp_stream_transport_get_stream
530
531 gst_rtsp_stream_transport_get_transport
532 gst_rtsp_stream_transport_set_transport
533
534 GstRTSPSendFunc
535 gst_rtsp_stream_transport_set_callbacks
536
537 GstRTSPKeepAliveFunc
538 gst_rtsp_stream_transport_set_keepalive
539
540 gst_rtsp_stream_transport_set_active
541
542 gst_rtsp_stream_transport_set_timed_out
543 gst_rtsp_stream_transport_is_timed_out
544
545 gst_rtsp_stream_transport_send_rtcp
546 gst_rtsp_stream_transport_send_rtp
547
548 gst_rtsp_stream_transport_keep_alive
549 <SUBSECTION Standard>
550 GST_RTSP_STREAM_TRANSPORT_CAST
551 GST_RTSP_STREAM_TRANSPORT_CLASS_CAST
552 GST_IS_RTSP_STREAM_TRANSPORT
553 GST_IS_RTSP_STREAM_TRANSPORT_CLASS
554 GST_RTSP_STREAM_TRANSPORT
555 GST_RTSP_STREAM_TRANSPORT_CLASS
556 GST_RTSP_STREAM_TRANSPORT_GET_CLASS
557 GST_TYPE_RTSP_STREAM_TRANSPORT
558 GstRTSPStreamTransportPrivate
559 gst_rtsp_stream_transport_get_type
560 </SECTION>
561
562 <SECTION>
563 <FILE>rtsp-thread-pool</FILE>
564 <TITLE>GstRTSPThreadPool</TITLE>
565 GstRTSPThreadType
566 GstRTSPThread
567
568 gst_rtsp_thread_new
569 gst_rtsp_thread_ref
570 gst_rtsp_thread_unref
571 gst_rtsp_thread_reuse
572 gst_rtsp_thread_stop
573
574 GstRTSPThreadPool
575 GstRTSPThreadPoolClass
576 gst_rtsp_thread_pool_new
577
578 gst_rtsp_thread_pool_get_max_threads
579 gst_rtsp_thread_pool_set_max_threads
580
581 gst_rtsp_thread_pool_get_thread
582 <SUBSECTION Standard>
583 GST_RTSP_THREAD_CAST
584 GST_RTSP_THREAD_POOL_CAST
585 GST_RTSP_THREAD_POOL_CLASS_CAST
586 GST_IS_RTSP_THREAD
587 GST_IS_RTSP_THREAD_POOL
588 GST_IS_RTSP_THREAD_POOL_CLASS
589 GST_RTSP_THREAD
590 GST_RTSP_THREAD_POOL
591 GST_RTSP_THREAD_POOL_CLASS
592 GST_RTSP_THREAD_POOL_GET_CLASS
593 GST_TYPE_RTSP_THREAD
594 GST_TYPE_RTSP_THREAD_POOL
595 GstRTSPThreadPoolPrivate
596 gst_rtsp_thread_get_type
597 gst_rtsp_thread_pool_get_type
598 </SECTION>
599
600 <SECTION>
601 <FILE>rtsp-token</FILE>
602 <TITLE>GstRTSPToken</TITLE>
603 GstRTSPToken
604 gst_rtsp_token_new
605 gst_rtsp_token_ref
606 gst_rtsp_token_unref
607 gst_rtsp_token_get_structure
608 gst_rtsp_token_writable_structure
609 gst_rtsp_token_get_string
610 <SUBSECTION Standard>
611 GST_RTSP_TOKEN_CAST
612 GST_IS_RTSP_TOKEN
613 GST_RTSP_TOKEN
614 GST_TYPE_RTSP_TOKEN
615 gst_rtsp_token_get_type
616 </SECTION>
617