gupnp-device-info.xml

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

<indexterm zone="gupnp-device-info-get-friendly-name"><primary>gupnp_device_info_get_friendly_name</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_friendly_name (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the friendly 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-manufacturer" role="function">
<title>gupnp_device_info_get_manufacturer ()</title>
<indexterm zone="gupnp-device-info-get-manufacturer"><primary>gupnp_device_info_get_manufacturer</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_manufacturer  (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the manufacturer 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-manufacturer-url" role="function">
<title>gupnp_device_info_get_manufacturer_url ()</title>
<indexterm zone="gupnp-device-info-get-manufacturer-url"><primary>gupnp_device_info_get_manufacturer_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_manufacturer_url
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a URL pointing to the manufacturer's website.</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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-model-description" role="function">
<title>gupnp_device_info_get_model_description ()</title>
<indexterm zone="gupnp-device-info-get-model-description"><primary>gupnp_device_info_get_model_description</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_model_description
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the description of the device model.</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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-model-name" role="function">
<title>gupnp_device_info_get_model_name ()</title>
<indexterm zone="gupnp-device-info-get-model-name"><primary>gupnp_device_info_get_model_name</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_model_name    (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the model 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-model-number" role="function">
<title>gupnp_device_info_get_model_number ()</title>
<indexterm zone="gupnp-device-info-get-model-number"><primary>gupnp_device_info_get_model_number</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_model_number  (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the model number 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-model-url" role="function">
<title>gupnp_device_info_get_model_url ()</title>
<indexterm zone="gupnp-device-info-get-model-url"><primary>gupnp_device_info_get_model_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_model_url     (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a URL pointing to the device model's website.</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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-serial-number" role="function">
<title>gupnp_device_info_get_serial_number ()</title>
<indexterm zone="gupnp-device-info-get-serial-number"><primary>gupnp_device_info_get_serial_number</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_serial_number (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the serial number 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-presentation-url" role="function">
<title>gupnp_device_info_get_presentation_url ()</title>
<indexterm zone="gupnp-device-info-get-presentation-url"><primary>gupnp_device_info_get_presentation_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_presentation_url
                                                        (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get a URL pointing to the device's presentation page, for web-based
administration.</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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-upc" role="function">
<title>gupnp_device_info_get_upc ()</title>
<indexterm zone="gupnp-device-info-get-upc"><primary>gupnp_device_info_get_upc</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_upc           (<link linkend="GUPnPDeviceInfo">GUPnPDeviceInfo</link> *info);</programlisting>
<para>
Get the Universal Product Code 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 string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-get-icon-url" role="function">
<title>gupnp_device_info_get_icon_url ()</title>
<indexterm zone="gupnp-device-info-get-icon-url"><primary>gupnp_device_info_get_icon_url</primary></indexterm><programlisting><link linkend="char">char</link>*               gupnp_device_info_get_icon_url      (<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);</programlisting>
<para>
Get a URL pointing to the icon most closely matching the
given criteria, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If <parameter>requested_mime_type</parameter> is set, only icons with
this mime type will be returned. If <parameter>requested_depth</parameter> is set, only icons with
this or lower depth will be returned. If <parameter>requested_width</parameter> and/or
<parameter>requested_height</parameter> are set, only icons that are this size or smaller are
returned, unless <parameter>prefer_bigger</parameter> is set, in which case the next biggest icon
will be returned. The returned strings should be freed.</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><parameter>requested_mime_type</parameter>&nbsp;:</term>
<listitem><simpara> The requested file format, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for any
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested_depth</parameter>&nbsp;:</term>
<listitem><simpara> The requested color depth, or -1 for any
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested_width</parameter>&nbsp;:</term>
<listitem><simpara> The requested width, or -1 for any
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested_height</parameter>&nbsp;:</term>
<listitem><simpara> The requested height, or -1 for any
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefer_bigger</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a bigger, rather than a smaller icon should be
returned if no exact match could be found
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store the the format of the returned icon,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. The returned string should be freed after use
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store the depth of the returned icon, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store the width of the returned icon, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> The location where to store the height of the returned icon, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.  <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-device-info-list-devices" role="function">