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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
<Type Name="PlayerEngine" FullName="Banshee.MediaEngine.PlayerEngine">
<TypeSignature Language="C#" Value="public abstract class PlayerEngine" />
<AssemblyInfo>
<AssemblyName>Banshee.Base</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected PlayerEngine ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Protected constructor.</summary>
<remarks>The engine implementation should provide its own default public constructor. If it cannot recover in a working state from any error in initialization, it should throw or propagate any exception for <see cref="T:Banshee.Base.PlayerEngineCore" /> to handle.</remarks>
</Docs>
</Member>
<Member MemberName="StateChanged">
<MemberSignature Language="C#" Value="public event Banshee.MediaEngine.PlayerEngineStateHandler StateChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Banshee.MediaEngine.PlayerEngineStateHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EventChanged">
<MemberSignature Language="C#" Value="public event Banshee.MediaEngine.PlayerEngineEventHandler EventChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Banshee.MediaEngine.PlayerEngineEventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenUri">
<MemberSignature Language="C#" Value="protected abstract void OpenUri (Banshee.Base.SafeUri uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Banshee.Base.SafeUri" />
</Parameters>
<Docs>
<param name="uri">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public virtual void Close ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public virtual void Dispose ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public void Open (Banshee.Base.TrackInfo track);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="track" Type="Banshee.Base.TrackInfo" />
</Parameters>
<Docs>
<param name="track">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public void Open (Banshee.Base.SafeUri uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="Banshee.Base.SafeUri" />
</Parameters>
<Docs>
<param name="uri">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Play">
<MemberSignature Language="C#" Value="public virtual void Play ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pause">
<MemberSignature Language="C#" Value="public virtual void Pause ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetBaseElements">
<MemberSignature Language="C#" Value="public virtual IntPtr[] GetBaseElements ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnStateChanged">
<MemberSignature Language="C#" Value="protected virtual void OnStateChanged (Banshee.MediaEngine.PlayerEngineState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="Banshee.MediaEngine.PlayerEngineState" />
</Parameters>
<Docs>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEventChanged">
<MemberSignature Language="C#" Value="protected void OnEventChanged (Banshee.MediaEngine.PlayerEngineEvent evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Banshee.MediaEngine.PlayerEngineEvent" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEventChanged">
<MemberSignature Language="C#" Value="protected void OnEventChanged (Banshee.MediaEngine.PlayerEngineEvent evnt, string message);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Banshee.MediaEngine.PlayerEngineEvent" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEventChanged">
<MemberSignature Language="C#" Value="protected virtual void OnEventChanged (Banshee.MediaEngine.PlayerEngineEvent evnt, string message, double bufferingPercent);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Banshee.MediaEngine.PlayerEngineEvent" />
<Parameter Name="message" Type="System.String" />
<Parameter Name="bufferingPercent" Type="System.Double" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<param name="message">To be added.</param>
<param name="bufferingPercent">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnTagFound">
<MemberSignature Language="C#" Value="protected void OnTagFound (Banshee.Base.StreamTag tag);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tag" Type="Banshee.Base.StreamTag" />
</Parameters>
<Docs>
<param name="tag">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentTrack">
<MemberSignature Language="C#" Value="public Banshee.Base.TrackInfo CurrentTrack { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Banshee.Base.TrackInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>The track that the engine is currently playing or has loaded.</summary>
<value>A TrackInfo object representing the currently loaded track.</value>
<remarks>An interface can use this property to display to the user metadata about the current playing or loaded track.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentUri">
<MemberSignature Language="C#" Value="public Banshee.Base.SafeUri CurrentUri { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Banshee.Base.SafeUri</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentState">
<MemberSignature Language="C#" Value="public Banshee.MediaEngine.PlayerEngineState CurrentState { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Banshee.MediaEngine.PlayerEngineState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current state of the engine.</summary>
<value>A PlayerEngineState type depicting the current state of the engine.</value>
<remarks>An interface element, such as a play/pause button, should check this property to reflect the engine state in a UI.</remarks>
</Docs>
</Member>
<Member MemberName="LastState">
<MemberSignature Language="C#" Value="public Banshee.MediaEngine.PlayerEngineState LastState { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Banshee.MediaEngine.PlayerEngineState</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Volume">
<MemberSignature Language="C#" Value="public abstract ushort Volume { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanSeek">
<MemberSignature Language="C#" Value="public virtual bool CanSeek { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether or not the playing stream is seekable.</summary>
<value>If seeking is possible in the stream, return value will be true; false if the stream does not support seeking.</value>
<remarks>An interface element, such as a range slider, should check this value to determine its sensitivity.</remarks>
</Docs>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public abstract uint Position { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public abstract uint Length { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SourceCapabilities">
<MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerable SourceCapabilities { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExplicitDecoderCapabilities">
<MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerable ExplicitDecoderCapabilities { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public abstract string Id { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public abstract string Name { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>Abstract class implemented by media engine playback plugins.</summary>
<remarks>
<para>PlayerEngine is an abstract class that engine backends can implement. It provides access to common features of a player backend, such as playback control and stream information. </para>
<para>Because Banshee supports multiple engines that can be switched between dynamically, in most situations you want to access common features of PlayerEngine through the global static class, <see cref="T:Banshee.Base.PlayerEngineCore" />.</para>
<para>PlayerEngineCore handles the runtime loading, initialization, and dynamic engine switching of implemented and available engines.</para>
</remarks>
</Docs>
</Type>
|
