diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 83 | ||||
-rw-r--r-- | doc/Makefile.in | 743 | ||||
-rw-r--r-- | doc/gupnp-dlna-docs.sgml | 68 | ||||
-rw-r--r-- | doc/gupnp-dlna-overrides.txt | 0 | ||||
-rw-r--r-- | doc/gupnp-dlna-sections.txt | 75 | ||||
-rw-r--r-- | doc/gupnp-dlna.types | 3 | ||||
-rw-r--r-- | doc/html/GUPnPDLNADiscoverer.html | 394 | ||||
-rw-r--r-- | doc/html/GUPnPDLNAInformation.html | 190 | ||||
-rw-r--r-- | doc/html/GUPnPDLNAProfile.html | 209 | ||||
-rw-r--r-- | doc/html/annotation-glossary.html | 47 | ||||
-rw-r--r-- | doc/html/ch01.html | 51 | ||||
-rw-r--r-- | doc/html/gupnp-dlna.devhelp2 | 45 | ||||
-rw-r--r-- | doc/html/home.png | bin | 0 -> 578 bytes | |||
-rw-r--r-- | doc/html/index.html | 69 | ||||
-rw-r--r-- | doc/html/index.sgml | 57 | ||||
-rw-r--r-- | doc/html/left.png | bin | 0 -> 373 bytes | |||
-rw-r--r-- | doc/html/right.png | bin | 0 -> 380 bytes | |||
-rw-r--r-- | doc/html/style.css | 266 | ||||
-rw-r--r-- | doc/html/up.png | bin | 0 -> 291 bytes | |||
-rw-r--r-- | doc/version.xml | 1 | ||||
-rw-r--r-- | doc/version.xml.in | 1 |
21 files changed, 2302 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..5601294 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,83 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=gupnp-dlna + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../libgupnp-dlna + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS=--type-init-func="gst_init(NULL,NULL)" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--deprecated-guards="GUPNP_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libgupnp-dlna/*.h +CFILE_GLOB=$(top_srcdir)/libgupnp-dlna/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= xml-util.h \ + gvalue-util.h \ + profile-loading.h \ + gupnp-dlna-marshal.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files=version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES=-I$(top_srcdir) \ + $(GST_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libgupnp-dlna/libgupnp-dlna-1.0.la \ + $(GST_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..06a5602 --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,743 @@ +# Makefile.in generated by automake 1.11.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/version.xml.in $(top_srcdir)/gtk-doc.make +subdir = doc +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = version.xml +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GREP = @GREP@ +GST_CFLAGS = @GST_CFLAGS@ +GST_LIBS = @GST_LIBS@ +GST_MAJORMINOR = @GST_MAJORMINOR@ +GST_PBU_CFLAGS = @GST_PBU_CFLAGS@ +GST_PBU_LIBS = @GST_PBU_LIBS@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GUPNP_DLNA_VERSION_INFO = @GUPNP_DLNA_VERSION_INFO@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIBXML_CFLAGS = @LIBXML_CFLAGS@ +LIBXML_LIBS = @LIBXML_LIBS@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE = gupnp-dlna + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR = ../libgupnp-dlna + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = --type-init-func="gst_init(NULL,NULL)" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS = --deprecated-guards="GUPNP_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS = --sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS = + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS = + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB = $(top_srcdir)/libgupnp-dlna/*.h +CFILE_GLOB = $(top_srcdir)/libgupnp-dlna/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES = xml-util.h \ + gvalue-util.h \ + profile-loading.h \ + gupnp-dlna-marshal.h + + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files = version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files = + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES = -I$(top_srcdir) \ + $(GST_CFLAGS) + +GTKDOC_LIBS = $(top_builddir)/libgupnp-dlna/libgupnp-dlna-1.0.la \ + $(GST_LIBS) + +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in +DOC_STAMPS = setup-build.stamp scan-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + sgml.stamp html.stamp pdf.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; +$(top_srcdir)/gtk-doc.make: + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +version.xml: $(top_builddir)/config.status $(srcdir)/version.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: install-am install-strip + +.PHONY: all all-am all-local check check-am clean clean-generic \ + clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +#### setup #### + +setup-build.stamp: + -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + echo ' DOC Preparing build'; \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + done; \ + fi; \ + fi + @touch setup-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo ' DOC Scanning header files' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + echo " DOC Introspecting gobjects"; \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + @touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +#### xml #### + +sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) + @echo ' DOC Building XML' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) + @touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building HTML' + @rm -rf html + @mkdir html + @mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + @echo ' DOC Fixing cross-references' + @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + @touch html-build.stamp + +#### pdf #### + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building PDF' + @rm -f $(DOC_MODULE).pdf + @mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + @touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + fi + +maintainer-clean-local: clean + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 'Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo ' $(INSTALL_DATA) '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + fi; \ + $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ + fi + +uninstall-local: + @if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + @mkdir $(distdir)/html + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/gupnp-dlna-docs.sgml b/doc/gupnp-dlna-docs.sgml new file mode 100644 index 0000000..8465da4 --- /dev/null +++ b/doc/gupnp-dlna-docs.sgml @@ -0,0 +1,68 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>GUPnP DLNA Reference Manual</title> + + <releaseinfo>Version &version;</releaseinfo> + + <copyright> + <year>2010</year> + <holder>Arun Raghavan <arun.raghavan@collabora.co.uk></holder> + </copyright> + <copyright> + <year>2010</year> + <holder>Collabora Multimedia</holder> + </copyright> + <copyright> + <year>2010</year> + <holder>Nokia Corporation</holder> + </copyright> + + <legalnotice> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the <citetitle>GNU Free + Documentation License</citetitle>, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the <citetitle>GNU Free + Documentation License</citetitle> from the Free Software + Foundation by visiting <ulink type="http" + url="http://www.fsf.org">their Web site</ulink> or by writing + to: + + <address> + The Free Software Foundation, Inc., + <street>59 Temple Place</street> - Suite 330, + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, + <country>USA</country> + </address> + </para> + </legalnotice> + </bookinfo> + + <chapter> + <title>GUPnP DLNA</title> + + <para> + GUPnP DLNA is a set of utility APIs to simplify DLNA-specific bits of + MediaServer implementations, such as DLNA media profile guessing. + </para> + + <para> + Before using the GUPnP DLNA API, you must initialise GStreamer by calling + gst_init() or gst_init_check(). + </para> + + <xi:include href="xml/gupnp-dlna-discoverer.xml"/> + <xi:include href="xml/gupnp-dlna-information.xml"/> + <xi:include href="xml/gupnp-dlna-profile.xml"/> + + </chapter> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/doc/gupnp-dlna-overrides.txt b/doc/gupnp-dlna-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/doc/gupnp-dlna-overrides.txt diff --git a/doc/gupnp-dlna-sections.txt b/doc/gupnp-dlna-sections.txt new file mode 100644 index 0000000..6a4594b --- /dev/null +++ b/doc/gupnp-dlna-sections.txt @@ -0,0 +1,75 @@ +<SECTION> +<FILE>gupnp-dlna-profile</FILE> +<TITLE>GUPnPDLNAProfile</TITLE> +GUPnPDLNAProfile +GUPnPDLNAProfileClass +gupnp_dlna_profile_new +gupnp_dlna_profile_get_name +gupnp_dlna_profile_get_mime +gupnp_dlna_profile_get_encoding_profile +<SUBSECTION Standard> +GUPNP_DLNA_PROFILE +GUPNP_IS_DLNA_PROFILE +GUPNP_TYPE_DLNA_PROFILE +gupnp_dlna_profile_get_type +GUPNP_DLNA_PROFILE_CLASS +GUPNP_IS_DLNA_PROFILE_CLASS +GUPNP_DLNA_PROFILE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gupnp-dlna-discoverer</FILE> +<TITLE>GUPnPDLNADiscoverer</TITLE> +GUPnPDLNADiscoverer +gupnp_dlna_discoverer_new +gupnp_dlna_discoverer_start +gupnp_dlna_discoverer_stop +gupnp_dlna_discoverer_discover_uri +gupnp_dlna_discoverer_discover_uri_sync +gupnp_dlna_discoverer_get_profile +gupnp_dlna_discoverer_list_profiles +gupnp_dlna_discoverer_get_relaxed_mode +gupnp_dlna_discoverer_get_extended_mode +<SUBSECTION Standard> +GUPnPDLNADiscovererClass +GUPNP_DLNA_DISCOVERER +GUPNP_IS_DLNA_DISCOVERER +GUPNP_TYPE_DLNA_DISCOVERER +gupnp_dlna_discoverer_get_type +GUPNP_DLNA_DISCOVERER_CLASS +GUPNP_IS_DLNA_DISCOVERER_CLASS +GUPNP_DLNA_DISCOVERER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gupnp-dlna-information</FILE> +<TITLE>GUPnPDLNAInformation</TITLE> +GUPnPDLNAInformation +gupnp_dlna_information_new +gupnp_dlna_information_get_name +gupnp_dlna_information_get_mime +gupnp_dlna_information_get_info +<SUBSECTION Standard> +GUPnPDLNAInformationClass +GUPNP_DLNA_INFORMATION +GUPNP_IS_DLNA_INFORMATION +GUPNP_TYPE_DLNA_INFORMATION +gupnp_dlna_information_get_type +GUPNP_DLNA_INFORMATION_CLASS +GUPNP_IS_DLNA_INFORMATION_CLASS +GUPNP_DLNA_INFORMATION_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gupnp-dlna-load</FILE> +gupnp_dlna_load_profiles_from_file +gupnp_dlna_load_profiles_from_dir +gupnp_dlna_load_profiles_from_disk +</SECTION> + +<SECTION> +<FILE>gupnp-dlna-marshal</FILE> +gupnp_dlna_marshal_BOOLEAN__STRING_UINT_STRING_POINTER +gupnp_dlna_marshal_VOID__OBJECT_BOXED +</SECTION> + diff --git a/doc/gupnp-dlna.types b/doc/gupnp-dlna.types new file mode 100644 index 0000000..af9469a --- /dev/null +++ b/doc/gupnp-dlna.types @@ -0,0 +1,3 @@ +gupnp_dlna_discoverer_get_type +gupnp_dlna_information_get_type +gupnp_dlna_profile_get_type diff --git a/doc/html/GUPnPDLNADiscoverer.html b/doc/html/GUPnPDLNADiscoverer.html new file mode 100644 index 0000000..90c011c --- /dev/null +++ b/doc/html/GUPnPDLNADiscoverer.html @@ -0,0 +1,394 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GUPnPDLNADiscoverer</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="up" href="ch01.html" title="GUPnP DLNA"> +<link rel="prev" href="ch01.html" title="GUPnP DLNA"> +<link rel="next" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GUPnP DLNA Reference Manual</th> +<td><a accesskey="n" href="GUPnPDLNAInformation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GUPnPDLNADiscoverer.synopsis" class="shortcut">Top</a> + | + <a href="#GUPnPDLNADiscoverer.description" class="shortcut">Description</a> + | + <a href="#GUPnPDLNADiscoverer.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#GUPnPDLNADiscoverer.properties" class="shortcut">Properties</a> + | + <a href="#GUPnPDLNADiscoverer.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GUPnPDLNADiscoverer"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GUPnPDLNADiscoverer.top_of_page"></a>GUPnPDLNADiscoverer</span></h2> +<p>GUPnPDLNADiscoverer — Utility API for discovering DLNA profile/mime type and +other metadata for given media.</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GUPnPDLNADiscoverer.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-struct" title="GUPnPDLNADiscoverer">GUPnPDLNADiscoverer</a>; +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="returnvalue">GUPnPDLNADiscoverer</span></a> * <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-new" title="gupnp_dlna_discoverer_new ()">gupnp_dlna_discoverer_new</a> (<em class="parameter"><code><span class="type">GstClockTime</span> timeout</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> relaxed_mode</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> extended_mode</code></em>); +#define <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-start" title="gupnp_dlna_discoverer_start()">gupnp_dlna_discoverer_start</a> (discoverer) +#define <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-stop" title="gupnp_dlna_discoverer_stop()">gupnp_dlna_discoverer_stop</a> (discoverer) +<span class="returnvalue">gboolean</span> <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri" title="gupnp_dlna_discoverer_discover_uri ()">gupnp_dlna_discoverer_discover_uri</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *discoverer</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>); +<a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="returnvalue">GUPnPDLNAInformation</span></a> * <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri-sync" title="gupnp_dlna_discoverer_discover_uri_sync ()">gupnp_dlna_discoverer_discover_uri_sync</a> + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *discoverer</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="returnvalue">GUPnPDLNAProfile</span></a> * <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-profile" title="gupnp_dlna_discoverer_get_profile ()">gupnp_dlna_discoverer_get_profile</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>); +const <span class="returnvalue">GList</span> * <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-list-profiles" title="gupnp_dlna_discoverer_list_profiles ()">gupnp_dlna_discoverer_list_profiles</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-relaxed-mode" title="gupnp_dlna_discoverer_get_relaxed_mode ()">gupnp_dlna_discoverer_get_relaxed_mode</a> + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-extended-mode" title="gupnp_dlna_discoverer_get_extended_mode ()">gupnp_dlna_discoverer_get_extended_mode</a> + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GstDiscoverer + +----GUPnPDLNADiscoverer +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--extended-mode" title='The "extended-mode" property'>extended-mode</a>" <span class="type">gboolean</span> : Read / Write / Construct Only + "<a class="link" href="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--relaxed-mode" title='The "relaxed-mode" property'>relaxed-mode</a>" <span class="type">gboolean</span> : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-done" title='The "done" signal'>done</a>" : <code class="literal">Run Last</code> +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.description"></a><h2>Description</h2> +<p> +The GUPnPDLNADiscoverer object provides a light-weight wrapper over the +<span class="type">GstDiscoverer</span> API. The latter provides a simple interface to discover +media metadata given a URI. GUPnPDLNADiscoverer extends this API to also +provide a DLNA profile name and mime type for the media. +</p> +<p> +The API provided corresponds very closely to the API provided by +<span class="type">GstDiscoverer</span> - both synchronous and asynchronous discovery of metadata +are possible. +</p> +<p> +The asynchronous mode requires a running <span class="type">GMainLoop</span> in the default +<span class="type">GMainContext</span>, where one connects to the various signals, appends the +URIs to be processed and then asks for the discovery to begin. +</p> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNADiscoverer-struct"></a><h3>GUPnPDLNADiscoverer</h3> +<pre class="programlisting">typedef struct _GUPnPDLNADiscoverer GUPnPDLNADiscoverer;</pre> +<p> +The top-level object used to for metadata extraction. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-new"></a><h3>gupnp_dlna_discoverer_new ()</h3> +<pre class="programlisting"><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="returnvalue">GUPnPDLNADiscoverer</span></a> * gupnp_dlna_discoverer_new (<em class="parameter"><code><span class="type">GstClockTime</span> timeout</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> relaxed_mode</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> extended_mode</code></em>);</pre> +<p> +Creates a new <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object with the given default timeout +value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td> +<td>default discovery timeout, in nanoseconds</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>relaxed_mode</code></em> :</span></p></td> +<td>set to TRUE, to enable relaxed mode support. FALSE otherwise</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>extended_mode</code></em> :</span></p></td> +<td>set to TRUE, to enable extended mode support. FALSE otherwise</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>A new <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-start"></a><h3>gupnp_dlna_discoverer_start()</h3> +<pre class="programlisting">#define gupnp_dlna_discoverer_start(discoverer)</pre> +<p> +Allows asynchronous discovery of URIs to begin. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>discoverer</code></em> :</span></p></td> +<td> +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object to start discovery on</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-stop"></a><h3>gupnp_dlna_discoverer_stop()</h3> +<pre class="programlisting">#define gupnp_dlna_discoverer_stop(discoverer)</pre> +<p> +Stops asynchronous discovery of URIs. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>discoverer</code></em> :</span></p></td> +<td> +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object to stop discovery on</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-discover-uri"></a><h3>gupnp_dlna_discoverer_discover_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> gupnp_dlna_discoverer_discover_uri (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *discoverer</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>);</pre> +<p> +Queues <em class="parameter"><code>uri</code></em> for metadata discovery. When discovery is completed, the +"discovered" signal is emitted on <em class="parameter"><code>discoverer</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>discoverer</code></em> :</span></p></td> +<td> +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object to use for discovery</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> +<td>URI to gather metadata for</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if <em class="parameter"><code>uri</code></em> was successfully queued, FALSE otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-discover-uri-sync"></a><h3>gupnp_dlna_discoverer_discover_uri_sync ()</h3> +<pre class="programlisting"><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="returnvalue">GUPnPDLNAInformation</span></a> * gupnp_dlna_discoverer_discover_uri_sync + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *discoverer</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Synchronously gathers metadata for <em class="parameter"><code>uri</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>discoverer</code></em> :</span></p></td> +<td> +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object to use for discovery</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> +<td>URI to gather metadata for</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>contains details of the error if discovery fails, else is NULL</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> with the metadata for <em class="parameter"><code>uri</code></em> +on success, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-get-profile"></a><h3>gupnp_dlna_discoverer_get_profile ()</h3> +<pre class="programlisting"><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="returnvalue">GUPnPDLNAProfile</span></a> * gupnp_dlna_discoverer_get_profile (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p> +Given <em class="parameter"><code>name</code></em>, this finds the corresponding DLNA profile information (stored +as a <a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a>). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>The name of the DLNA profile to be retrieved</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> on success, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-list-profiles"></a><h3>gupnp_dlna_discoverer_list_profiles ()</h3> +<pre class="programlisting">const <span class="returnvalue">GList</span> * gupnp_dlna_discoverer_list_profiles (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>);</pre> +<p> +Retuns a list of the all the DLNA profiles supported by <em class="parameter"><code>self</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> whose profile list is required</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <span class="type">GList</span> of +<a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> on success, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GUPnPDLNAProfile*]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-get-relaxed-mode"></a><h3>gupnp_dlna_discoverer_get_relaxed_mode ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> gupnp_dlna_discoverer_get_relaxed_mode + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>true if relaxed mode is set and false otherwise</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-discoverer-get-extended-mode"></a><h3>gupnp_dlna_discoverer_get_extended_mode ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> gupnp_dlna_discoverer_get_extended_mode + (<em class="parameter"><code><a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>true if application is using extended mode and false otherwise</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNADiscoverer--extended-mode"></a><h3>The <code class="literal">"extended-mode"</code> property</h3> +<pre class="programlisting"> "extended-mode" <span class="type">gboolean</span> : Read / Write / Construct Only</pre> +<p>Indicates support for profiles that are not part of the DLNA specification.</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNADiscoverer--relaxed-mode"></a><h3>The <code class="literal">"relaxed-mode"</code> property</h3> +<pre class="programlisting"> "relaxed-mode" <span class="type">gboolean</span> : Read / Write / Construct Only</pre> +<p>Indicates that profile matching shouldbe strictly compliant with the DLNA specification.</p> +<p>Default value: FALSE</p> +</div> +</div> +<div class="refsect1"> +<a name="GUPnPDLNADiscoverer.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNADiscoverer-done"></a><h3>The <code class="literal">"done"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> *discoverer, + <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *dlna, + <span class="type">GError</span> *err, + <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre> +<p> +Will be emitted when all information on a URI could be discovered. +</p> +<p> +The reciever must unref <em class="parameter"><code>dlna</code></em> with when done using it. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>discoverer</code></em> :</span></p></td> +<td>the <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dlna</code></em> :</span></p></td> +<td>the results as <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>contains details of the error if discovery fails, else is NULL</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/GUPnPDLNAInformation.html b/doc/html/GUPnPDLNAInformation.html new file mode 100644 index 0000000..44c0604 --- /dev/null +++ b/doc/html/GUPnPDLNAInformation.html @@ -0,0 +1,190 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GUPnPDLNAInformation</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="up" href="ch01.html" title="GUPnP DLNA"> +<link rel="prev" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"> +<link rel="next" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GUPnPDLNADiscoverer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GUPnP DLNA Reference Manual</th> +<td><a accesskey="n" href="GUPnPDLNAProfile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GUPnPDLNAInformation.synopsis" class="shortcut">Top</a> + | + <a href="#GUPnPDLNAInformation.description" class="shortcut">Description</a> + | + <a href="#GUPnPDLNAInformation.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#GUPnPDLNAInformation.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GUPnPDLNAInformation"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GUPnPDLNAInformation.top_of_page"></a>GUPnPDLNAInformation</span></h2> +<p>GUPnPDLNAInformation — Object containing metadata information returned by the +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> API</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GUPnPDLNAInformation.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="GUPnPDLNAInformation.html#GUPnPDLNAInformation-struct" title="GUPnPDLNAInformation">GUPnPDLNAInformation</a>; +<a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="returnvalue">GUPnPDLNAInformation</span></a> * <a class="link" href="GUPnPDLNAInformation.html#gupnp-dlna-information-new" title="gupnp_dlna_information_new ()">gupnp_dlna_information_new</a> (<em class="parameter"><code><span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> *mime</code></em>, + <em class="parameter"><code><span class="type">GstDiscovererInfo</span> *info</code></em>); +const <span class="returnvalue">gchar</span> * <a class="link" href="GUPnPDLNAInformation.html#gupnp-dlna-information-get-name" title="gupnp_dlna_information_get_name ()">gupnp_dlna_information_get_name</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>); +const <span class="returnvalue">gchar</span> * <a class="link" href="GUPnPDLNAInformation.html#gupnp-dlna-information-get-mime" title="gupnp_dlna_information_get_mime ()">gupnp_dlna_information_get_mime</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>); +const <span class="returnvalue">GstDiscovererInfo</span> * <a class="link" href="GUPnPDLNAInformation.html#gupnp-dlna-information-get-info" title="gupnp_dlna_information_get_info ()">gupnp_dlna_information_get_info</a> + (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAInformation.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GUPnPDLNAInformation +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAInformation.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GUPnPDLNAInformation.html#GUPnPDLNAInformation--info" title='The "info" property'>info</a>" <span class="type">GstDiscovererInfo</span>* : Read / Write / Construct Only + "<a class="link" href="GUPnPDLNAInformation.html#GUPnPDLNAInformation--mime" title='The "mime" property'>mime</a>" <span class="type">gchar</span>* : Read / Write / Construct Only + "<a class="link" href="GUPnPDLNAInformation.html#GUPnPDLNAInformation--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAInformation.description"></a><h2>Description</h2> +<p> +The GUPnPDLNAInformation object holds metadata information discovered by the +GUPnPDiscoverer API. The DLNA profile name and MIME type have their own +fields, and other metadata is held in a GstDiscovererInfo structure. +All fields are read-only. +</p> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAInformation.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNAInformation-struct"></a><h3>GUPnPDLNAInformation</h3> +<pre class="programlisting">typedef struct _GUPnPDLNAInformation GUPnPDLNAInformation;</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-information-new"></a><h3>gupnp_dlna_information_new ()</h3> +<pre class="programlisting"><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="returnvalue">GUPnPDLNAInformation</span></a> * gupnp_dlna_information_new (<em class="parameter"><code><span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> *mime</code></em>, + <em class="parameter"><code><span class="type">GstDiscovererInfo</span> *info</code></em>);</pre> +<p> +Creates a new <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> object with the given properties. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>DLNA media profile name corresponding to the media</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime</code></em> :</span></p></td> +<td>DLNA MIME type for the media</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td> +<td> +<span class="type">GstDiscovererInfo</span> type with additional metadata about the +stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>A newly created <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-information-get-name"></a><h3>gupnp_dlna_information_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * gupnp_dlna_information_get_name (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the DLNA profile name of the stream represented by <em class="parameter"><code>self</code></em>. Do not +free this string.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-information-get-mime"></a><h3>gupnp_dlna_information_get_mime ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * gupnp_dlna_information_get_mime (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the DLNA MIME type of the stream represented by <em class="parameter"><code>self</code></em>. Do not +free this string.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-information-get-info"></a><h3>gupnp_dlna_information_get_info ()</h3> +<pre class="programlisting">const <span class="returnvalue">GstDiscovererInfo</span> * gupnp_dlna_information_get_info + (<em class="parameter"><code><a class="link" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"><span class="type">GUPnPDLNAInformation</span></a> *self</code></em>);</pre> +</div> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAInformation.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNAInformation--info"></a><h3>The <code class="literal">"info"</code> property</h3> +<pre class="programlisting"> "info" <span class="type">GstDiscovererInfo</span>* : Read / Write / Construct Only</pre> +<p>Metadata of the stream in a GstDiscovererInfo structure.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAInformation--mime"></a><h3>The <code class="literal">"mime"</code> property</h3> +<pre class="programlisting"> "mime" <span class="type">gchar</span>* : Read / Write / Construct Only</pre> +<p>The DLNA MIME type of the stream.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAInformation--name"></a><h3>The <code class="literal">"name"</code> property</h3> +<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre> +<p>The name of the DLNA profile corresponding to the strream.</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/GUPnPDLNAProfile.html b/doc/html/GUPnPDLNAProfile.html new file mode 100644 index 0000000..f5bdafa --- /dev/null +++ b/doc/html/GUPnPDLNAProfile.html @@ -0,0 +1,209 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GUPnPDLNAProfile</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="up" href="ch01.html" title="GUPnP DLNA"> +<link rel="prev" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GUPnPDLNAInformation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GUPnP DLNA Reference Manual</th> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GUPnPDLNAProfile.synopsis" class="shortcut">Top</a> + | + <a href="#GUPnPDLNAProfile.description" class="shortcut">Description</a> + | + <a href="#GUPnPDLNAProfile.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#GUPnPDLNAProfile.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GUPnPDLNAProfile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GUPnPDLNAProfile.top_of_page"></a>GUPnPDLNAProfile</span></h2> +<p>GUPnPDLNAProfile — Object representing a DLNA profile</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GUPnPDLNAProfile.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfile-struct" title="GUPnPDLNAProfile">GUPnPDLNAProfile</a>; + <a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfileClass" title="GUPnPDLNAProfileClass">GUPnPDLNAProfileClass</a>; +<a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="returnvalue">GUPnPDLNAProfile</span></a> * <a class="link" href="GUPnPDLNAProfile.html#gupnp-dlna-profile-new" title="gupnp_dlna_profile_new ()">gupnp_dlna_profile_new</a> (<em class="parameter"><code><span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> *mime</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *container_caps</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *video_caps</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *audio_caps</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> extended</code></em>); +const <span class="returnvalue">gchar</span> * <a class="link" href="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-name" title="gupnp_dlna_profile_get_name ()">gupnp_dlna_profile_get_name</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>); +const <span class="returnvalue">gchar</span> * <a class="link" href="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-mime" title="gupnp_dlna_profile_get_mime ()">gupnp_dlna_profile_get_mime</a> (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>); +<span class="returnvalue">GstEncodingProfile</span> * <a class="link" href="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-encoding-profile" title="gupnp_dlna_profile_get_encoding_profile ()">gupnp_dlna_profile_get_encoding_profile</a> + (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAProfile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GUPnPDLNAProfile +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAProfile.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfile--encoding-profile" title='The "encoding-profile" property'>encoding-profile</a>" <span class="type">GstEncodingProfile</span>* : Read + "<a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfile--extended" title='The "extended" property'>extended</a>" <span class="type">gboolean</span> : Read / Write / Construct Only + "<a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfile--mime" title='The "mime" property'>mime</a>" <span class="type">gchar</span>* : Read / Write / Construct Only + "<a class="link" href="GUPnPDLNAProfile.html#GUPnPDLNAProfile--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only +</pre> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAProfile.description"></a><h2>Description</h2> +<p> +The <a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> object provides a few APIs that return +<a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> objects. These represent a single DLNA profile. Each +<a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> has a name (the name of the DLNA profile), the +corresponding MIME type, and a <span class="type">GstEncodingProfile</span> which represents the +various audio/video/container restrictions specified for that DLNA profile. +</p> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAProfile.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNAProfile-struct"></a><h3>GUPnPDLNAProfile</h3> +<pre class="programlisting">typedef struct _GUPnPDLNAProfile GUPnPDLNAProfile;</pre> +<p> +The top-level object used for the in-memory representation of the DLNA +Profiles. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAProfileClass"></a><h3>GUPnPDLNAProfileClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent_class; +} GUPnPDLNAProfileClass; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-profile-new"></a><h3>gupnp_dlna_profile_new ()</h3> +<pre class="programlisting"><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="returnvalue">GUPnPDLNAProfile</span></a> * gupnp_dlna_profile_new (<em class="parameter"><code><span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> *mime</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *container_caps</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *video_caps</code></em>, + <em class="parameter"><code><span class="type">GstCaps</span> *audio_caps</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> extended</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-profile-get-name"></a><h3>gupnp_dlna_profile_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * gupnp_dlna_profile_get_name (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the name of the DLNA profile represented by <em class="parameter"><code>self</code></em> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-profile-get-mime"></a><h3>gupnp_dlna_profile_get_mime ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * gupnp_dlna_profile_get_mime (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the DLNA MIME type of the DLNA profile represented by <em class="parameter"><code>self</code></em> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="gupnp-dlna-profile-get-encoding-profile"></a><h3>gupnp_dlna_profile_get_encoding_profile ()</h3> +<pre class="programlisting"><span class="returnvalue">GstEncodingProfile</span> * gupnp_dlna_profile_get_encoding_profile + (<em class="parameter"><code><a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> *self</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"><span class="type">GUPnPDLNAProfile</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <span class="type">GstEncodingProfile</span> object that, in a future +version, can be used to transcode a given stream to match the DLNA +profile represented by <em class="parameter"><code>self</code></em>. +The receiver must unref the returned <span class="type">GstEncodingProfile</span> when done +using it. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GUPnPDLNAProfile.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GUPnPDLNAProfile--encoding-profile"></a><h3>The <code class="literal">"encoding-profile"</code> property</h3> +<pre class="programlisting"> "encoding-profile" <span class="type">GstEncodingProfile</span>* : Read</pre> +<p>GstEncodingProfile objectcorresponding to the DLNA profile.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAProfile--extended"></a><h3>The <code class="literal">"extended"</code> property</h3> +<pre class="programlisting"> "extended" <span class="type">gboolean</span> : Read / Write / Construct Only</pre> +<p>Indicates that this profile is not part of the DLNA specification.</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAProfile--mime"></a><h3>The <code class="literal">"mime"</code> property</h3> +<pre class="programlisting"> "mime" <span class="type">gchar</span>* : Read / Write / Construct Only</pre> +<p>The MIME type of the DLNA profile.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="GUPnPDLNAProfile--name"></a><h3>The <code class="literal">"name"</code> property</h3> +<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre> +<p>The name of the DLNA profile .</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/annotation-glossary.html b/doc/html/annotation-glossary.html new file mode 100644 index 0000000..b007c66 --- /dev/null +++ b/doc/html/annotation-glossary.html @@ -0,0 +1,47 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="up" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="prev" href="GUPnPDLNAProfile.html" title="GUPnPDLNAProfile"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GUPnPDLNAProfile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GUPnP DLNA Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a class="shortcut" href="#glsE">E</a> + | + <a class="shortcut" href="#glsT">T</a> +</td></tr> +</table> +<div class="glossary"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h2></div></div></div> +<a name="glsE"></a><h3 class="title">E</h3> +<dt> +<a name="annotation-glossterm-element-type"></a>element-type</dt> +<dd><p>Generics and defining elements of containers and arrays.</p></dd> +<a name="glsT"></a><h3 class="title">T</h3> +<dt> +<a name="annotation-glossterm-transfer%20full"></a>transfer full</dt> +<dd><p>Free data after the code is done.</p></dd> +<dt> +<a name="annotation-glossterm-transfer%20none"></a>transfer none</dt> +<dd><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/ch01.html b/doc/html/ch01.html new file mode 100644 index 0000000..07403b1 --- /dev/null +++ b/doc/html/ch01.html @@ -0,0 +1,51 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GUPnP DLNA</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="up" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="prev" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="next" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GUPnP DLNA Reference Manual</th> +<td><a accesskey="n" href="GUPnPDLNADiscoverer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp2511320"></a>GUPnP DLNA</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNADiscoverer.html">GUPnPDLNADiscoverer</a></span><span class="refpurpose"> — Utility API for discovering DLNA profile/mime type and +other metadata for given media.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNAInformation.html">GUPnPDLNAInformation</a></span><span class="refpurpose"> — Object containing metadata information returned by the +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> API</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNAProfile.html">GUPnPDLNAProfile</a></span><span class="refpurpose"> — Object representing a DLNA profile</span> +</dt> +</dl></div> +<p> + GUPnP DLNA is a set of utility APIs to simplify DLNA-specific bits of + MediaServer implementations, such as DLNA media profile guessing. + </p> +<p> + Before using the GUPnP DLNA API, you must initialise GStreamer by calling + gst_init() or gst_init_check(). + </p> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/gupnp-dlna.devhelp2 b/doc/html/gupnp-dlna.devhelp2 new file mode 100644 index 0000000..8c92e1c --- /dev/null +++ b/doc/html/gupnp-dlna.devhelp2 @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="GUPnP DLNA Reference Manual" link="index.html" author="" name="gupnp-dlna" version="2" language="c"> + <chapters> + <sub name="GUPnP DLNA" link="ch01.html"> + <sub name="GUPnPDLNADiscoverer" link="GUPnPDLNADiscoverer.html"/> + <sub name="GUPnPDLNAInformation" link="GUPnPDLNAInformation.html"/> + <sub name="GUPnPDLNAProfile" link="GUPnPDLNAProfile.html"/> + </sub> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> + </chapters> + <functions> + <keyword type="struct" name="GUPnPDLNADiscoverer" link="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-struct"/> + <keyword type="function" name="gupnp_dlna_discoverer_new ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-new"/> + <keyword type="macro" name="gupnp_dlna_discoverer_start()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-start"/> + <keyword type="macro" name="gupnp_dlna_discoverer_stop()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-stop"/> + <keyword type="function" name="gupnp_dlna_discoverer_discover_uri ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri"/> + <keyword type="function" name="gupnp_dlna_discoverer_discover_uri_sync ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri-sync"/> + <keyword type="function" name="gupnp_dlna_discoverer_get_profile ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-profile"/> + <keyword type="function" name="gupnp_dlna_discoverer_list_profiles ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-list-profiles"/> + <keyword type="function" name="gupnp_dlna_discoverer_get_relaxed_mode ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-relaxed-mode"/> + <keyword type="function" name="gupnp_dlna_discoverer_get_extended_mode ()" link="GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-extended-mode"/> + <keyword type="property" name="The "extended-mode" property" link="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--extended-mode"/> + <keyword type="property" name="The "relaxed-mode" property" link="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--relaxed-mode"/> + <keyword type="signal" name="The "done" signal" link="GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-done"/> + <keyword type="struct" name="GUPnPDLNAInformation" link="GUPnPDLNAInformation.html#GUPnPDLNAInformation-struct"/> + <keyword type="function" name="gupnp_dlna_information_new ()" link="GUPnPDLNAInformation.html#gupnp-dlna-information-new"/> + <keyword type="function" name="gupnp_dlna_information_get_name ()" link="GUPnPDLNAInformation.html#gupnp-dlna-information-get-name"/> + <keyword type="function" name="gupnp_dlna_information_get_mime ()" link="GUPnPDLNAInformation.html#gupnp-dlna-information-get-mime"/> + <keyword type="function" name="gupnp_dlna_information_get_info ()" link="GUPnPDLNAInformation.html#gupnp-dlna-information-get-info"/> + <keyword type="property" name="The "info" property" link="GUPnPDLNAInformation.html#GUPnPDLNAInformation--info"/> + <keyword type="property" name="The "mime" property" link="GUPnPDLNAInformation.html#GUPnPDLNAInformation--mime"/> + <keyword type="property" name="The "name" property" link="GUPnPDLNAInformation.html#GUPnPDLNAInformation--name"/> + <keyword type="struct" name="GUPnPDLNAProfile" link="GUPnPDLNAProfile.html#GUPnPDLNAProfile-struct"/> + <keyword type="struct" name="GUPnPDLNAProfileClass" link="GUPnPDLNAProfile.html#GUPnPDLNAProfileClass"/> + <keyword type="function" name="gupnp_dlna_profile_new ()" link="GUPnPDLNAProfile.html#gupnp-dlna-profile-new"/> + <keyword type="function" name="gupnp_dlna_profile_get_name ()" link="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-name"/> + <keyword type="function" name="gupnp_dlna_profile_get_mime ()" link="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-mime"/> + <keyword type="function" name="gupnp_dlna_profile_get_encoding_profile ()" link="GUPnPDLNAProfile.html#gupnp-dlna-profile-get-encoding-profile"/> + <keyword type="property" name="The "encoding-profile" property" link="GUPnPDLNAProfile.html#GUPnPDLNAProfile--encoding-profile"/> + <keyword type="property" name="The "extended" property" link="GUPnPDLNAProfile.html#GUPnPDLNAProfile--extended"/> + <keyword type="property" name="The "mime" property" link="GUPnPDLNAProfile.html#GUPnPDLNAProfile--mime"/> + <keyword type="property" name="The "name" property" link="GUPnPDLNAProfile.html#GUPnPDLNAProfile--name"/> + </functions> +</book> diff --git a/doc/html/home.png b/doc/html/home.png Binary files differnew file mode 100644 index 0000000..fb60b55 --- /dev/null +++ b/doc/html/home.png diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 0000000..0ccfadc --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,69 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GUPnP DLNA Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GUPnP DLNA Reference Manual"> +<link rel="next" href="ch01.html" title="GUPnP DLNA"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GUPnP DLNA Reference Manual</p></th></tr></table></div> +<div><p class="releaseinfo">Version 0.6.6 +</p></div> +<div><p class="copyright">Copyright © 2010 Arun Raghavan <arun.raghavan@collabora.co.uk></p></div> +<div><p class="copyright">Copyright © 2010 Collabora Multimedia</p></div> +<div><p class="copyright">Copyright © 2010 Nokia Corporation</p></div> +<div><div class="legalnotice"> +<a name="idp208704"></a><p> + Permission is granted to copy, distribute and/or modify this + document under the terms of the <em class="citetitle">GNU Free + Documentation License</em>, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the <em class="citetitle">GNU Free + Documentation License</em> from the Free Software + Foundation by visiting <a class="ulink" href="http://www.fsf.org" target="_top">their Web site</a> or by writing + to: + + </p> +<div class="address"><p><br> + The Free Software Foundation, Inc.,<br> + <span class="street">59 Temple Place</span> - Suite 330,<br> + <span class="city">Boston</span>, <span class="state">MA</span> <span class="postcode">02111-1307</span>,<br> + <span class="country">USA</span><br> + </p></div> +<p> + </p> +</div></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="ch01.html">GUPnP DLNA</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNADiscoverer.html">GUPnPDLNADiscoverer</a></span><span class="refpurpose"> — Utility API for discovering DLNA profile/mime type and +other metadata for given media.</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNAInformation.html">GUPnPDLNAInformation</a></span><span class="refpurpose"> — Object containing metadata information returned by the +<a class="link" href="GUPnPDLNADiscoverer.html" title="GUPnPDLNADiscoverer"><span class="type">GUPnPDLNADiscoverer</span></a> API</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GUPnPDLNAProfile.html">GUPnPDLNAProfile</a></span><span class="refpurpose"> — Object representing a DLNA profile</span> +</dt> +</dl></dd> +<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/doc/html/index.sgml b/doc/html/index.sgml new file mode 100644 index 0000000..57d06fb --- /dev/null +++ b/doc/html/index.sgml @@ -0,0 +1,57 @@ +<ANCHOR id="GUPnPDLNADiscoverer" href="gupnp-dlna/GUPnPDLNADiscoverer.html"> +<ANCHOR id="GUPnPDLNADiscoverer.synopsis" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.synopsis"> +<ANCHOR id="GUPnPDLNADiscoverer.object-hierarchy" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.object-hierarchy"> +<ANCHOR id="GUPnPDLNADiscoverer.properties" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.properties"> +<ANCHOR id="GUPnPDLNADiscoverer.signals" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.signals"> +<ANCHOR id="GUPnPDLNADiscoverer.description" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.description"> +<ANCHOR id="GUPnPDLNADiscoverer.details" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.details"> +<ANCHOR id="GUPnPDLNADiscoverer-struct" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-struct"> +<ANCHOR id="gupnp-dlna-discoverer-new" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-new"> +<ANCHOR id="gupnp-dlna-discoverer-start" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-start"> +<ANCHOR id="gupnp-dlna-discoverer-stop" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-stop"> +<ANCHOR id="gupnp-dlna-discoverer-discover-uri" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri"> +<ANCHOR id="gupnp-dlna-discoverer-discover-uri-sync" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-discover-uri-sync"> +<ANCHOR id="gupnp-dlna-discoverer-get-profile" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-profile"> +<ANCHOR id="gupnp-dlna-discoverer-list-profiles" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-list-profiles"> +<ANCHOR id="gupnp-dlna-discoverer-get-relaxed-mode" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-relaxed-mode"> +<ANCHOR id="gupnp-dlna-discoverer-get-extended-mode" href="gupnp-dlna/GUPnPDLNADiscoverer.html#gupnp-dlna-discoverer-get-extended-mode"> +<ANCHOR id="GUPnPDLNADiscoverer.property-details" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.property-details"> +<ANCHOR id="GUPnPDLNADiscoverer--extended-mode" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--extended-mode"> +<ANCHOR id="GUPnPDLNADiscoverer--relaxed-mode" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer--relaxed-mode"> +<ANCHOR id="GUPnPDLNADiscoverer.signal-details" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer.signal-details"> +<ANCHOR id="GUPnPDLNADiscoverer-done" href="gupnp-dlna/GUPnPDLNADiscoverer.html#GUPnPDLNADiscoverer-done"> +<ANCHOR id="GUPnPDLNAInformation" href="gupnp-dlna/GUPnPDLNAInformation.html"> +<ANCHOR id="GUPnPDLNAInformation.synopsis" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.synopsis"> +<ANCHOR id="GUPnPDLNAInformation.object-hierarchy" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.object-hierarchy"> +<ANCHOR id="GUPnPDLNAInformation.properties" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.properties"> +<ANCHOR id="GUPnPDLNAInformation.description" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.description"> +<ANCHOR id="GUPnPDLNAInformation.details" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.details"> +<ANCHOR id="GUPnPDLNAInformation-struct" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation-struct"> +<ANCHOR id="gupnp-dlna-information-new" href="gupnp-dlna/GUPnPDLNAInformation.html#gupnp-dlna-information-new"> +<ANCHOR id="gupnp-dlna-information-get-name" href="gupnp-dlna/GUPnPDLNAInformation.html#gupnp-dlna-information-get-name"> +<ANCHOR id="gupnp-dlna-information-get-mime" href="gupnp-dlna/GUPnPDLNAInformation.html#gupnp-dlna-information-get-mime"> +<ANCHOR id="gupnp-dlna-information-get-info" href="gupnp-dlna/GUPnPDLNAInformation.html#gupnp-dlna-information-get-info"> +<ANCHOR id="GUPnPDLNAInformation.property-details" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation.property-details"> +<ANCHOR id="GUPnPDLNAInformation--info" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation--info"> +<ANCHOR id="GUPnPDLNAInformation--mime" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation--mime"> +<ANCHOR id="GUPnPDLNAInformation--name" href="gupnp-dlna/GUPnPDLNAInformation.html#GUPnPDLNAInformation--name"> +<ANCHOR id="GUPnPDLNAProfile" href="gupnp-dlna/GUPnPDLNAProfile.html"> +<ANCHOR id="GUPnPDLNAProfile.synopsis" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.synopsis"> +<ANCHOR id="GUPnPDLNAProfile.object-hierarchy" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.object-hierarchy"> +<ANCHOR id="GUPnPDLNAProfile.properties" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.properties"> +<ANCHOR id="GUPnPDLNAProfile.description" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.description"> +<ANCHOR id="GUPnPDLNAProfile.details" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.details"> +<ANCHOR id="GUPnPDLNAProfile-struct" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile-struct"> +<ANCHOR id="GUPnPDLNAProfileClass" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfileClass"> +<ANCHOR id="gupnp-dlna-profile-new" href="gupnp-dlna/GUPnPDLNAProfile.html#gupnp-dlna-profile-new"> +<ANCHOR id="gupnp-dlna-profile-get-name" href="gupnp-dlna/GUPnPDLNAProfile.html#gupnp-dlna-profile-get-name"> +<ANCHOR id="gupnp-dlna-profile-get-mime" href="gupnp-dlna/GUPnPDLNAProfile.html#gupnp-dlna-profile-get-mime"> +<ANCHOR id="gupnp-dlna-profile-get-encoding-profile" href="gupnp-dlna/GUPnPDLNAProfile.html#gupnp-dlna-profile-get-encoding-profile"> +<ANCHOR id="GUPnPDLNAProfile.property-details" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile.property-details"> +<ANCHOR id="GUPnPDLNAProfile--encoding-profile" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile--encoding-profile"> +<ANCHOR id="GUPnPDLNAProfile--extended" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile--extended"> +<ANCHOR id="GUPnPDLNAProfile--mime" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile--mime"> +<ANCHOR id="GUPnPDLNAProfile--name" href="gupnp-dlna/GUPnPDLNAProfile.html#GUPnPDLNAProfile--name"> +<ANCHOR id="annotation-glossterm-element-type" href="gupnp-dlna/annotation-glossary.html#annotation-glossterm-element-type"> +<ANCHOR id="annotation-glossterm-transfer full" href="gupnp-dlna/annotation-glossary.html#annotation-glossterm-transfer full"> +<ANCHOR id="annotation-glossterm-transfer none" href="gupnp-dlna/annotation-glossary.html#annotation-glossterm-transfer none"> diff --git a/doc/html/left.png b/doc/html/left.png Binary files differnew file mode 100644 index 0000000..48cab27 --- /dev/null +++ b/doc/html/left.png diff --git a/doc/html/right.png b/doc/html/right.png Binary files differnew file mode 100644 index 0000000..ed55207 --- /dev/null +++ b/doc/html/right.png diff --git a/doc/html/style.css b/doc/html/style.css new file mode 100644 index 0000000..d6f6c26 --- /dev/null +++ b/doc/html/style.css @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/doc/html/up.png b/doc/html/up.png Binary files differnew file mode 100644 index 0000000..8eb591f --- /dev/null +++ b/doc/html/up.png diff --git a/doc/version.xml b/doc/version.xml new file mode 100644 index 0000000..05e8a45 --- /dev/null +++ b/doc/version.xml @@ -0,0 +1 @@ +0.6.6 diff --git a/doc/version.xml.in b/doc/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/doc/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |