diff options
Diffstat (limited to 'doc/latex/classcUPnPClassVideoBroadcast.tex')
| -rw-r--r-- | doc/latex/classcUPnPClassVideoBroadcast.tex | 308 |
1 files changed, 0 insertions, 308 deletions
diff --git a/doc/latex/classcUPnPClassVideoBroadcast.tex b/doc/latex/classcUPnPClassVideoBroadcast.tex deleted file mode 100644 index 608c360..0000000 --- a/doc/latex/classcUPnPClassVideoBroadcast.tex +++ /dev/null @@ -1,308 +0,0 @@ -\hypertarget{classcUPnPClassVideoBroadcast}{ -\section{cUPnPClassVideoBroadcast Class Reference} -\label{classcUPnPClassVideoBroadcast}\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -} -{\tt \#include $<$object.h$>$} - -Inheritance diagram for cUPnPClassVideoBroadcast:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=400pt]{classcUPnPClassVideoBroadcast__inherit__graph} -\end{center} -\end{figure} -Collaboration diagram for cUPnPClassVideoBroadcast:\nopagebreak -\begin{figure}[H] -\begin{center} -\leavevmode -\includegraphics[height=400pt]{classcUPnPClassVideoBroadcast__coll__graph} -\end{center} -\end{figure} -\subsection*{Public Member Functions} -\begin{CompactItemize} -\item -virtual cStringList $\ast$ \hyperlink{classcUPnPClassVideoBroadcast_192f6a04c87fe8d56f99c71337cf0f68}{getPropertyList} () -\item -virtual bool \hyperlink{classcUPnPClassVideoBroadcast_ce7a341834e448479d3c8f4f0254ce43}{setProperty} (const char $\ast$Property, const char $\ast$Value) -\item -virtual bool \hyperlink{classcUPnPClassVideoBroadcast_e1d13a13de094337cea6be214c4da0f0}{getProperty} (const char $\ast$Property, char $\ast$$\ast$Value) const -\item -int \hyperlink{classcUPnPClassVideoBroadcast_13e432f8a97072f3b45b1d199b82ae02}{setIcon} (const char $\ast$IconURI) -\item -int \hyperlink{classcUPnPClassVideoBroadcast_228fcc06291dc3989917bbfa5ce3153f}{setRegion} (const char $\ast$Region) -\item -int \hyperlink{classcUPnPClassVideoBroadcast_4a7804c6c86531d7e23cbc714daa6077}{setChannelNr} (int ChannelNr) -\item -int \hyperlink{classcUPnPClassVideoBroadcast_b3d1740f8ad67cec1c82c23078b03189}{setChannelName} (const char $\ast$ChannelName) -\item -const char $\ast$ \hyperlink{classcUPnPClassVideoBroadcast_f4c2a9f5d62e41d853385b7b7685d536}{getIcon} () const -\item -const char $\ast$ \hyperlink{classcUPnPClassVideoBroadcast_f4582c82588879c110947fdfc50b7895}{getRegion} () const -\item -int \hyperlink{classcUPnPClassVideoBroadcast_6065509557e13176878098861fcfeb9d}{getChannelNr} () const -\item -const char $\ast$ \hyperlink{classcUPnPClassVideoBroadcast_b63ea63a4ab8ac3cb654b0bab4df620a}{getChannelName} () const -\end{CompactItemize} -\subsection*{Protected Member Functions} -\begin{CompactItemize} -\item -\hyperlink{classcUPnPClassVideoBroadcast_a8d1e73bc9cbb20da6727f3c2e823d79}{cUPnPClassVideoBroadcast} () -\end{CompactItemize} -\subsection*{Protected Attributes} -\begin{CompactItemize} -\item -\hypertarget{classcUPnPClassVideoBroadcast_24aa59d4c90d705f651cddf4ed90ad73}{ -cString \hyperlink{classcUPnPClassVideoBroadcast_24aa59d4c90d705f651cddf4ed90ad73}{mIcon}} -\label{classcUPnPClassVideoBroadcast_24aa59d4c90d705f651cddf4ed90ad73} - -\begin{CompactList}\small\item\em The channel icon of the channel. \item\end{CompactList}\item -\hypertarget{classcUPnPClassVideoBroadcast_9a9420e700fd45afd24beba8ae261909}{ -cString \hyperlink{classcUPnPClassVideoBroadcast_9a9420e700fd45afd24beba8ae261909}{mRegion}} -\label{classcUPnPClassVideoBroadcast_9a9420e700fd45afd24beba8ae261909} - -\begin{CompactList}\small\item\em The region where the channel can be received. \item\end{CompactList}\item -\hypertarget{classcUPnPClassVideoBroadcast_8ad5b61bf9e88e1b30a132ca72b0d905}{ -int \hyperlink{classcUPnPClassVideoBroadcast_8ad5b61bf9e88e1b30a132ca72b0d905}{mChannelNr}} -\label{classcUPnPClassVideoBroadcast_8ad5b61bf9e88e1b30a132ca72b0d905} - -\begin{CompactList}\small\item\em The channel number. \item\end{CompactList}\item -\hypertarget{classcUPnPClassVideoBroadcast_aae072a7d7a21b699561a62700971c26}{ -cString \hyperlink{classcUPnPClassVideoBroadcast_aae072a7d7a21b699561a62700971c26}{mChannelName}} -\label{classcUPnPClassVideoBroadcast_aae072a7d7a21b699561a62700971c26} - -\begin{CompactList}\small\item\em The channel name or provider name. \item\end{CompactList}\end{CompactItemize} -\subsection*{Friends} -\begin{CompactItemize} -\item -\hypertarget{classcUPnPClassVideoBroadcast_3d0d0aedce8b1c661ea360b9a6d616f6}{ -class \hyperlink{classcUPnPClassVideoBroadcast_3d0d0aedce8b1c661ea360b9a6d616f6}{cMediaDatabase}} -\label{classcUPnPClassVideoBroadcast_3d0d0aedce8b1c661ea360b9a6d616f6} - -\item -\hypertarget{classcUPnPClassVideoBroadcast_aefab39434a832c545ac75a79fa81d23}{ -class \hyperlink{classcUPnPClassVideoBroadcast_aefab39434a832c545ac75a79fa81d23}{cUPnPObjectMediator}} -\label{classcUPnPClassVideoBroadcast_aefab39434a832c545ac75a79fa81d23} - -\item -\hypertarget{classcUPnPClassVideoBroadcast_23986410a02651ff37a4699efbb7f209}{ -class \hyperlink{classcUPnPClassVideoBroadcast_23986410a02651ff37a4699efbb7f209}{cUPnPVideoBroadcastMediator}} -\label{classcUPnPClassVideoBroadcast_23986410a02651ff37a4699efbb7f209} - -\end{CompactItemize} - - -\subsection{Detailed Description} -The UPnP class VideoBroadcast - -This is a UPnP class VideoBroadcast representation with all its properties. - -\subsection{Constructor \& Destructor Documentation} -\hypertarget{classcUPnPClassVideoBroadcast_a8d1e73bc9cbb20da6727f3c2e823d79}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{cUPnPClassVideoBroadcast}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPClassVideoBroadcast::cUPnPClassVideoBroadcast ()\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_a8d1e73bc9cbb20da6727f3c2e823d79} - - -Constructor of a video broadcast - -This creates a new instance of a video broadcast - -\subsection{Member Function Documentation} -\hypertarget{classcUPnPClassVideoBroadcast_b63ea63a4ab8ac3cb654b0bab4df620a}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getChannelName@{getChannelName}} -\index{getChannelName@{getChannelName}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getChannelName}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoBroadcast::getChannelName () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_b63ea63a4ab8ac3cb654b0bab4df620a} - - -Get the channel name - -This returns the channel name or provider name respectively - -\begin{Desc} -\item[Returns:]the channel name \end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_6065509557e13176878098861fcfeb9d}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getChannelNr@{getChannelNr}} -\index{getChannelNr@{getChannelNr}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getChannelNr}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoBroadcast::getChannelNr () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_6065509557e13176878098861fcfeb9d} - - -Get the channel number - -This returns the channel number - -\begin{Desc} -\item[Returns:]the channel number \end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_f4c2a9f5d62e41d853385b7b7685d536}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getIcon@{getIcon}} -\index{getIcon@{getIcon}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getIcon}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoBroadcast::getIcon () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_f4c2a9f5d62e41d853385b7b7685d536} - - -Get the channel icon - -This returns the channel icon of the channel. - -\begin{Desc} -\item[Returns:]the channel icon \end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_e1d13a13de094337cea6be214c4da0f0}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getProperty@{getProperty}} -\index{getProperty@{getProperty}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassVideoBroadcast::getProperty (const char $\ast$ {\em Property}, \/ char $\ast$$\ast$ {\em Value}) const\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_e1d13a13de094337cea6be214c4da0f0} - - -Gets a property - -Returns the value of a specified property. The value is converted into a string. - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt true},} if the property exists\item {\bf {\tt false},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Property}]the property which should be returned \item[{\em Value}]the value of that property \end{description} -\end{Desc} - - -Reimplemented from \hyperlink{classcUPnPClassVideoItem_94ab2ffcbe14abb63c680e6748e70ef1}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassVideoBroadcast_192f6a04c87fe8d56f99c71337cf0f68}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getPropertyList@{getPropertyList}} -\index{getPropertyList@{getPropertyList}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getPropertyList}]{\setlength{\rightskip}{0pt plus 5cm}cStringList $\ast$ cUPnPClassVideoBroadcast::getPropertyList ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_192f6a04c87fe8d56f99c71337cf0f68} - - -Get the properties of the object - -This returns a property list with all the properties which can be obtained or set with {\tt getProperty} or {\tt setProperty}. - -\begin{Desc} -\item[Returns:]a stringlist with the properties \end{Desc} - - -Reimplemented from \hyperlink{classcUPnPClassVideoItem_9dc397419b45535a3e6a676667b619a4}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassVideoBroadcast_f4582c82588879c110947fdfc50b7895}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!getRegion@{getRegion}} -\index{getRegion@{getRegion}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{getRegion}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoBroadcast::getRegion () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_f4582c82588879c110947fdfc50b7895} - - -Get the region - -This returns the region, where the channel can be received - -\begin{Desc} -\item[Returns:]the channel region \end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_b3d1740f8ad67cec1c82c23078b03189}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!setChannelName@{setChannelName}} -\index{setChannelName@{setChannelName}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{setChannelName}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoBroadcast::setChannelName (const char $\ast$ {\em ChannelName})}} -\label{classcUPnPClassVideoBroadcast_b3d1740f8ad67cec1c82c23078b03189} - - -Set the channel name - -This sets the channel name or the provider of the channel. - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em ChannelName}]the channel name \end{description} -\end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_4a7804c6c86531d7e23cbc714daa6077}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!setChannelNr@{setChannelNr}} -\index{setChannelNr@{setChannelNr}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{setChannelNr}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoBroadcast::setChannelNr (int {\em ChannelNr})}} -\label{classcUPnPClassVideoBroadcast_4a7804c6c86531d7e23cbc714daa6077} - - -Set channel number - -This sets the channel number, so that it can be used for directly navigation or channel up and down navigation respectively. - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em ChannelNr}]the channel number \end{description} -\end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_13e432f8a97072f3b45b1d199b82ae02}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!setIcon@{setIcon}} -\index{setIcon@{setIcon}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{setIcon}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoBroadcast::setIcon (const char $\ast$ {\em IconURI})}} -\label{classcUPnPClassVideoBroadcast_13e432f8a97072f3b45b1d199b82ae02} - - -Set the channel icon - -This sets the channel icon of this channel. The resource must be a valid URI which can be obtained via the internal webserver - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em IconURI}]the URI to the icon file \end{description} -\end{Desc} -\hypertarget{classcUPnPClassVideoBroadcast_ce7a341834e448479d3c8f4f0254ce43}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!setProperty@{setProperty}} -\index{setProperty@{setProperty}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{setProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassVideoBroadcast::setProperty (const char $\ast$ {\em Property}, \/ const char $\ast$ {\em Value})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} -\label{classcUPnPClassVideoBroadcast_ce7a341834e448479d3c8f4f0254ce43} - - -Sets a property - -Sets the value of a specified property. The value is converted from string into the propper data type - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt true},} if the property exists\item {\bf {\tt false},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Property}]the property which should be set \item[{\em Value}]the value of that property \end{description} -\end{Desc} - - -Reimplemented from \hyperlink{classcUPnPClassVideoItem_3cbda6d87f5a9ff0475a75e76ba19924}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassVideoBroadcast_228fcc06291dc3989917bbfa5ce3153f}{ -\index{cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}!setRegion@{setRegion}} -\index{setRegion@{setRegion}!cUPnPClassVideoBroadcast@{cUPnPClassVideoBroadcast}} -\subsubsection[{setRegion}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoBroadcast::setRegion (const char $\ast$ {\em Region})}} -\label{classcUPnPClassVideoBroadcast_228fcc06291dc3989917bbfa5ce3153f} - - -Set the channel region - -This sets the region of a channel, where it can be received - -\begin{Desc} -\item[Returns:]returns\begin{itemize} -\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} -\end{Desc} -\begin{Desc} -\item[Parameters:] -\begin{description} -\item[{\em Region}]the location where the channel can be received \end{description} -\end{Desc} - - -The documentation for this class was generated from the following files:\begin{CompactItemize} -\item -database/object.h\item -database/object.cpp\end{CompactItemize} |