summaryrefslogtreecommitdiff
path: root/doc/latex/classcUPnPVideoBroadcastMediator.tex
blob: d8ae253a2518d024627c23c05bdb0c241474b9d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
\hypertarget{classcUPnPVideoBroadcastMediator}{
\section{cUPnPVideoBroadcastMediator Class Reference}
\label{classcUPnPVideoBroadcastMediator}\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
}
{\tt \#include $<$object.h$>$}

Inheritance diagram for cUPnPVideoBroadcastMediator:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=400pt]{classcUPnPVideoBroadcastMediator__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for cUPnPVideoBroadcastMediator:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{classcUPnPVideoBroadcastMediator__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classcUPnPVideoBroadcastMediator_58179b50ee5a5952cff70aa4473845f9}{cUPnPVideoBroadcastMediator} (\hyperlink{classcMediaDatabase}{cMediaDatabase} $\ast$MediaDatabase)
\item 
virtual \hyperlink{classcUPnPClassVideoBroadcast}{cUPnPClassVideoBroadcast} $\ast$ \hyperlink{classcUPnPVideoBroadcastMediator_14fefa90807d40d91a80712729af2beb}{createObject} (const char $\ast$Title, bool Restricted)
\item 
virtual \hyperlink{classcUPnPClassVideoBroadcast}{cUPnPClassVideoBroadcast} $\ast$ \hyperlink{classcUPnPVideoBroadcastMediator_c13bf0f008f49b0ab499542391998a24}{getObject} (\hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual int \hyperlink{classcUPnPVideoBroadcastMediator_822f9c93928a7dbe9491c8cccbf53f95}{objectToDatabase} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object)
\item 
virtual int \hyperlink{classcUPnPVideoBroadcastMediator_33237e5d850c107d37be37c1646b17d7}{databaseToObject} (\hyperlink{classcUPnPClassObject}{cUPnPClassObject} $\ast$Object, \hyperlink{structcUPnPObjectID}{cUPnPObjectID} ID)
\end{CompactItemize}


\subsection{Detailed Description}
VideoBroadcast Mediator

This is the interface between the objects and the database. It is possible to create new objects, stores objects in the database as well as removing them from it. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classcUPnPVideoBroadcastMediator_58179b50ee5a5952cff70aa4473845f9}{
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\subsubsection[{cUPnPVideoBroadcastMediator}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPVideoBroadcastMediator::cUPnPVideoBroadcastMediator ({\bf cMediaDatabase} $\ast$ {\em MediaDatabase})}}
\label{classcUPnPVideoBroadcastMediator_58179b50ee5a5952cff70aa4473845f9}


Constructor of video broadcast mediator

This creates a new video broadcast mediator with which it is possible to create new instances of VideoBroadcast objects.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em MediaDatabase}]the media database \end{description}
\end{Desc}


\subsection{Member Function Documentation}
\hypertarget{classcUPnPVideoBroadcastMediator_14fefa90807d40d91a80712729af2beb}{
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!createObject@{createObject}}
\index{createObject@{createObject}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\subsubsection[{createObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassVideoBroadcast} $\ast$ cUPnPVideoBroadcastMediator::createObject (const char $\ast$ {\em Title}, \/  bool {\em Restricted})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
\label{classcUPnPVideoBroadcastMediator_14fefa90807d40d91a80712729af2beb}


Creates an object

This creates a new UPnP object with the specific title and the restriction.

\begin{Desc}
\item[Returns:]the newly created object \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em Title}]the title of that object \item[{\em Restricted}]the restriction of the object \end{description}
\end{Desc}
  

Reimplemented from \hyperlink{classcUPnPVideoItemMediator_27e001142c3651c36dfd3b7c450414c0}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPVideoBroadcastMediator_33237e5d850c107d37be37c1646b17d7}{
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!databaseToObject@{databaseToObject}}
\index{databaseToObject@{databaseToObject}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\subsubsection[{databaseToObject}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPVideoBroadcastMediator::databaseToObject ({\bf cUPnPClassObject} $\ast$ {\em Object}, \/  {\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt  \mbox{[}protected, virtual\mbox{]}}}}
\label{classcUPnPVideoBroadcastMediator_33237e5d850c107d37be37c1646b17d7}


Loads an object from database

This loads an object from the database

\begin{Desc}
\item[Returns:]returns\begin{itemize}
\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em Object}]the object to be loaded \item[{\em ID}]the object ID of that object \end{description}
\end{Desc}
 

Reimplemented from \hyperlink{classcUPnPVideoItemMediator_3f7ec1937b2b95e3ec5462470971d350}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPVideoBroadcastMediator_c13bf0f008f49b0ab499542391998a24}{
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!getObject@{getObject}}
\index{getObject@{getObject}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\subsubsection[{getObject}]{\setlength{\rightskip}{0pt plus 5cm}{\bf cUPnPClassVideoBroadcast} $\ast$ cUPnPVideoBroadcastMediator::getObject ({\bf cUPnPObjectID} {\em ID})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
\label{classcUPnPVideoBroadcastMediator_c13bf0f008f49b0ab499542391998a24}


Get an object

Retrieves a UPnP object from the database and stores its information in the object. The object is obtained via its object ID.

\begin{Desc}
\item[Returns:]the object, found in the database \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ID}]the object ID \end{description}
\end{Desc}
  

Reimplemented from \hyperlink{classcUPnPVideoItemMediator_dd8927340a69d247965ef9250adefb21}{cUPnPVideoItemMediator}.\hypertarget{classcUPnPVideoBroadcastMediator_822f9c93928a7dbe9491c8cccbf53f95}{
\index{cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}!objectToDatabase@{objectToDatabase}}
\index{objectToDatabase@{objectToDatabase}!cUPnPVideoBroadcastMediator@{cUPnPVideoBroadcastMediator}}
\subsubsection[{objectToDatabase}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPVideoBroadcastMediator::objectToDatabase ({\bf cUPnPClassObject} $\ast$ {\em Object})\hspace{0.3cm}{\tt  \mbox{[}protected, virtual\mbox{]}}}}
\label{classcUPnPVideoBroadcastMediator_822f9c93928a7dbe9491c8cccbf53f95}


Store the object in the database

This stores the information of an object in the database

\begin{Desc}
\item[Returns:]returns\begin{itemize}
\item {\bf {\tt $<$0},} in case of an error\item {\bf {\tt 0},} otherwise \end{itemize}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em Object}]the object to be saved \end{description}
\end{Desc}
 

Reimplemented from \hyperlink{classcUPnPVideoItemMediator_984e10738bca46ce38307d5f60e26bd3}{cUPnPVideoItemMediator}.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
database/object.h\item 
database/object.cpp\end{CompactItemize}