File: classTp_1_1MediaContent.html

package info (click to toggle)
telepathy-qt4 0.3.6-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 14,260 kB
  • ctags: 12,185
  • sloc: cpp: 29,241; xml: 23,692; ansic: 16,079; sh: 10,327; python: 3,080; makefile: 1,553
file content (240 lines) | stat: -rw-r--r-- 11,289 bytes parent folder | download
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>TelepathyQt4: Tp::MediaContent Class Reference</title>
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1">&nbsp;&nbsp;</td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a>&nbsp;&middot;
<a href="classes.html">
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
<a href="modules.html">
<font color="#004faf">Modules</font></a>&nbsp;&middot;
<a href="functions.html">
<font color="#004faf">Functions</font></a>&nbsp;&middot;
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
  <div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1MediaContent.html">MediaContent</a>
  </div>
<div class="contents">
<h1>Tp::MediaContent Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::MediaContent" --><!-- doxytag: inherits="Tp::ReadyObject,Tp::RefCounted" -->
<p>The <a class="el" href="classTp_1_1MediaContent.html" title="The MediaContent class provides an object representing a Telepathy media content...">MediaContent</a> class provides an object representing a Telepathy media content.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="streamed-media-channel_8h_source.html">TelepathyQt4/StreamedMediaChannel</a>&gt;</code></p>

<p>Inherits <a class="el" href="classTp_1_1ReadyObject.html">Tp::ReadyObject</a>, and <a class="el" href="classTp_1_1RefCounted.html">Tp::RefCounted</a>.</p>

<p><a href="classTp_1_1MediaContent-members.html">List of all members.</a></p>
<h2>Signals</h2>
<ul>
<li>void <a class="el" href="classTp_1_1MediaContent.html#a95bbb8cc95d62fce0b8e3e32826ece90">streamAdded</a> (const <a class="el" href="classTp_1_1SharedPtr.html">Tp::MediaStreamPtr</a> &amp;stream)
<li>void <a class="el" href="classTp_1_1MediaContent.html#a5949f0324a9b8719cd54e90709139a3d">streamRemoved</a> (const <a class="el" href="classTp_1_1SharedPtr.html">Tp::MediaStreamPtr</a> &amp;stream)
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1MediaContent.html#ae96c36f41a1a6226045c5159b8b30df8">~MediaContent</a> ()
<li><a class="el" href="classTp_1_1SharedPtr.html">StreamedMediaChannelPtr</a> <a class="el" href="classTp_1_1MediaContent.html#ac303f256351b36892010dedf5c7a8b51">channel</a> () const 
<li>QString <a class="el" href="classTp_1_1MediaContent.html#a174063606d12fd6e3e3e870469df9cc4">name</a> () const 
<li>MediaStreamType <a class="el" href="classTp_1_1MediaContent.html#a8a127577bd4d622e6d40fc28379f2482">type</a> () const 
<li><a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> <a class="el" href="classTp_1_1MediaContent.html#aedb1726f1c07a5e0e66cbd27ad0cf87e">creator</a> () const 
<li><a class="el" href="namespaceTp.html#ada4348f180c7aaf752c9cdd3beb42a54">MediaStreams</a> <a class="el" href="classTp_1_1MediaContent.html#a44a597f17eea17d0c6d88656933a61a1">streams</a> () const 
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1MediaContent.html" title="The MediaContent class provides an object representing a Telepathy media content...">MediaContent</a> class provides an object representing a Telepathy media content. </p>
<p>Instances of this class cannot be constructed directly; the only way to get one is via <a class="el" href="classTp_1_1StreamedMediaChannel.html" title="The StreamedMediaChannel class provides an object representing a Telepathy channel...">StreamedMediaChannel</a>.</p>
<p>See <a class="el" href="async__model.html">Asynchronous Object Model</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae96c36f41a1a6226045c5159b8b30df8"></a><!-- doxytag: member="Tp::MediaContent::~MediaContent" ref="ae96c36f41a1a6226045c5159b8b30df8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::MediaContent::~MediaContent </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Class destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac303f256351b36892010dedf5c7a8b51"></a><!-- doxytag: member="Tp::MediaContent::channel" ref="ac303f256351b36892010dedf5c7a8b51" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">StreamedMediaChannelPtr</a> Tp::MediaContent::channel </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the channel owning this media content.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The channel owning this media content. </dd></dl>

</div>
</div>
<a class="anchor" id="a174063606d12fd6e3e3e870469df9cc4"></a><!-- doxytag: member="Tp::MediaContent::name" ref="a174063606d12fd6e3e3e870469df9cc4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Tp::MediaContent::name </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the name of this media content.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The name of this media content. </dd></dl>

</div>
</div>
<a class="anchor" id="a8a127577bd4d622e6d40fc28379f2482"></a><!-- doxytag: member="Tp::MediaContent::type" ref="a8a127577bd4d622e6d40fc28379f2482" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">MediaStreamType Tp::MediaContent::type </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the type of this media content.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The type of this media content. </dd></dl>

</div>
</div>
<a class="anchor" id="aedb1726f1c07a5e0e66cbd27ad0cf87e"></a><!-- doxytag: member="Tp::MediaContent::creator" ref="aedb1726f1c07a5e0e66cbd27ad0cf87e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceTp.html#a8851d7a4827022bfff3c1b15320a0289">ContactPtr</a> Tp::MediaContent::creator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the contact who created this media content.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The contact who created this media content. </dd></dl>

</div>
</div>
<a class="anchor" id="a44a597f17eea17d0c6d88656933a61a1"></a><!-- doxytag: member="Tp::MediaContent::streams" ref="a44a597f17eea17d0c6d88656933a61a1" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceTp.html#ada4348f180c7aaf752c9cdd3beb42a54">MediaStreams</a> Tp::MediaContent::streams </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the media streams of this media content.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of media streams of this media content. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaContent.html#a95bbb8cc95d62fce0b8e3e32826ece90">streamAdded()</a>, <a class="el" href="classTp_1_1MediaContent.html#a5949f0324a9b8719cd54e90709139a3d">streamRemoved()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a95bbb8cc95d62fce0b8e3e32826ece90"></a><!-- doxytag: member="Tp::MediaContent::streamAdded" ref="a95bbb8cc95d62fce0b8e3e32826ece90" args="(const Tp::MediaStreamPtr &amp;stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::MediaContent::streamAdded </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">Tp::MediaStreamPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This signal is emitted when a new media stream is added to this media content.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The media stream that was added. </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaContent.html#a44a597f17eea17d0c6d88656933a61a1">streams()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a5949f0324a9b8719cd54e90709139a3d"></a><!-- doxytag: member="Tp::MediaContent::streamRemoved" ref="a5949f0324a9b8719cd54e90709139a3d" args="(const Tp::MediaStreamPtr &amp;stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Tp::MediaContent::streamRemoved </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">Tp::MediaStreamPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This signal is emitted when a new media stream is removed from this media content.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The media stream that was removed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1MediaContent.html#a44a597f17eea17d0c6d88656933a61a1">streams()</a> </dd></dl>

</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>