diff options
Diffstat (limited to 'doc/latex/classcUPnPClassVideoItem.tex')
| -rw-r--r-- | doc/latex/classcUPnPClassVideoItem.tex | 572 |
1 files changed, 572 insertions, 0 deletions
diff --git a/doc/latex/classcUPnPClassVideoItem.tex b/doc/latex/classcUPnPClassVideoItem.tex new file mode 100644 index 0000000..efa4d8e --- /dev/null +++ b/doc/latex/classcUPnPClassVideoItem.tex @@ -0,0 +1,572 @@ +\hypertarget{classcUPnPClassVideoItem}{ +\section{cUPnPClassVideoItem Class Reference} +\label{classcUPnPClassVideoItem}\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}} +} +{\tt \#include $<$object.h$>$} + +Inheritance diagram for cUPnPClassVideoItem:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=400pt]{classcUPnPClassVideoItem__inherit__graph} +\end{center} +\end{figure} +Collaboration diagram for cUPnPClassVideoItem:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=400pt]{classcUPnPClassVideoItem__coll__graph} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +virtual cStringList $\ast$ \hyperlink{classcUPnPClassVideoItem_9dc397419b45535a3e6a676667b619a4}{getPropertyList} () +\item +virtual bool \hyperlink{classcUPnPClassVideoItem_3cbda6d87f5a9ff0475a75e76ba19924}{setProperty} (const char $\ast$Property, const char $\ast$Value) +\item +virtual bool \hyperlink{classcUPnPClassVideoItem_94ab2ffcbe14abb63c680e6748e70ef1}{getProperty} (const char $\ast$Property, char $\ast$$\ast$Value) const +\item +int \hyperlink{classcUPnPClassVideoItem_05c5b8394cbfcaeffe5f99c885496e3d}{setLongDescription} (const char $\ast$LongDescription) +\item +int \hyperlink{classcUPnPClassVideoItem_f5a642732c66b6920f5b4646a4c34a92}{setDescription} (const char $\ast$Description) +\item +int \hyperlink{classcUPnPClassVideoItem_db14c0944a89f179832a4f4914caa4ca}{setPublishers} (const char $\ast$Publishers) +\item +int \hyperlink{classcUPnPClassVideoItem_1be14ea33f9bbf53e636fea3658cc6f8}{setGenre} (const char $\ast$Genre) +\item +int \hyperlink{classcUPnPClassVideoItem_89c24d198ce7bdc31aac727e65b02a84}{setLanguage} (const char $\ast$Language) +\item +int \hyperlink{classcUPnPClassVideoItem_844385c5fb4f55c95a2994c7aaf120ef}{setRelations} (const char $\ast$Relations) +\item +int \hyperlink{classcUPnPClassVideoItem_a5fc1a420bfd307bbd026c0681162e0a}{setDirectors} (const char $\ast$Directors) +\item +int \hyperlink{classcUPnPClassVideoItem_33b104046098dbf66d894143181678c4}{setActors} (const char $\ast$Actors) +\item +int \hyperlink{classcUPnPClassVideoItem_3812b8056c9d2c7d13a7734e4219b27b}{setProducers} (const char $\ast$Producers) +\item +int \hyperlink{classcUPnPClassVideoItem_6d4143016fc91fcbb0db4e9f8a8a0047}{setRating} (const char $\ast$Rating) +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_b3ca922f5605d81bd8d3457fa19e228d}{getGenre} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_29f6f76f4ac21d6c15dbe2eb95a7d0c6}{getLongDescription} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_364180a89479d6143cfbe146d337a7dc}{getDescription} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_797dc99dd12b77af641b266ada7cb1dc}{getPublishers} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_4d134ac251a6c9b67a002d6fa831bf1c}{getLanguage} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_755e9710173d62fc2c9b98076391c916}{getRelations} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_61bca560d8469a441894896fe950adf3}{getActors} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_bd72ad944de96ddc8795cfe531adfef1}{getProducers} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_5b24963eb2d6d5d8e1547ba73863e13c}{getDirectors} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassVideoItem_2d8b94809b1207a14831e095c2b598a6}{getRating} () const +\end{CompactItemize} +\subsection*{Protected Member Functions} +\begin{CompactItemize} +\item +\hyperlink{classcUPnPClassVideoItem_38ce1c18cc9d474791255fdcb43824d2}{cUPnPClassVideoItem} () +\end{CompactItemize} +\subsection*{Protected Attributes} +\begin{CompactItemize} +\item +\hypertarget{classcUPnPClassVideoItem_b7fa79ab14701142597088b0a73515c3}{ +cString \hyperlink{classcUPnPClassVideoItem_b7fa79ab14701142597088b0a73515c3}{mGenre}} +\label{classcUPnPClassVideoItem_b7fa79ab14701142597088b0a73515c3} + +\begin{CompactList}\small\item\em Genre of the video. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_bdf0f85f02d43ef32d8aab1daecddd7e}{ +cString \hyperlink{classcUPnPClassVideoItem_bdf0f85f02d43ef32d8aab1daecddd7e}{mDescription}} +\label{classcUPnPClassVideoItem_bdf0f85f02d43ef32d8aab1daecddd7e} + +\begin{CompactList}\small\item\em Description. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_577abd61e96e6a7a17acd48eb7854a59}{ +cString \hyperlink{classcUPnPClassVideoItem_577abd61e96e6a7a17acd48eb7854a59}{mLongDescription}} +\label{classcUPnPClassVideoItem_577abd61e96e6a7a17acd48eb7854a59} + +\begin{CompactList}\small\item\em a longer description \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_f6bcbeb08f86a8e8c133e0904c07e89e}{ +cString \hyperlink{classcUPnPClassVideoItem_f6bcbeb08f86a8e8c133e0904c07e89e}{mPublishers}} +\label{classcUPnPClassVideoItem_f6bcbeb08f86a8e8c133e0904c07e89e} + +\begin{CompactList}\small\item\em CSV of Publishers. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_9d1d5e4f5058e4ca6a9e011b6eb97471}{ +cString \hyperlink{classcUPnPClassVideoItem_9d1d5e4f5058e4ca6a9e011b6eb97471}{mLanguage}} +\label{classcUPnPClassVideoItem_9d1d5e4f5058e4ca6a9e011b6eb97471} + +\begin{CompactList}\small\item\em RFC 1766 Language code. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_dc03dd27283de69640cea28783459d97}{ +cString \hyperlink{classcUPnPClassVideoItem_dc03dd27283de69640cea28783459d97}{mRelations}} +\label{classcUPnPClassVideoItem_dc03dd27283de69640cea28783459d97} + +\begin{CompactList}\small\item\em Relation to other contents. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_fa8cca909e9bde4fdff684bfdd4d8ac0}{ +cString \hyperlink{classcUPnPClassVideoItem_fa8cca909e9bde4fdff684bfdd4d8ac0}{mProducers}} +\label{classcUPnPClassVideoItem_fa8cca909e9bde4fdff684bfdd4d8ac0} + +\begin{CompactList}\small\item\em CSV of Producers. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_73540adc3263ddbabc10018ba9a52cf9}{ +cString \hyperlink{classcUPnPClassVideoItem_73540adc3263ddbabc10018ba9a52cf9}{mRating}} +\label{classcUPnPClassVideoItem_73540adc3263ddbabc10018ba9a52cf9} + +\begin{CompactList}\small\item\em Rating (for parential control). \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_2f22a58a30b8baf53a3dd76e6bc679a8}{ +cString \hyperlink{classcUPnPClassVideoItem_2f22a58a30b8baf53a3dd76e6bc679a8}{mActors}} +\label{classcUPnPClassVideoItem_2f22a58a30b8baf53a3dd76e6bc679a8} + +\begin{CompactList}\small\item\em CSV of Actors. \item\end{CompactList}\item +\hypertarget{classcUPnPClassVideoItem_79ace4a5927eaf082628ee8120e988ad}{ +cString \hyperlink{classcUPnPClassVideoItem_79ace4a5927eaf082628ee8120e988ad}{mDirectors}} +\label{classcUPnPClassVideoItem_79ace4a5927eaf082628ee8120e988ad} + +\begin{CompactList}\small\item\em CSV of Directors. \item\end{CompactList}\end{CompactItemize} +\subsection*{Friends} +\begin{CompactItemize} +\item +\hypertarget{classcUPnPClassVideoItem_3d0d0aedce8b1c661ea360b9a6d616f6}{ +class \hyperlink{classcUPnPClassVideoItem_3d0d0aedce8b1c661ea360b9a6d616f6}{cMediaDatabase}} +\label{classcUPnPClassVideoItem_3d0d0aedce8b1c661ea360b9a6d616f6} + +\item +\hypertarget{classcUPnPClassVideoItem_aefab39434a832c545ac75a79fa81d23}{ +class \hyperlink{classcUPnPClassVideoItem_aefab39434a832c545ac75a79fa81d23}{cUPnPObjectMediator}} +\label{classcUPnPClassVideoItem_aefab39434a832c545ac75a79fa81d23} + +\item +\hypertarget{classcUPnPClassVideoItem_e0d1a617e075a78abffc13ad3a3d341e}{ +class \hyperlink{classcUPnPClassVideoItem_e0d1a617e075a78abffc13ad3a3d341e}{cUPnPVideoItemMediator}} +\label{classcUPnPClassVideoItem_e0d1a617e075a78abffc13ad3a3d341e} + +\end{CompactItemize} + + +\subsection{Detailed Description} +The UPnP class VideoItem + +This is a UPnP class VideoItem representation with all its properties. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classcUPnPClassVideoItem_38ce1c18cc9d474791255fdcb43824d2}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{cUPnPClassVideoItem}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPClassVideoItem::cUPnPClassVideoItem ()\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}} +\label{classcUPnPClassVideoItem_38ce1c18cc9d474791255fdcb43824d2} + + +Constructor of a video item + +This creates a new instance of a video item + +\subsection{Member Function Documentation} +\hypertarget{classcUPnPClassVideoItem_61bca560d8469a441894896fe950adf3}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getActors@{getActors}} +\index{getActors@{getActors}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getActors}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getActors () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_61bca560d8469a441894896fe950adf3} + + +Get the actors + +This returns a CSV list of actors in the video + +\begin{Desc} +\item[Returns:]a CSV list of actors \end{Desc} +\hypertarget{classcUPnPClassVideoItem_364180a89479d6143cfbe146d337a7dc}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getDescription@{getDescription}} +\index{getDescription@{getDescription}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getDescription}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getDescription () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_364180a89479d6143cfbe146d337a7dc} + + +Get the description + +This returns the description of a video + +\begin{Desc} +\item[Returns:]the description of a video \end{Desc} +\hypertarget{classcUPnPClassVideoItem_5b24963eb2d6d5d8e1547ba73863e13c}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getDirectors@{getDirectors}} +\index{getDirectors@{getDirectors}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getDirectors}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getDirectors () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_5b24963eb2d6d5d8e1547ba73863e13c} + + +Get the directors + +This returns a CSV list of directors + +\begin{Desc} +\item[Returns:]a CSV list of directors \end{Desc} +\hypertarget{classcUPnPClassVideoItem_b3ca922f5605d81bd8d3457fa19e228d}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getGenre@{getGenre}} +\index{getGenre@{getGenre}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getGenre}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getGenre () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_b3ca922f5605d81bd8d3457fa19e228d} + + +Get the genres + +This returns a CSV list of genre + +\begin{Desc} +\item[Returns:]the genre of a video \end{Desc} +\hypertarget{classcUPnPClassVideoItem_4d134ac251a6c9b67a002d6fa831bf1c}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getLanguage@{getLanguage}} +\index{getLanguage@{getLanguage}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getLanguage}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getLanguage () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_4d134ac251a6c9b67a002d6fa831bf1c} + + +Get the language + +This returns the language of the video + +\begin{Desc} +\item[Returns:]the language \end{Desc} +\hypertarget{classcUPnPClassVideoItem_29f6f76f4ac21d6c15dbe2eb95a7d0c6}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getLongDescription@{getLongDescription}} +\index{getLongDescription@{getLongDescription}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getLongDescription}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getLongDescription () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_29f6f76f4ac21d6c15dbe2eb95a7d0c6} + + +Get the long description + +This returns the long description of a video + +\begin{Desc} +\item[Returns:]the long description of a video \end{Desc} +\hypertarget{classcUPnPClassVideoItem_bd72ad944de96ddc8795cfe531adfef1}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getProducers@{getProducers}} +\index{getProducers@{getProducers}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getProducers}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getProducers () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_bd72ad944de96ddc8795cfe531adfef1} + + +Get the producers + +This returns a CSV list of producers of a video + +\begin{Desc} +\item[Returns:]a CSV list of producers \end{Desc} +\hypertarget{classcUPnPClassVideoItem_94ab2ffcbe14abb63c680e6748e70ef1}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getProperty@{getProperty}} +\index{getProperty@{getProperty}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassVideoItem::getProperty (const char $\ast$ {\em Property}, \/ char $\ast$$\ast$ {\em Value}) const\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassVideoItem_94ab2ffcbe14abb63c680e6748e70ef1} + + +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{classcUPnPClassItem_31f7010baa65cc25b95a864f05eb4e62}{cUPnPClassItem}. + +Reimplemented in \hyperlink{classcUPnPClassMovie_b4c1d5a973856469b93d2033b65d7ba2}{cUPnPClassMovie}, and \hyperlink{classcUPnPClassVideoBroadcast_e1d13a13de094337cea6be214c4da0f0}{cUPnPClassVideoBroadcast}.\hypertarget{classcUPnPClassVideoItem_9dc397419b45535a3e6a676667b619a4}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getPropertyList@{getPropertyList}} +\index{getPropertyList@{getPropertyList}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getPropertyList}]{\setlength{\rightskip}{0pt plus 5cm}cStringList $\ast$ cUPnPClassVideoItem::getPropertyList ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassVideoItem_9dc397419b45535a3e6a676667b619a4} + + +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{classcUPnPClassItem_add0c9d378036e270e6f99d8d1409e3b}{cUPnPClassItem}. + +Reimplemented in \hyperlink{classcUPnPClassMovie_b62e6dac175090b82c47f955e29c146c}{cUPnPClassMovie}, and \hyperlink{classcUPnPClassVideoBroadcast_192f6a04c87fe8d56f99c71337cf0f68}{cUPnPClassVideoBroadcast}.\hypertarget{classcUPnPClassVideoItem_797dc99dd12b77af641b266ada7cb1dc}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getPublishers@{getPublishers}} +\index{getPublishers@{getPublishers}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getPublishers}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getPublishers () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_797dc99dd12b77af641b266ada7cb1dc} + + +Get the publishers + +This returns a CSV list of publishers of the video + +\begin{Desc} +\item[Returns:]a CSV list of publishers \end{Desc} +\hypertarget{classcUPnPClassVideoItem_2d8b94809b1207a14831e095c2b598a6}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getRating@{getRating}} +\index{getRating@{getRating}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getRating}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getRating () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_2d8b94809b1207a14831e095c2b598a6} + + +Get the rating + +This returns the rating used for parental control. + +\begin{Desc} +\item[Returns:]the rating of a video \end{Desc} +\hypertarget{classcUPnPClassVideoItem_755e9710173d62fc2c9b98076391c916}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!getRelations@{getRelations}} +\index{getRelations@{getRelations}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{getRelations}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassVideoItem::getRelations () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassVideoItem_755e9710173d62fc2c9b98076391c916} + + +Get the relations + +This returns a CSV list of relation URLs. + +\begin{Desc} +\item[Returns:]a CSV list of relation URLs \end{Desc} +\hypertarget{classcUPnPClassVideoItem_33b104046098dbf66d894143181678c4}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setActors@{setActors}} +\index{setActors@{setActors}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setActors}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setActors (const char $\ast$ {\em Actors})}} +\label{classcUPnPClassVideoItem_33b104046098dbf66d894143181678c4} + + +Sets the actors + +This sets a CSV list of actors in a video. This usually contain the main actors. However, also other actors appearing in the video can be mentioned here. + +\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 Actors}]a CSV list of actors \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_f5a642732c66b6920f5b4646a4c34a92}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setDescription@{setDescription}} +\index{setDescription@{setDescription}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setDescription}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setDescription (const char $\ast$ {\em Description})}} +\label{classcUPnPClassVideoItem_f5a642732c66b6920f5b4646a4c34a92} + + +Set a description + +A description may hold short information about the content or the story of a video. Unlike a long description, this contains just a very short brief like a subtitle or the episode title. + +\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 Description}]the description of a video \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_a5fc1a420bfd307bbd026c0681162e0a}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setDirectors@{setDirectors}} +\index{setDirectors@{setDirectors}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setDirectors}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setDirectors (const char $\ast$ {\em Directors})}} +\label{classcUPnPClassVideoItem_a5fc1a420bfd307bbd026c0681162e0a} + + +Sets the directors + +This sets a CSV list of directors. + +\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 Directors}]a CSV list of directors \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_1be14ea33f9bbf53e636fea3658cc6f8}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setGenre@{setGenre}} +\index{setGenre@{setGenre}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setGenre}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setGenre (const char $\ast$ {\em Genre})}} +\label{classcUPnPClassVideoItem_1be14ea33f9bbf53e636fea3658cc6f8} + + +Set a genre + +This is a CSV list of genre of a video. This may be something like \char`\"{}Western\char`\"{} or \char`\"{}SciFi\char`\"{}. Actually, there is no standardized rule for a genre name, which results in an ambiguous definition of certain genre, like Thriller and Horror. + +\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 Genre}]a CSV list of genre \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_89c24d198ce7bdc31aac727e65b02a84}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setLanguage@{setLanguage}} +\index{setLanguage@{setLanguage}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setLanguage}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setLanguage (const char $\ast$ {\em Language})}} +\label{classcUPnPClassVideoItem_89c24d198ce7bdc31aac727e65b02a84} + + +Set the language + +This sets the language of a video. It is defined by RFC 1766. A valid language definition is {\em \char`\"{}de-DE\char`\"{}\/} or {\em \char`\"{}en-US\char`\"{}\/}. + +\begin{Desc} +\item[See also:]\href{http://www.ietf.org/rfc/rfc1766.txt}{\tt http://www.ietf.org/rfc/rfc1766.txt} \end{Desc} +\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 Language}]the language (RFC 1766) \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_05c5b8394cbfcaeffe5f99c885496e3d}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setLongDescription@{setLongDescription}} +\index{setLongDescription@{setLongDescription}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setLongDescription}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setLongDescription (const char $\ast$ {\em LongDescription})}} +\label{classcUPnPClassVideoItem_05c5b8394cbfcaeffe5f99c885496e3d} + + +Set a long description + +A long description may hold information about the content or the story of a video + +\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 LongDescription}]the content or story of a video \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_3812b8056c9d2c7d13a7734e4219b27b}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setProducers@{setProducers}} +\index{setProducers@{setProducers}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setProducers}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setProducers (const char $\ast$ {\em Producers})}} +\label{classcUPnPClassVideoItem_3812b8056c9d2c7d13a7734e4219b27b} + + +Sets the producers + +This sets a CSV list of producers of a video. These are the people who are involed in the production of a video + +\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 Producers}]a CSV list of producers \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_3cbda6d87f5a9ff0475a75e76ba19924}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setProperty@{setProperty}} +\index{setProperty@{setProperty}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassVideoItem::setProperty (const char $\ast$ {\em Property}, \/ const char $\ast$ {\em Value})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassVideoItem_3cbda6d87f5a9ff0475a75e76ba19924} + + +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{classcUPnPClassItem_ab17057659c17792a5b67f4297ade642}{cUPnPClassItem}. + +Reimplemented in \hyperlink{classcUPnPClassMovie_d7f990edda85f2caabe822d2ceeb2b0d}{cUPnPClassMovie}, and \hyperlink{classcUPnPClassVideoBroadcast_ce7a341834e448479d3c8f4f0254ce43}{cUPnPClassVideoBroadcast}.\hypertarget{classcUPnPClassVideoItem_db14c0944a89f179832a4f4914caa4ca}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setPublishers@{setPublishers}} +\index{setPublishers@{setPublishers}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setPublishers}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setPublishers (const char $\ast$ {\em Publishers})}} +\label{classcUPnPClassVideoItem_db14c0944a89f179832a4f4914caa4ca} + + +Set the publishers + +This is a CSV list of publishers, who distributes the video. + +\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 Publishers}]a CSV list of publishers \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_6d4143016fc91fcbb0db4e9f8a8a0047}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setRating@{setRating}} +\index{setRating@{setRating}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setRating}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setRating (const char $\ast$ {\em Rating})}} +\label{classcUPnPClassVideoItem_6d4143016fc91fcbb0db4e9f8a8a0047} + + +Sets the rating + +This is a rating, which can be used for parential control issues. + +\begin{Desc} +\item[See also:]\href{http://en.wikipedia.org/wiki/Motion_picture_rating_system}{\tt http://en.wikipedia.org/wiki/Motion\_\-picture\_\-rating\_\-system} \end{Desc} +\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 Rating}]the rating of a video \end{description} +\end{Desc} +\hypertarget{classcUPnPClassVideoItem_844385c5fb4f55c95a2994c7aaf120ef}{ +\index{cUPnPClassVideoItem@{cUPnPClassVideoItem}!setRelations@{setRelations}} +\index{setRelations@{setRelations}!cUPnPClassVideoItem@{cUPnPClassVideoItem}} +\subsubsection[{setRelations}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassVideoItem::setRelations (const char $\ast$ {\em Relations})}} +\label{classcUPnPClassVideoItem_844385c5fb4f55c95a2994c7aaf120ef} + + +Sets a relation URL + +This sets a CSV list of relation URLs, where to find additional information about the movie. The URLs may not contain commas and they must be properly escaped as in RFC 2396 + +\begin{Desc} +\item[See also:]\href{http://www.ietf.org/rfc/rfc2396.txt}{\tt http://www.ietf.org/rfc/rfc2396.txt} \end{Desc} +\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 Relations}]a CSV list with relations \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} |