tizen 2.3.1 release
[external/gupnp.git] / doc / gupnp-sections.txt
1 <SECTION>
2 <FILE>gupnp-control-point</FILE>
3 <TITLE>GUPnPControlPoint</TITLE>
4 GUPnPControlPoint
5 gupnp_control_point_new
6 gupnp_control_point_new_full
7 gupnp_control_point_get_resource_factory
8 gupnp_control_point_get_context
9 gupnp_control_point_list_device_proxies
10 gupnp_control_point_list_service_proxies
11 <SUBSECTION Standard>
12 GUPnPControlPointClass
13 GUPNP_CONTROL_POINT
14 GUPNP_IS_CONTROL_POINT
15 GUPNP_TYPE_CONTROL_POINT
16 gupnp_control_point_get_type
17 GUPNP_CONTROL_POINT_CLASS
18 GUPNP_IS_CONTROL_POINT_CLASS
19 GUPNP_CONTROL_POINT_GET_CLASS
20 <SUBSECTION Private>
21 GUPnPControlPointPrivate
22 </SECTION>
23
24 <SECTION>
25 <FILE>gupnp-device-info</FILE>
26 <TITLE>GUPnPDeviceInfo</TITLE>
27 GUPnPDeviceInfo
28 gupnp_device_info_get_resource_factory
29 gupnp_device_info_get_context
30 gupnp_device_info_get_location
31 gupnp_device_info_get_url_base
32 gupnp_device_info_get_udn
33 gupnp_device_info_get_device_type
34 gupnp_device_info_get_friendly_name
35 gupnp_device_info_get_manufacturer
36 gupnp_device_info_get_manufacturer_url
37 gupnp_device_info_get_model_description
38 gupnp_device_info_get_model_name
39 gupnp_device_info_get_model_number
40 gupnp_device_info_get_model_url
41 gupnp_device_info_get_serial_number
42 gupnp_device_info_get_presentation_url
43 gupnp_device_info_get_upc
44 gupnp_device_info_get_icon_url
45 gupnp_device_info_list_dlna_capabilities
46 gupnp_device_info_get_description_value
47 gupnp_device_info_list_devices
48 gupnp_device_info_list_device_types
49 gupnp_device_info_get_device
50 gupnp_device_info_list_services
51 gupnp_device_info_list_service_types
52 gupnp_device_info_get_service
53 <SUBSECTION Standard>
54 GUPnPDeviceInfoClass
55 GUPNP_DEVICE_INFO
56 GUPNP_IS_DEVICE_INFO
57 GUPNP_TYPE_DEVICE_INFO
58 gupnp_device_info_get_type
59 GUPNP_DEVICE_INFO_CLASS
60 GUPNP_IS_DEVICE_INFO_CLASS
61 GUPNP_DEVICE_INFO_GET_CLASS
62 <SUBSECTION Private>
63 GUPnPDeviceInfoPrivate
64 </SECTION>
65
66 <SECTION>
67 <FILE>gupnp-service-proxy</FILE>
68 <TITLE>GUPnPServiceProxy</TITLE>
69 GUPnPServiceProxy
70 GUPnPServiceProxyAction
71 GUPnPServiceProxyActionCallback
72 GUPnPServiceProxyNotifyCallback
73 gupnp_service_proxy_send_action
74 gupnp_service_proxy_send_action_valist
75 gupnp_service_proxy_send_action_hash
76 gupnp_service_proxy_send_action_list
77 gupnp_service_proxy_begin_action
78 gupnp_service_proxy_begin_action_valist
79 gupnp_service_proxy_begin_action_hash
80 gupnp_service_proxy_begin_action_list
81 gupnp_service_proxy_end_action
82 gupnp_service_proxy_end_action_valist
83 gupnp_service_proxy_end_action_hash
84 gupnp_service_proxy_end_action_list
85 gupnp_service_proxy_cancel_action
86 gupnp_service_proxy_add_notify
87 gupnp_service_proxy_remove_notify
88 gupnp_service_proxy_set_subscribed
89 gupnp_service_proxy_get_subscribed
90 <SUBSECTION Standard>
91 GUPnPServiceProxyClass
92 GUPNP_SERVICE_PROXY
93 GUPNP_IS_SERVICE_PROXY
94 GUPNP_TYPE_SERVICE_PROXY
95 gupnp_service_proxy_get_type
96 GUPNP_SERVICE_PROXY_CLASS
97 GUPNP_IS_SERVICE_PROXY_CLASS
98 GUPNP_SERVICE_PROXY_GET_CLASS
99 <SUBSECTION Private>
100 GUPnPServiceProxyPrivate
101 </SECTION>
102
103 <SECTION>
104 <FILE>gupnp-service</FILE>
105 <TITLE>GUPnPService</TITLE>
106 GUPnPService
107 GUPnPServiceAction
108 gupnp_service_action_get_name
109 gupnp_service_action_get_locales
110 gupnp_service_action_get
111 gupnp_service_action_get_valist
112 gupnp_service_action_get_value
113 gupnp_service_action_get_gvalue
114 gupnp_service_action_get_values
115 gupnp_service_action_set
116 gupnp_service_action_set_valist
117 gupnp_service_action_set_value
118 gupnp_service_action_set_values
119 gupnp_service_action_return
120 gupnp_service_action_return_error
121 gupnp_service_action_get_message
122 gupnp_service_notify
123 gupnp_service_notify_valist
124 gupnp_service_notify_value
125 gupnp_service_freeze_notify
126 gupnp_service_thaw_notify
127 gupnp_service_signals_autoconnect
128 <SUBSECTION Standard>
129 GUPnPServiceClass
130 GUPNP_SERVICE
131 GUPNP_IS_SERVICE
132 GUPNP_TYPE_SERVICE
133 gupnp_service_get_type
134 GUPNP_SERVICE_CLASS
135 GUPNP_IS_SERVICE_CLASS
136 GUPNP_SERVICE_GET_CLASS
137 GUPNP_TYPE_SERVICE_ACTION
138 <SUBSECTION Private>
139 GUPnPServicePrivate
140 </SECTION>
141
142 <SECTION>
143 <FILE>gupnp-root-device</FILE>
144 <TITLE>GUPnPRootDevice</TITLE>
145 GUPnPRootDevice
146 gupnp_root_device_new
147 gupnp_root_device_new_full
148 gupnp_root_device_set_available
149 gupnp_root_device_get_available
150 gupnp_root_device_get_relative_location
151 gupnp_root_device_get_description_dir
152 gupnp_root_device_get_description_path
153 <SUBSECTION Standard>
154 GUPnPRootDeviceClass
155 GUPNP_ROOT_DEVICE
156 GUPNP_IS_ROOT_DEVICE
157 GUPNP_TYPE_ROOT_DEVICE
158 gupnp_root_device_get_type
159 GUPNP_ROOT_DEVICE_CLASS
160 GUPNP_IS_ROOT_DEVICE_CLASS
161 GUPNP_ROOT_DEVICE_GET_CLASS
162 <SUBSECTION Private>
163 GUPnPRootDevicePrivate
164 </SECTION>
165
166 <SECTION>
167 <FILE>gupnp-context</FILE>
168 <TITLE>GUPnPContext</TITLE>
169 GUPnPContext
170 gupnp_context_new
171 gupnp_context_get_host_ip
172 gupnp_context_get_port
173 gupnp_context_get_server
174 gupnp_context_get_session
175 gupnp_context_set_subscription_timeout
176 gupnp_context_get_subscription_timeout
177 gupnp_context_host_path
178 gupnp_context_host_path_for_agent
179 gupnp_context_unhost_path
180 <SUBSECTION Standard>
181 GUPnPContextClass
182 GUPNP_CONTEXT
183 GUPNP_IS_CONTEXT
184 GUPNP_TYPE_CONTEXT
185 gupnp_context_get_type
186 GUPNP_CONTEXT_CLASS
187 GUPNP_IS_CONTEXT_CLASS
188 GUPNP_CONTEXT_GET_CLASS
189 <SUBSECTION Private>
190 GUPnPContextPrivate
191 </SECTION>
192
193 <SECTION>
194 <FILE>gupnp-context-manager</FILE>
195 <TITLE>GUPnPContextManager</TITLE>
196 GUPnPContextManager
197 gupnp_context_manager_new
198 gupnp_context_manager_manage_control_point
199 gupnp_context_manager_manage_root_device
200 <SUBSECTION Standard>
201 GUPnPContextManagerClass
202 GUPNP_CONTEXT_MANAGER
203 GUPNP_IS_CONTEXT_MANAGER
204 GUPNP_TYPE_CONTEXT_MANAGER
205 gupnp_context_manager_get_type
206 GUPNP_CONTEXT_MANAGER_CLASS
207 GUPNP_IS_CONTEXT_MANAGER_CLASS
208 GUPNP_CONTEXT_MANAGER_GET_CLASS
209 <SUBSECTION Private>
210 GUPnPContextManagerPrivate
211 </SECTION>
212
213 <SECTION>
214 <FILE>gupnp-device</FILE>
215 <TITLE>GUPnPDevice</TITLE>
216 GUPnPDevice
217 <SUBSECTION Standard>
218 GUPnPDeviceClass
219 GUPNP_DEVICE
220 GUPNP_IS_DEVICE
221 GUPNP_TYPE_DEVICE
222 gupnp_device_get_type
223 GUPNP_DEVICE_CLASS
224 GUPNP_IS_DEVICE_CLASS
225 GUPNP_DEVICE_GET_CLASS
226 <SUBSECTION Private>
227 GUPnPDevicePrivate
228 </SECTION>
229
230 <SECTION>
231 <FILE>gupnp-service-introspection</FILE>
232 GUPnPServiceActionArgDirection
233 GUPnPServiceActionArgInfo
234 GUPnPServiceActionInfo
235 GUPnPServiceStateVariableInfo
236 <TITLE>GUPnPServiceIntrospection</TITLE>
237 GUPnPServiceIntrospection
238 gupnp_service_introspection_list_action_names
239 gupnp_service_introspection_list_actions
240 gupnp_service_introspection_get_action
241 gupnp_service_introspection_list_state_variable_names
242 gupnp_service_introspection_list_state_variables
243 gupnp_service_introspection_get_state_variable
244 <SUBSECTION Standard>
245 GUPnPServiceIntrospectionClass
246 GUPNP_SERVICE_INTROSPECTION
247 GUPNP_IS_SERVICE_INTROSPECTION
248 GUPNP_TYPE_SERVICE_INTROSPECTION
249 gupnp_service_introspection_get_type
250 GUPNP_SERVICE_INTROSPECTION_CLASS
251 GUPNP_IS_SERVICE_INTROSPECTION_CLASS
252 GUPNP_SERVICE_INTROSPECTION_GET_CLASS
253 </SECTION>
254
255 <SECTION>
256 <FILE>gupnp-service-info</FILE>
257 <TITLE>GUPnPServiceInfo</TITLE>
258 GUPnPServiceInfo
259 GUPnPServiceIntrospectionCallback
260 gupnp_service_info_get_context
261 gupnp_service_info_get_location
262 gupnp_service_info_get_url_base
263 gupnp_service_info_get_udn
264 gupnp_service_info_get_service_type
265 gupnp_service_info_get_id
266 gupnp_service_info_get_scpd_url
267 gupnp_service_info_get_control_url
268 gupnp_service_info_get_event_subscription_url
269 gupnp_service_info_get_introspection
270 gupnp_service_info_get_introspection_async
271 <SUBSECTION Standard>
272 GUPnPServiceInfoClass
273 GUPNP_SERVICE_INFO
274 GUPNP_IS_SERVICE_INFO
275 GUPNP_TYPE_SERVICE_INFO
276 gupnp_service_info_get_type
277 GUPNP_SERVICE_INFO_CLASS
278 GUPNP_IS_SERVICE_INFO_CLASS
279 GUPNP_SERVICE_INFO_GET_CLASS
280 <SUBSECTION Private>
281 GUPnPServiceInfoPrivate
282 </SECTION>
283
284 <SECTION>
285 <FILE>gupnp-device-proxy</FILE>
286 <TITLE>GUPnPDeviceProxy</TITLE>
287 GUPnPDeviceProxy
288 <SUBSECTION Standard>
289 GUPnPDeviceProxyClass
290 GUPNP_DEVICE_PROXY
291 GUPNP_IS_DEVICE_PROXY
292 GUPNP_TYPE_DEVICE_PROXY
293 gupnp_device_proxy_get_type
294 GUPNP_DEVICE_PROXY_CLASS
295 GUPNP_IS_DEVICE_PROXY_CLASS
296 GUPNP_DEVICE_PROXY_GET_CLASS
297 <SUBSECTION Private>
298 GUPnPDeviceProxyPrivate
299 </SECTION>
300
301 <SECTION>
302 <FILE>gupnp-resource-factory</FILE>
303 <TITLE>GUPnPResourceFactory</TITLE>
304 GUPnPResourceFactory
305 gupnp_resource_factory_new
306 gupnp_resource_factory_get_default
307 gupnp_resource_factory_register_resource_type
308 gupnp_resource_factory_unregister_resource_type
309 gupnp_resource_factory_register_resource_proxy_type
310 gupnp_resource_factory_unregister_resource_proxy_type
311 <SUBSECTION Standard>
312 GUPnPResourceFactoryClass
313 GUPNP_RESOURCE_FACTORY
314 GUPNP_IS_RESOURCE_FACTORY
315 GUPNP_TYPE_RESOURCE_FACTORY
316 gupnp_resource_factory_get_type
317 GUPNP_RESOURCE_FACTORY_CLASS
318 GUPNP_IS_RESOURCE_FACTORY_CLASS
319 GUPNP_RESOURCE_FACTORY_GET_CLASS
320 <SUBSECTION Private>
321 GUPnPResourceFactoryPrivate
322 </SECTION>
323
324 <SECTION>
325 <FILE>gupnp-xml-doc</FILE>
326 <TITLE>GUPnPXMLDoc</TITLE>
327 GUPnPXMLDoc
328 gupnp_xml_doc_new
329 gupnp_xml_doc_new_from_path
330 <SUBSECTION Standard>
331 GUPnPXMLDocClass
332 GUPNP_XML_DOC
333 GUPNP_IS_XML_DOC
334 GUPNP_TYPE_XML_DOC
335 gupnp_xml_doc_get_type
336 GUPNP_XML_DOC_CLASS
337 GUPNP_IS_XML_DOC_CLASS
338 GUPNP_XML_DOC_GET_CLASS
339 </SECTION>
340
341 <SECTION>
342 <FILE>gupnp-types</FILE>
343 <TITLE>Special UPnP types</TITLE>
344 GUPNP_TYPE_BIN_BASE64
345 GUPNP_TYPE_BIN_HEX
346 GUPNP_TYPE_DATE
347 GUPNP_TYPE_DATE_TIME
348 GUPNP_TYPE_DATE_TIME_TZ
349 GUPNP_TYPE_TIME
350 GUPNP_TYPE_TIME_TZ
351 GUPNP_TYPE_URI
352 GUPNP_TYPE_UUID
353 <SUBSECTION Private>
354 gupnp_bin_base64_get_type
355 gupnp_bin_hex_get_type
356 gupnp_date_get_type
357 gupnp_date_time_get_type
358 gupnp_date_time_tz_get_type
359 gupnp_time_get_type
360 gupnp_time_tz_get_type
361 gupnp_uri_get_type
362 gupnp_uuid_get_type
363 gupnp_value_get_string
364 gupnp_value_get_xml_node
365 </SECTION>
366
367 <SECTION>
368 <FILE>gupnp-error</FILE>
369 <TITLE>Error codes</TITLE>
370 GUPNP_SERVER_ERROR
371 GUPnPServerError
372 GUPNP_EVENTING_ERROR
373 GUPnPEventingError
374 GUPNP_CONTROL_ERROR
375 GUPnPControlError
376 GUPNP_XML_ERROR
377 GUPnPXMLError
378 <SUBSECTION Private>
379 gupnp_server_error_quark
380 gupnp_eventing_error_quark
381 gupnp_control_error_quark
382 gupnp_xml_error_quark
383 </SECTION>