:orphan:

.. index:: pair: group; Test API to operate the DLNA UPnP Content Directory Resources
.. _doxid-group__tapi__upnp__cd__resources:

Test API to operate the DLNA UPnP Content Directory Resources
=============================================================

.. toctree::
	:hidden:

	struct_tapi_upnp_resources_uri_node.rst

Overview
~~~~~~~~

Definition of Test API for DLNA UPnP Content Directory Resources features. :ref:`More...<details-group__tapi__upnp__cd__resources>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef struct :ref:`tapi_upnp_resources_uri_node<doxid-structtapi__upnp__resources__uri__node>` :ref:`tapi_upnp_resources_uri_node<doxid-group__tapi__upnp__cd__resources_1gafcda44a7d6999e6b72bc7fd782010f25>`;
	typedef struct tapi_upnp_media_uri :target:`tapi_upnp_media_uri<doxid-group__tapi__upnp__cd__resources_1ga793e98b693328fef88f7d351afb4fbab>`;

	// structs

	struct :ref:`tapi_upnp_resources_uri_node<doxid-structtapi__upnp__resources__uri__node>`;

	// global functions

	:ref:`SLIST_HEAD<doxid-group__tapi__upnp__cd__resources_1gab038466b943b1255a72430b63341ef9c>`(tapi_upnp_media_uri, :ref:`tapi_upnp_resources_uri_node<doxid-structtapi__upnp__resources__uri__node>`);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_upnp_resources_get_media_uri<doxid-group__tapi__upnp__cd__resources_1gaaf98c7166e1a1372e29a337b6aa4008e>`(:ref:`tapi_upnp_cd_container_node<doxid-structtapi__upnp__cd__container__node>`* container, :ref:`tapi_upnp_cd_resource_type<doxid-group__tapi__upnp__cd__service_1gad159354ec834e2d41afb4557b3cf7738>` type, tapi_upnp_media_uri* media);
	void :ref:`tapi_upnp_resources_free_media_uri<doxid-group__tapi__upnp__cd__resources_1ga88683d83222fbfb1294bc80598b67357>`(tapi_upnp_media_uri* media);
	void :ref:`tapi_upnp_print_resource_info<doxid-group__tapi__upnp__cd__resources_1gaf7fea2768da81ac1ca7f186b54ac7380>`(const :ref:`tapi_upnp_cd_resource<doxid-structtapi__upnp__cd__resource>`* res);

.. _details-group__tapi__upnp__cd__resources:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Definition of Test API for DLNA UPnP Content Directory Resources features.

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_upnp_resources_uri_node
.. _doxid-group__tapi__upnp__cd__resources_1gafcda44a7d6999e6b72bc7fd782010f25:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`tapi_upnp_resources_uri_node<doxid-structtapi__upnp__resources__uri__node>` tapi_upnp_resources_uri_node

UPnP media resources URL.

Global Functions
----------------

.. index:: pair: function; SLIST_HEAD
.. _doxid-group__tapi__upnp__cd__resources_1gab038466b943b1255a72430b63341ef9c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	SLIST_HEAD(tapi_upnp_media_uri, :ref:`tapi_upnp_resources_uri_node<doxid-structtapi__upnp__resources__uri__node>`)

Head of the UPnP media resources list.

.. index:: pair: function; tapi_upnp_resources_get_media_uri
.. _doxid-group__tapi__upnp__cd__resources_1gaaf98c7166e1a1372e29a337b6aa4008e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_upnp_resources_get_media_uri(:ref:`tapi_upnp_cd_container_node<doxid-structtapi__upnp__cd__container__node>`* container, :ref:`tapi_upnp_cd_resource_type<doxid-group__tapi__upnp__cd__service_1gad159354ec834e2d41afb4557b3cf7738>` type, tapi_upnp_media_uri* media)

Get URLs of existed media resources, which satisfy to particular resource type. Note, ``media`` should be freed with **tapi_upnp_resources_free_media_uri** when it is no longer needed.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- container

		- Subtree of containers.

	*
		- type

		- Resource type of media to find.

	*
		- media

		- Media URLs list to collect obtained data.



.. rubric:: Returns:

Status code. On success, ``0``.



.. rubric:: See also:

:ref:`tapi_upnp_resources_free_media_uri <doxid-group__tapi__upnp__cd__resources_1ga88683d83222fbfb1294bc80598b67357>`

.. index:: pair: function; tapi_upnp_resources_free_media_uri
.. _doxid-group__tapi__upnp__cd__resources_1ga88683d83222fbfb1294bc80598b67357:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_upnp_resources_free_media_uri(tapi_upnp_media_uri* media)

Empty the list of media URLs (free allocated memory) which was obtained with **tapi_upnp_resources_get_media_uri**.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- media

		- Media URLs list.



.. rubric:: See also:

:ref:`tapi_upnp_resources_get_media_uri <doxid-group__tapi__upnp__cd__resources_1gaaf98c7166e1a1372e29a337b6aa4008e>`

.. index:: pair: function; tapi_upnp_print_resource_info
.. _doxid-group__tapi__upnp__cd__resources_1gaf7fea2768da81ac1ca7f186b54ac7380:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_upnp_print_resource_info(const :ref:`tapi_upnp_cd_resource<doxid-structtapi__upnp__cd__resource>`* res)

Print UPnP Content Directory object resource context using RING function. This function should be used for debugging purpose.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- res

		- Content Directory object resource.