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