:orphan: .. index:: pair: group; Test API to operate the DLNA UPnP Device information .. _doxid-group__tapi__upnp__device__info: Test API to operate the DLNA UPnP Device information ==================================================== .. toctree:: :hidden: struct_tapi_upnp_device_info.rst Overview ~~~~~~~~ Definition of Test API for DLNA UPnP Device features. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_upnp_device_info` :ref:`tapi_upnp_device_info`; typedef struct tapi_upnp_devices :target:`tapi_upnp_devices`; // structs struct :ref:`tapi_upnp_device_info`; // global functions :ref:`SLIST_HEAD`(tapi_upnp_devices, :ref:`tapi_upnp_device_info`); const char* :ref:`tapi_upnp_get_device_property`(const :ref:`tapi_upnp_device_info`* device, :ref:`te_upnp_device_property_idx` property_idx); static const char* :ref:`tapi_upnp_get_device_udn`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_type`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_location`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_friendly_name`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_manufacturer`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_manufacturer_url`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_model_description`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_model_name`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_model_number`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_model_url`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_serial_number`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_upc`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_icon_url`(const :ref:`tapi_upnp_device_info`* device); static const char* :ref:`tapi_upnp_get_device_presentation_url`(const :ref:`tapi_upnp_device_info`* device); :ref:`te_errno` :ref:`tapi_upnp_get_device_info`(:ref:`rcf_rpc_server`* rpcs, const char* name, tapi_upnp_devices* devices); void :ref:`tapi_upnp_free_device_info`(tapi_upnp_devices* devices); void :ref:`tapi_upnp_print_device_info`(const tapi_upnp_devices* devices); .. _details-group__tapi__upnp__device__info: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of Test API for DLNA UPnP Device features. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_upnp_device_info .. _doxid-group__tapi__upnp__device__info_1ga63f2c632054ca2e54a07fb83f874bf41: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_device_info` tapi_upnp_device_info A UPnP device parameters. Global Functions ---------------- .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__upnp__device__info_1gacae5459a9484dee9d632e80055596ce1: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_upnp_devices, :ref:`tapi_upnp_device_info`) Head of the UPnP devices list. .. index:: pair: function; tapi_upnp_get_device_property .. _doxid-group__tapi__upnp__device__info_1ga49a98195a9834fd9dc96f0b0f5f42b5f: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_upnp_get_device_property(const :ref:`tapi_upnp_device_info`* device, :ref:`te_upnp_device_property_idx` property_idx) Get a device property string value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. * - property_idx - Index of certain property in properties array. .. rubric:: Returns: The string property value or ``NULL`` if the property is not found. .. index:: pair: function; tapi_upnp_get_device_udn .. _doxid-group__tapi__upnp__device__info_1ga0a03aa389319890f131f64bcd99201c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_udn(const :ref:`tapi_upnp_device_info`* device) Get Unique Device Name from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The Unique Device Name or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_type .. _doxid-group__tapi__upnp__device__info_1gaab7048ed402671d231175e15e2106948: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_type(const :ref:`tapi_upnp_device_info`* device) Get Device Type from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The Device Type or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_location .. _doxid-group__tapi__upnp__device__info_1ga4a4cad8f0130a5a3aa370833821066cf: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_location(const :ref:`tapi_upnp_device_info`* device) Get Device Location from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The Device Location or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_friendly_name .. _doxid-group__tapi__upnp__device__info_1ga53025c95b133e6aa47ae67fb1b57fba0: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_friendly_name(const :ref:`tapi_upnp_device_info`* device) Get Device Friendly Name from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The friendly name of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_manufacturer .. _doxid-group__tapi__upnp__device__info_1ga42fbf01ba39652d1c897384d3bac565d: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_manufacturer(const :ref:`tapi_upnp_device_info`* device) Get Device Manufacturer from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The manufacturer of the or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_manufacturer_url .. _doxid-group__tapi__upnp__device__info_1ga3ab0e827f907b9005c58fc68d1692833: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_manufacturer_url(const :ref:`tapi_upnp_device_info`* device) Get Device Manufacturer URL from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The manufacturer URL of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_model_description .. _doxid-group__tapi__upnp__device__info_1gac46cd78b4f998c7b7cf53ad5c4195b96: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_model_description(const :ref:`tapi_upnp_device_info`* device) Get Device Model Description from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The model description of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_model_name .. _doxid-group__tapi__upnp__device__info_1ga62bdeea0445671112bf5cc90b7a4f5ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_model_name(const :ref:`tapi_upnp_device_info`* device) Get Device Model Name from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The model name of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_model_number .. _doxid-group__tapi__upnp__device__info_1ga803f8a2d260293117b8d9cdf79127335: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_model_number(const :ref:`tapi_upnp_device_info`* device) Get Device Model Number from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The model number of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_model_url .. _doxid-group__tapi__upnp__device__info_1ga84ad4444d5e0f77ff95402494bdefc25: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_model_url(const :ref:`tapi_upnp_device_info`* device) Get Device Model URL from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The model URL of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_serial_number .. _doxid-group__tapi__upnp__device__info_1ga9b6e6f82e28d785d7156a0603b5409a9: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_serial_number(const :ref:`tapi_upnp_device_info`* device) Get Device Serial Number from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The serial number of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_upc .. _doxid-group__tapi__upnp__device__info_1gabf94c6369f352752b6cbbf1ea87739ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_upc(const :ref:`tapi_upnp_device_info`* device) Get Device Universal Product Code from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The Universal Product Code of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_icon_url .. _doxid-group__tapi__upnp__device__info_1ga17ae6e65ddf68bdc775b98320f0dd28f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_icon_url(const :ref:`tapi_upnp_device_info`* device) Get Device Icon URL from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The icon URL of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_presentation_url .. _doxid-group__tapi__upnp__device__info_1ga82f3dfcd68ffe7bad105689497c79b47: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_device_presentation_url(const :ref:`tapi_upnp_device_info`* device) Get Device Presentation URL from the UPnP device properties. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - device - Device. .. rubric:: Returns: The presentation URL of the device or ``NULL`` in case of missing property. .. index:: pair: function; tapi_upnp_get_device_info .. _doxid-group__tapi__upnp__device__info_1gaa73bd051c6610936f6239b4b8f107acf: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_upnp_get_device_info(:ref:`rcf_rpc_server`* rpcs, const char* name, tapi_upnp_devices* devices) Retrieve an information about the UPnP device. Note, ``devices`` should be freed with **tapi_upnp_free_device_info** when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle. * - name - Device name. Can be ``NULL`` or zero-length string to get the all found devices. * - devices - Devices context list. .. rubric:: Returns: Status code. On success, ``0``. .. rubric:: See also: :ref:`tapi_upnp_free_device_info ` .. index:: pair: function; tapi_upnp_free_device_info .. _doxid-group__tapi__upnp__device__info_1gafd19a0614f0acac2b6fe6abf56d8e2fa: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_upnp_free_device_info(tapi_upnp_devices* devices) Empty the list of UPnP devices (free allocated memory) which was obtained with **tapi_upnp_get_device_info**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - devices - List of devices. .. rubric:: See also: :ref:`tapi_upnp_get_device_info ` .. index:: pair: function; tapi_upnp_print_device_info .. _doxid-group__tapi__upnp__device__info_1gab81e2b38d831bfabd1c39f825910003b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_upnp_print_device_info(const tapi_upnp_devices* devices) Print UPnP devices context using RING function. This function should be used for debugging purpose. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - devices - Devices context list.