gupnp-device-info.xml

来自「另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协」· XML 代码 · 共 603 行 · 第 1/3 页

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GUPnPDeviceInfo">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPDeviceInfo.top_of_page">GUPnPDeviceInfo</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPDeviceInfo</refname>
<refpurpose>Base abstract class for querying device information.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="GUPnPDeviceInfo.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GUPnPDeviceInfo-struct">GUPnPDeviceInfo</link>;
<link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* <link linkend="gupnp-device-info-get-resource-factory">gupnp_device_info_get_resource_factory</link>
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *device_info);
<link linkend="GUPnPContext">GUPnPContext</link>*       <link linkend="gupnp-device-info-get-context">gupnp_device_info_get_context</link>       (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-device-info-get-location">gupnp_device_info_get_location</link>      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
const <link linkend="SoupURI">SoupURI</link>*      <link linkend="gupnp-device-info-get-url-base">gupnp_device_info_get_url_base</link>      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-device-info-get-udn">gupnp_device_info_get_udn</link>           (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
const <link linkend="char">char</link>*         <link linkend="gupnp-device-info-get-device-type">gupnp_device_info_get_device_type</link>   (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-friendly-name">gupnp_device_info_get_friendly_name</link> (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-manufacturer">gupnp_device_info_get_manufacturer</link>  (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-manufacturer-url">gupnp_device_info_get_manufacturer_url</link>
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-model-description">gupnp_device_info_get_model_description</link>
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-model-name">gupnp_device_info_get_model_name</link>    (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-model-number">gupnp_device_info_get_model_number</link>  (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-model-url">gupnp_device_info_get_model_url</link>     (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-serial-number">gupnp_device_info_get_serial_number</link> (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-presentation-url">gupnp_device_info_get_presentation_url</link>
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-upc">gupnp_device_info_get_upc</link>           (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="char">char</link>*               <link linkend="gupnp-device-info-get-icon-url">gupnp_device_info_get_icon_url</link>      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info,
                                                         const <link linkend="char">char</link> *requested_mime_type,
                                                         <link linkend="int">int</link> requested_depth,
                                                         <link linkend="int">int</link> requested_width,
                                                         <link linkend="int">int</link> requested_height,
                                                         <link linkend="gboolean">gboolean</link> prefer_bigger,
                                                         <link linkend="char">char</link> **mime_type,
                                                         <link linkend="int">int</link> *depth,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);
<link linkend="GList">GList</link>*              <link linkend="gupnp-device-info-list-devices">gupnp_device_info_list_devices</link>      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="GList">GList</link>*              <link linkend="gupnp-device-info-list-device-types">gupnp_device_info_list_device_types</link> (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link>*    <link linkend="gupnp-device-info-get-device">gupnp_device_info_get_device</link>        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info,
                                                         const <link linkend="char">char</link> *type);
<link linkend="GList">GList</link>*              <link linkend="gupnp-device-info-list-services">gupnp_device_info_list_services</link>     (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="GList">GList</link>*              <link linkend="gupnp-device-info-list-service-types">gupnp_device_info_list_service_types</link>
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);
<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link>*   <link linkend="gupnp-device-info-get-service">gupnp_device_info_get_service</link>       (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info,
                                                         const <link linkend="char">char</link> *type);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GUPnPDeviceInfo.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----GUPnPDeviceInfo
         +----<link linkend="GUPnPDevice">GUPnPDevice</link>
         +----<link linkend="GUPnPDeviceProxy">GUPnPDeviceProxy</link>
</synopsis>

</refsect1>





<refsect1 id="GUPnPDeviceInfo.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPDeviceInfo--context">context</link>&quot;                  <link linkend="GUPnPContext">GUPnPContext</link>*         : Read / Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--device-type">device-type</link>&quot;              <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--document">document</link>&quot;                 <link linkend="XmlDocWrapper">XmlDocWrapper</link>*        : Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--element">element</link>&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--location">location</link>&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--resource-factory">resource-factory</link>&quot;         <link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>*  : Read / Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--udn">udn</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPDeviceInfo--url-base">url-base</link>&quot;                 <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GUPnPDeviceInfo.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link> base abstract class provides methods for querying
device information.</para>
<para>

</para>
</refsect1>

<refsect1 id="GUPnPDeviceInfo.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GUPnPDeviceInfo-struct" role="struct">
<title>GUPnPDeviceInfo</title>
<indexterm zone="GUPnPDeviceInfo-struct"><primary>GUPnPDeviceInfo</primary></indexterm><programlisting>typedef struct _GUPnPDeviceInfo GUPnPDeviceInfo;</programlisting>
<para>
This struct contains private data only, and should be accessed using the
functions below.</para>
<para>

</para></refsect2>
<refsect2 id="gupnp-device-info-get-resource-factory" role="function">
<title>gupnp_device_info_get_resource_factory ()</title>
<indexterm zone="gupnp-device-info-get-resource-factory"><primary>gupnp_device_info_get_resource_factory</primary></indexterm><programlisting><link linkend="GUPnPResourceFactory">GUPnPResourceFactory</link>* gupnp_device_info_get_resource_factory
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *device_info);</programlisting>
<para>
Get the <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link> used by the <parameter>device_info</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>device_info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GUPnPResourceFactory"><type>GUPnPResourceFactory</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-context" role="function">
<title>gupnp_device_info_get_context ()</title>
<indexterm zone="gupnp-device-info-get-context"><primary>gupnp_device_info_get_context</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>*       gupnp_device_info_get_context       (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the associated <link linkend="GUPnPContext"><type>GUPnPContext</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-location" role="function">
<title>gupnp_device_info_get_location ()</title>
<indexterm zone="gupnp-device-info-get-location"><primary>gupnp_device_info_get_location</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_device_info_get_location      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the location of the device description file.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-url-base" role="function">
<title>gupnp_device_info_get_url_base ()</title>
<indexterm zone="gupnp-device-info-get-url-base"><primary>gupnp_device_info_get_url_base</primary></indexterm><programlisting>const <link linkend="SoupURI">SoupURI</link>*      gupnp_device_info_get_url_base      (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the URL base of this device.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="SoupURI"><type>SoupURI</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-udn" role="function">
<title>gupnp_device_info_get_udn ()</title>
<indexterm zone="gupnp-device-info-get-udn"><primary>gupnp_device_info_get_udn</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_device_info_get_udn           (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the Unique Device Name of the device.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-device-type" role="function">
<title>gupnp_device_info_get_device_type ()</title>
<indexterm zone="gupnp-device-info-get-device-type"><primary>gupnp_device_info_get_device_type</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_device_info_get_device_type   (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the UPnP device type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPDeviceInfo"><type>GUPnPDeviceInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A constant string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-friendly-name" role="function">
<title>gupnp_device_info_get_friendly_name ()</title>