Release 4.0.0-preview1-00184
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Multimedia.Remoting.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.Multimedia.Remoting</name>
5     </assembly>
6     <members>
7         <member name="T:Tizen.Multimedia.Remoting.MediaController">
8             <summary>
9             Provides a means to to send commands to and handle events from media control server.
10             </summary>
11         </member>
12         <member name="P:Tizen.Multimedia.Remoting.MediaController.ServerAppId">
13             <summary>
14             Gets the application id of the server.
15             </summary>
16             <value>The server application id.</value>
17         </member>
18         <member name="P:Tizen.Multimedia.Remoting.MediaController.IsStopped">
19             <summary>
20             Gets a value indicating whether the sever has been stopped.
21             </summary>
22             <value>true if the server has been stopped; otherwise, false.</value>
23         </member>
24         <member name="E:Tizen.Multimedia.Remoting.MediaController.ServerStopped">
25             <summary>
26             Occurs when the server is stopped.
27             </summary>
28         </member>
29         <member name="E:Tizen.Multimedia.Remoting.MediaController.PlaybackStateUpdated">
30             <summary>
31             Occurs when the playback state is updated.
32             </summary>
33         </member>
34         <member name="E:Tizen.Multimedia.Remoting.MediaController.MetadataUpdated">
35             <summary>
36             Occurs when the metadata is updated.
37             </summary>
38         </member>
39         <member name="E:Tizen.Multimedia.Remoting.MediaController.ShuffleModeUpdated">
40             <summary>
41             Occurs when the shuffle mode is updated.
42             </summary>
43         </member>
44         <member name="E:Tizen.Multimedia.Remoting.MediaController.RepeatModeUpdated">
45             <summary>
46             Occurs when the repeat mode is updated.
47             </summary>
48         </member>
49         <member name="M:Tizen.Multimedia.Remoting.MediaController.GetPlaybackState">
50             <summary>
51             Returns the playback state set by the server.
52             </summary>
53             <returns>The playback state.</returns>
54             <exception cref="T:System.InvalidOperationException">
55                 The server has already been stopped.
56                 -or-\n
57                 An internal error occurs.
58             </exception>
59             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
60             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.SetPlaybackState(Tizen.Multimedia.Remoting.MediaControlPlaybackState,System.Int64)"/>
61         </member>
62         <member name="M:Tizen.Multimedia.Remoting.MediaController.GetPlaybackPosition">
63             <summary>
64             Returns the playback position set by the server.
65             </summary>
66             <returns>The playback position in milliseconds.</returns>
67             <exception cref="T:System.InvalidOperationException">
68                 The server has already been stopped.
69                 -or-\n
70                 An internal error occurs.
71             </exception>
72             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
73             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.SetPlaybackState(Tizen.Multimedia.Remoting.MediaControlPlaybackState,System.Int64)"/>
74         </member>
75         <member name="M:Tizen.Multimedia.Remoting.MediaController.GetMetadata">
76             <summary>
77             Returns the metadata set by the server.
78             </summary>
79             <returns>The metadata.</returns>
80             <exception cref="T:System.InvalidOperationException">
81                 The server has already been stopped.
82                 -or-\n
83                 An internal error occurs.
84             </exception>
85             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
86             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.SetMetadata(Tizen.Multimedia.Remoting.MediaControlMetadata)"/>
87         </member>
88         <member name="M:Tizen.Multimedia.Remoting.MediaController.IsShuffleModeEnabled">
89             <summary>
90             Returns whether the shuffle mode is enabled.
91             </summary>
92             <returns>A value indicating whether the shuffle mode is enabled.</returns>
93             <exception cref="T:System.InvalidOperationException">
94                 The server has already been stopped.
95                 -or-\n
96                 An internal error occurs.
97             </exception>
98             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
99             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.SetShuffleModeEnabled(System.Boolean)"/>
100         </member>
101         <member name="M:Tizen.Multimedia.Remoting.MediaController.GetRepeatMode">
102             <summary>
103             Returns the repeat mode.
104             </summary>
105             <returns>A <see cref="T:Tizen.Multimedia.Remoting.MediaControlRepeatMode"/> set by the server.</returns>
106             <exception cref="T:System.InvalidOperationException">
107                 The server has already been stopped.
108                 -or-\n
109                 An internal error occurs.
110             </exception>
111             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
112             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.SetRepeatMode(Tizen.Multimedia.Remoting.MediaControlRepeatMode)"/>
113         </member>
114         <member name="M:Tizen.Multimedia.Remoting.MediaController.SendPlaybackCommand(Tizen.Multimedia.Remoting.MediaControlPlaybackCommand)">
115             <summary>
116             Sends playback command to the server.</summary>
117             <param name="command">A playback command.</param>
118             <exception cref="T:System.InvalidOperationException">
119                 The server has already been stopped.
120                 -or-\n
121                 An internal error occurs.
122             </exception>
123             <exception cref="T:System.ArgumentException"><paramref name="command"/> is not valid.</exception>
124             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> has already been disposed of.</exception>
125             <seealso cref="E:Tizen.Multimedia.Remoting.MediaControlServer.PlaybackCommandReceived"/>
126         </member>
127         <member name="T:Tizen.Multimedia.Remoting.MediaControllerManager">
128             <summary>
129             Provides a means to retrieve active controllers and observe controllers added and removed.
130             </summary>
131         </member>
132         <member name="M:Tizen.Multimedia.Remoting.MediaControllerManager.#ctor">
133             <summary>
134             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/> class.
135             </summary>
136             <privilege>http://tizen.org/privilege/mediacontroller.client</privilege>
137             <exception cref="T:System.InvalidOperationException">An internal error occurs.</exception>
138             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required privilege.</exception>
139         </member>
140         <member name="M:Tizen.Multimedia.Remoting.MediaControllerManager.Dispose">
141             <summary>
142             Releases all resources used by the <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/>.
143             </summary>
144         </member>
145         <member name="M:Tizen.Multimedia.Remoting.MediaControllerManager.Dispose(System.Boolean)">
146             <summary>
147             Releases the unmanaged resources used by the <see cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/>.
148             </summary>
149             <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
150         </member>
151         <member name="M:Tizen.Multimedia.Remoting.MediaControllerManager.GetActiveControllers">
152             <summary>
153             Gets the active controllers.
154             </summary>
155             <returns>An array of <see cref="T:Tizen.Multimedia.Remoting.MediaController"/>.</returns>
156         </member>
157         <member name="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStarted">
158             <summary>
159             Occurs when a server is started.
160             </summary>
161         </member>
162         <member name="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStopped">
163             <summary>
164             Occurs when a server is stopped.
165             </summary>
166         </member>
167         <member name="T:Tizen.Multimedia.Remoting.MediaControlMetadata">
168             <summary>
169             Represents metadata for media control.
170             </summary>
171         </member>
172         <member name="M:Tizen.Multimedia.Remoting.MediaControlMetadata.#ctor">
173             <summary>
174             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.MediaControlMetadata"/> class.
175             </summary>
176         </member>
177         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Title">
178             <summary>
179             Gets or sets the title.
180             </summary>
181         </member>
182         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Artist">
183             <summary>
184             Gets or sets the artist.
185             </summary>
186         </member>
187         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Album">
188             <summary>
189             Gets or sets the album.
190             </summary>
191         </member>
192         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Author">
193             <summary>
194             Gets or sets the author.
195             </summary>
196         </member>
197         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Genre">
198             <summary>
199             Gets or sets the genre.
200             </summary>
201         </member>
202         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Duration">
203             <summary>
204             Gets or sets the duration.
205             </summary>
206         </member>
207         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Date">
208             <summary>
209             Gets or sets the date.
210             </summary>
211         </member>
212         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Copyright">
213             <summary>
214             Gets or sets the copyright.
215             </summary>
216         </member>
217         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.Description">
218             <summary>
219             Gets or sets the description.
220             </summary>
221         </member>
222         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.TrackNumber">
223             <summary>
224             Gets or sets the track number.
225             </summary>
226         </member>
227         <member name="P:Tizen.Multimedia.Remoting.MediaControlMetadata.AlbumArtPath">
228             <summary>
229             Gets or sets the path of the album art.
230             </summary>
231         </member>
232         <member name="T:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand">
233             <summary>
234             Specifies playback commands.
235             </summary>
236         </member>
237         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Play">
238             <summary>
239             Play.
240             </summary>
241         </member>
242         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Pause">
243             <summary>
244             Pause.
245             </summary>
246         </member>
247         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Stop">
248             <summary>
249             Stop.
250             </summary>
251         </member>
252         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Next">
253             <summary>
254             Skip to next.
255             </summary>
256         </member>
257         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Previous">
258             <summary>
259             Skip to previous.
260             </summary>
261         </member>
262         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.FastForward">
263             <summary>
264             Fast forward.
265             </summary>
266         </member>
267         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand.Rewind">
268             <summary>
269             Rewind.
270             </summary>
271         </member>
272         <member name="T:Tizen.Multimedia.Remoting.MediaControlPlaybackState">
273             <summary>
274             Specifies playback states.
275             </summary>
276         </member>
277         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.None">
278             <summary>
279             Unknown; no state is set.
280             </summary>
281         </member>
282         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.Playing">
283             <summary>
284             Playing.
285             </summary>
286         </member>
287         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.Paused">
288             <summary>
289             Paused.
290             </summary>
291         </member>
292         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.Stopped">
293             <summary>
294             Stopped.
295             </summary>
296         </member>
297         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.FastForwarding">
298             <summary>
299             Fast forwarding.
300             </summary>
301         </member>
302         <member name="F:Tizen.Multimedia.Remoting.MediaControlPlaybackState.Rewinding">
303             <summary>
304             Rewinding.
305             </summary>
306         </member>
307         <member name="T:Tizen.Multimedia.Remoting.MediaControlServer">
308             <summary>
309             Provides a means to set playback information and metadata and receive commands from clients.
310             </summary>
311             <seealso cref="T:Tizen.Multimedia.Remoting.MediaControllerManager"/>
312             <seealso cref="T:Tizen.Multimedia.Remoting.MediaController"/>
313         </member>
314         <member name="P:Tizen.Multimedia.Remoting.MediaControlServer.IsRunning">
315             <summary>
316             Gets a value indicating whether the server is running.
317             </summary>
318             <value>true if the server has started; otherwise, false.</value>
319             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.Start"/>
320             <seealso cref="M:Tizen.Multimedia.Remoting.MediaControlServer.Stop"/>
321         </member>
322         <member name="M:Tizen.Multimedia.Remoting.MediaControlServer.Start">
323             <summary>
324             Starts the media control server.
325             </summary>
326             <remarks>
327             When the server starts, <see cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStarted"/> will be raised.
328             </remarks>
329             <privilege>http://tizen.org/privilege/mediacontroller.server</privilege>
330             <exception cref="T:System.InvalidOperationException">
331                 The server has already started.\n
332                 -or-\n
333                 An internal error occurs.
334             </exception>
335             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required privilege.</exception>
336             <seealso cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStarted"/>
337         </member>
338         <member name="M:Tizen.Multimedia.Remoting.MediaControlServer.Stop">
339             <summary>
340             Stops the media control server.
341             </summary>
342             <remarks>
343             When the server stops, <see cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStopped"/> will be raised.
344             </remarks>
345             <exception cref="T:System.InvalidOperationException">
346                 The server is not running .\n
347                 -or-\n
348                 An internal error occurs.
349             </exception>
350             <seealso cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStopped"/>
351         </member>
352         <member name="M:Tizen.Multimedia.Remoting.MediaControlServer.SetPlaybackState(Tizen.Multimedia.Remoting.MediaControlPlaybackState,System.Int64)">
353             <summary>
354             Updates playback state and playback position.</summary>
355             <param name="state">The playback state.</param>
356             <param name="position">The playback position in milliseconds.</param>
357             <exception cref="T:System.ArgumentException"><paramref name="state"/> is not valid.</exception>
358             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="position"/> is less than zero.</exception>
359             <exception cref="T:System.InvalidOperationException">
360                 The server is not running .\n
361                 -or-\n
362                 An internal error occurs.
363             </exception>
364         </member>
365         <member name="M:Tizen.Multimedia.Remoting.MediaControlServer.SetMetadata(Tizen.Multimedia.Remoting.MediaControlMetadata)">
366             <summary>
367             Updates metadata information.
368             </summary>
369             <param name="metadata">The metadata to update.</param>
370             <exception cref="T:System.ArgumentNullException"><paramref name="metadata"/> is null.</exception>
371             <exception cref="T:System.InvalidOperationException">
372                 The server is not running .\n
373                 -or-\n
374                 An internal error occurs.
375             </exception>
376         </member>
377         <member name="M:Tizen.Multimedia.Remoting.MediaControlServer.SetShuffleModeEnabled(System.Boolean)">
378             <summary>
379             Updates the shuffle mode.
380             </summary>
381             <param name="enabled">A value indicating whether the shuffle mode is enabled.</param>
382             <exception cref="T:System.InvalidOperationException">
383                 The server is not running .\n
384                 -or-\n
385                 An internal error occurs.
386             </exception>
387         </member>
388         <!-- Badly formed XML comment ignored for member "M:Tizen.Multimedia.Remoting.MediaControlServer.SetRepeatMode(Tizen.Multimedia.Remoting.MediaControlRepeatMode)" -->
389         <member name="E:Tizen.Multimedia.Remoting.MediaControlServer.PlaybackCommandReceived">
390             <summary>
391             Occurs when a client sends playback command.
392             </summary>
393         </member>
394         <member name="T:Tizen.Multimedia.Remoting.MediaControlServerStartedEventArgs">
395             <summary>
396             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStarted"/> event.
397             </summary>
398         </member>
399         <member name="M:Tizen.Multimedia.Remoting.MediaControlServerStartedEventArgs.#ctor(Tizen.Multimedia.Remoting.MediaController)">
400             <summary>
401             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.MediaControlServerStartedEventArgs"/> class.
402             </summary>
403             <param name="mediaController">A <see cref="T:Tizen.Multimedia.Remoting.MediaController"/> of the server.</param>
404             <exception cref="T:System.ArgumentNullException"><paramref name="mediaController"/> is null.</exception>
405         </member>
406         <member name="P:Tizen.Multimedia.Remoting.MediaControlServerStartedEventArgs.Controller">
407             <summary>
408             Gets the controller of the server added.
409             </summary>
410             <value>A <see cref="T:Tizen.Multimedia.Remoting.MediaController"/>.</value>
411         </member>
412         <member name="T:Tizen.Multimedia.Remoting.MediaControlServerStoppedEventArgs">
413             <summary>
414             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaControllerManager.ServerStopped"/> event.
415             </summary>
416         </member>
417         <member name="M:Tizen.Multimedia.Remoting.MediaControlServerStoppedEventArgs.#ctor(System.String)">
418             <summary>
419             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.MediaControlServerStoppedEventArgs"/> class.
420             </summary>
421             <param name="serverAppId">The application id of the server stopped.</param>
422             <exception cref="T:System.ArgumentNullException"><paramref name="serverAppId"/> is null.</exception>
423         </member>
424         <member name="P:Tizen.Multimedia.Remoting.MediaControlServerStoppedEventArgs.ServerAppId">
425             <summary>
426             Gets the application id of the server.
427             </summary>
428             <value>A string represents the application id.</value>
429         </member>
430         <member name="T:Tizen.Multimedia.Remoting.MetadataUpdatedEventArgs">
431             <summary>
432             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaController.MetadataUpdated"/> event.
433             </summary>
434         </member>
435         <member name="M:Tizen.Multimedia.Remoting.MetadataUpdatedEventArgs.#ctor(Tizen.Multimedia.Remoting.MediaControlMetadata)">
436             <summary>
437             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.MetadataUpdatedEventArgs"/> class.
438             </summary>
439             <param name="metadata">The updated <see cref="T:Tizen.Multimedia.Remoting.MediaControlMetadata"/>.</param>
440         </member>
441         <member name="P:Tizen.Multimedia.Remoting.MetadataUpdatedEventArgs.Metadata">
442             <summary>
443             Gets the metadata.
444             </summary>
445             <value>The updated <see cref="T:Tizen.Multimedia.Remoting.MediaControlMetadata"/>.</value>
446         </member>
447         <member name="T:Tizen.Multimedia.Remoting.PlaybackCommandReceivedEventArgs">
448             <summary>
449             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaControlServer.PlaybackCommandReceived"/> event.
450             </summary>
451         </member>
452         <member name="M:Tizen.Multimedia.Remoting.PlaybackCommandReceivedEventArgs.#ctor(System.String,Tizen.Multimedia.Remoting.MediaControlPlaybackCommand)">
453             <summary>
454             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.PlaybackCommandReceivedEventArgs"/> class.
455             </summary>
456             <param name="clientAppId">The client application id.</param>
457             <param name="command">The playback command.</param>
458             <exception cref="T:System.ArgumentNullException"><paramref name="clientAppId"/> is null.</exception>
459             <exception cref="T:System.ArgumentException"><paramref name="command"/> is invalid.</exception>
460         </member>
461         <member name="P:Tizen.Multimedia.Remoting.PlaybackCommandReceivedEventArgs.ClientAppId">
462             <summary>
463             Gets the application id of the client that sent command.
464             </summary>
465             <value>The client application id.</value>
466         </member>
467         <member name="P:Tizen.Multimedia.Remoting.PlaybackCommandReceivedEventArgs.Command">
468             <summary>
469             Gets the command.
470             </summary>
471             <value>The <see cref="T:Tizen.Multimedia.Remoting.MediaControlPlaybackCommand"/>.</value>
472         </member>
473         <member name="T:Tizen.Multimedia.Remoting.PlaybackStateUpdatedEventArgs">
474             <summary>
475             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaController.PlaybackStateUpdated"/> event.
476             </summary>
477         </member>
478         <member name="M:Tizen.Multimedia.Remoting.PlaybackStateUpdatedEventArgs.#ctor(Tizen.Multimedia.Remoting.MediaControlPlaybackState,System.Int64)">
479             <summary>
480             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.PlaybackStateUpdatedEventArgs"/> class.
481             </summary>
482             <param name="state">The playback state.</param>
483             <param name="position">The playback position in milliseconds.</param>
484             <exception cref="T:System.ArgumentException"><paramref name="state"/> is invalid.</exception>
485             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="position"/> is less than zero.</exception>
486         </member>
487         <member name="P:Tizen.Multimedia.Remoting.PlaybackStateUpdatedEventArgs.State">
488             <summary>
489             Gets the playback state.
490             </summary>
491         </member>
492         <member name="P:Tizen.Multimedia.Remoting.PlaybackStateUpdatedEventArgs.Position">
493             <summary>
494             Gets the playback position in milliseconds.
495             </summary>
496         </member>
497         <member name="T:Tizen.Multimedia.Remoting.RepeatModeUpdatedEventArgs">
498             <summary>
499             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaController.RepeatModeUpdated"/> event.
500             </summary>
501         </member>
502         <!-- Badly formed XML comment ignored for member "M:Tizen.Multimedia.Remoting.RepeatModeUpdatedEventArgs.#ctor(Tizen.Multimedia.Remoting.MediaControlRepeatMode)" -->
503         <member name="P:Tizen.Multimedia.Remoting.RepeatModeUpdatedEventArgs.RepeatMode">
504             <summary>
505             Gets the updated repeat mode.
506             </summary>
507             <value>The <see cref="T:Tizen.Multimedia.Remoting.MediaControlRepeatMode"/>.</value>
508         </member>
509         <member name="T:Tizen.Multimedia.Remoting.ShuffleModeUpdatedEventArgs">
510             <summary>
511             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.MediaController.ShuffleModeUpdated"/> event.
512             </summary>
513         </member>
514         <member name="M:Tizen.Multimedia.Remoting.ShuffleModeUpdatedEventArgs.#ctor(System.Boolean)">
515             <summary>
516             Initializes a new instance of the <see cref="T:Tizen.Multimedia.Remoting.ShuffleModeUpdatedEventArgs"/> class.
517             </summary>
518             <param name="enabled">A value indicating whether the shuffle mode is enabled.</param>
519         </member>
520         <member name="P:Tizen.Multimedia.Remoting.ShuffleModeUpdatedEventArgs.Enabled">
521             <summary>
522             Gets a value indicating whether the shuffle mode is enabled.
523             </summary>
524             <value>true if the shuffle mode is enabled; otherwise, false.</value>
525         </member>
526         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringStateChangedEventArgs">
527             <summary>
528             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.ScreenMirroring.StateChanged"/> event.
529             </summary>
530         </member>
531         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringStateChangedEventArgs.State">
532             <summary>
533             Gets the current state of screen mirroring.
534             </summary>
535         </member>
536         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringErrorOccurredEventArgs">
537             <summary>
538             Provides data for the <see cref="E:Tizen.Multimedia.Remoting.ScreenMirroring.ErrorOccurred"/> event.
539             </summary>
540         </member>
541         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringErrorOccurredEventArgs.Error">
542             <summary>
543             Gets the error that occurred.
544             </summary>
545         </member>
546         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroring">
547             <summary>
548             Provides the ability to connect to and disconnect from a screen mirroring source,
549             start, pause, and resume the screen mirroring as a sink.
550             </summary>
551         </member>
552         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.#ctor">
553             <summary>
554             Initializes a new instance of the ScreenMirroring class.
555             </summary>
556             <feature>http://tizen.org/feature/network.wifi.direct.display</feature>
557             <exception cref="T:System.NotSupportedException">The feature is not supported.</exception>
558         </member>
559         <member name="E:Tizen.Multimedia.Remoting.ScreenMirroring.StateChanged">
560             <summary>
561             Occurs when the state is changed.
562             </summary>
563         </member>
564         <member name="E:Tizen.Multimedia.Remoting.ScreenMirroring.ErrorOccurred">
565             <summary>
566             Occurs when an error occurs.
567             </summary>
568         </member>
569         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroring.AudioInfo">
570             <summary>
571             Gets the negotiated audio info.
572             </summary>
573         </member>
574         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroring.VideoInfo">
575             <summary>
576             Gets the negotiated video info.
577             </summary>
578         </member>
579         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.Prepare(Tizen.Multimedia.Display)">
580             <summary>
581             Prepares the screen mirroring with the specified display.
582             </summary>
583             <remarks>
584             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Idle"/>.\n
585             \n
586             All supported resolutions will be candidates.
587             </remarks>
588             <param name="display">The display where the mirroring will be played on.</param>
589             <exception cref="T:System.ArgumentException">
590                <paramref name="display"/> has already been assigned to another.
591             </exception>
592             <exception cref="T:System.ArgumentNullException"><paramref name="display"/> is null.</exception>
593             <exception cref="T:System.InvalidOperationException">
594                 The current state is not in the valid.\n
595                 -or-\n
596                 An internal error occurs.
597             </exception>
598             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
599         </member>
600         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.Prepare(Tizen.Multimedia.Display,Tizen.Multimedia.Remoting.ScreenMirroringResolutions)">
601             <summary>
602             Prepares the screen mirroring with the specified display and resolutions.
603             </summary>
604             <remarks>
605             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Idle"/>.
606             </remarks>
607             <param name="display">The display where the mirroring will be played on.</param>
608             <param name="resolutions">The desired resolutions.</param>
609             <exception cref="T:System.ArgumentException">
610                <paramref name="resolutions"/> contain invalid flags.\n
611                -or-\n
612                <paramref name="display"/> has already been assigned to another.
613             </exception>
614             <exception cref="T:System.ArgumentNullException"><paramref name="display"/> is null.</exception>
615             <exception cref="T:System.InvalidOperationException">
616                 The current state is not in the valid.\n
617                 -or-\n
618                 An internal error occurs.
619             </exception>
620             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
621         </member>
622         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.ConnectAsync(System.String)">
623             <summary>
624             Creates the connection and ready for receiving data from a mirroring source.
625             </summary>
626             <param name="sourceIp">The source ip address to connect.</param>
627             <remarks>
628             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Prepared"/> state by
629             <see cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.Prepare(Tizen.Multimedia.Display,Tizen.Multimedia.Remoting.ScreenMirroringResolutions)"/>.
630             </remarks>
631             <returns>A task that represents the asynchronous operation.</returns>
632             <privilege>http://tizen.org/privilege/internet</privilege>
633             <exception cref="T:System.ArgumentNullException"><paramref name="sourceIp"/> is null.</exception>
634             <exception cref="T:System.InvalidOperationException">
635                 The current state is not in the valid.\n
636                 -or-\n
637                 An internal error occurs.
638             </exception>
639             <exception cref="T:System.ArgumentException"><paramref name="sourceIp"/> is a zero-length string, contains only white space.</exception>
640             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
641             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required permission.</exception>
642         </member>
643         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.StartAsync">
644             <summary>
645             Starts mirroring from the source.
646             </summary>
647             <remarks>
648             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Connected"/> state by
649             <see cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.ConnectAsync(System.String)"/>.
650             </remarks>
651             <returns>A task that represents the asynchronous operation.</returns>
652             <privilege>http://tizen.org/privilege/internet</privilege>
653             <exception cref="T:System.InvalidOperationException">
654                 The current state is not in the valid.\n
655                 -or-\n
656                 An internal error occurs.
657             </exception>
658             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
659             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required permission.</exception>
660         </member>
661         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.PauseAsync">
662             <summary>
663             Pauses mirroring from the source.
664             </summary>
665             <remarks>
666             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Playing"/> state by
667             <see cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.StartAsync"/>.
668             </remarks>
669             <returns>A task that represents the asynchronous operation.</returns>
670             <privilege>http://tizen.org/privilege/internet</privilege>
671             <exception cref="T:System.InvalidOperationException">
672                 The current state is not in the valid.\n
673                 -or-\n
674                 An internal error occurs.
675             </exception>
676             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
677             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required permission.</exception>
678         </member>
679         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.ResumeAsync">
680             <summary>
681             Resumes mirroring from the source.
682             </summary>
683             <remarks>
684             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Paused"/> state by
685             <see cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.PauseAsync"/>.
686             </remarks>
687             <returns>A task that represents the asynchronous operation.</returns>
688             <privilege>http://tizen.org/privilege/internet</privilege>
689             <exception cref="T:System.InvalidOperationException">
690                 The current state is not in the valid.\n
691                 -or-\n
692                 An internal error occurs.
693             </exception>
694             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
695             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required permission.</exception>
696         </member>
697         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.Disconnect">
698             <summary>
699             Disconnects from the source.
700             </summary>
701             <remarks>
702             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Connected"/>,
703             <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Playing"/> or <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Paused"/>.
704             </remarks>
705             <privilege>http://tizen.org/privilege/internet</privilege>
706             <exception cref="T:System.InvalidOperationException">
707                 The current state is not in the valid.\n
708                 -or-\n
709                 An internal error occurs.
710             </exception>
711             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
712             <exception cref="T:System.UnauthorizedAccessException">Caller does not have required permission.</exception>
713         </member>
714         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.Unprepare">
715             <summary>
716             Unprepares the screen mirroring.
717             </summary>
718             <remarks>
719             The state must be <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Prepared"/>,
720             or <see cref="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Disconnected"/>.
721             </remarks>
722             <exception cref="T:System.InvalidOperationException">
723                 The current state is not in the valid.\n
724                 -or-\n
725                 An internal error occurs.
726             </exception>
727             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
728         </member>
729         <!-- Badly formed XML comment ignored for member "M:Tizen.Multimedia.Remoting.ScreenMirroring.Dispose" -->
730         <member name="M:Tizen.Multimedia.Remoting.ScreenMirroring.Dispose(System.Boolean)">
731             <summary>
732             Releases the resources used by the ScreenMirroring.
733             </summary>
734             <param name="disposing">
735             true to release both managed and unmanaged resources; false to release only unmanaged resources.
736             </param>
737         </member>
738         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo">
739             <summary>
740             Provides a means to retrieve the audio information which is negotiated with the source device.
741             </summary>
742             <seealso cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>
743         </member>
744         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo.Codec">
745             <summary>
746             Gets the negotiated audio codec.
747             </summary>
748             <exception cref="T:System.InvalidOperationException">
749                 Not connected to a source.\n
750                 \n
751                 An internal error occurs.
752             </exception>
753             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
754         </member>
755         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo.Channels">
756             <summary>
757             Gets the negotiated audio channels.
758             </summary>
759             <exception cref="T:System.InvalidOperationException">
760                 Not connected to a source.\n
761                 \n
762                 An internal error occurs.
763             </exception>
764             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
765         </member>
766         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo.SampleRate">
767             <summary>
768             Gets the negotiated audio sample rate.
769             </summary>
770             <exception cref="T:System.InvalidOperationException">
771                 Not connected to a source.\n
772                 \n
773                 An internal error occurs.
774             </exception>
775             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
776         </member>
777         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo.BitWidth">
778             <summary>
779             Gets the negotiated audio bit width.
780             </summary>
781             <exception cref="T:System.InvalidOperationException">
782                 Not connected to a source.\n
783                 \n
784                 An internal error occurs.
785             </exception>
786             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
787         </member>
788         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringAudioCodec">
789             <summary>
790             Specifies audio codecs for <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>.
791             </summary>
792             <seealso cref="T:Tizen.Multimedia.Remoting.ScreenMirroringAudioInfo"/>
793         </member>
794         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringAudioCodec.None">
795             <summary>
796             Screen mirroring is not negotiated yet.
797             </summary>
798         </member>
799         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringAudioCodec.Aac">
800             <summary>
801             AAC codec for audio.
802             </summary>
803         </member>
804         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringAudioCodec.Ac3">
805             <summary>
806             AC3 codec for audio.
807             </summary>
808         </member>
809         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringAudioCodec.Lpcm">
810             <summary>
811             LPCM codec for audio.
812             </summary>
813         </member>
814         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringVideoCodec">
815             <summary>
816             Specifies video codecs for <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>.
817             </summary>
818             <seealso cref="T:Tizen.Multimedia.Remoting.ScreenMirroringVideoInfo"/>
819         </member>
820         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringVideoCodec.None">
821             <summary>
822             Screen mirroring is not negotiated yet.
823             </summary>
824         </member>
825         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringVideoCodec.H264">
826             <summary>
827             H.264 codec for video.
828             </summary>
829         </member>
830         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringResolutions">
831             <summary>
832             Specifies available combinations of resolutions and fps for <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>.
833             </summary>
834         </member>
835         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R1920x1080P30">
836             <summary>
837             W-1920, H-1080, 30 fps.
838             </summary>
839         </member>
840         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R1280x720P30">
841             <summary>
842             W-1280, H-720, 30 fps.
843             </summary>
844         </member>
845         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R960x540P30">
846             <summary>
847             W-960, H-540, 30 fps.
848             </summary>
849         </member>
850         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R864x480P30">
851             <summary>
852             W-864, H-480, 30 fps.
853             </summary>
854         </member>
855         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R720x480P60">
856             <summary>
857             W-720, H-480, 60 fps.
858             </summary>
859         </member>
860         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R640x480P60">
861             <summary>
862             W-640, H-480, 60 fps.
863             </summary>
864         </member>
865         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringResolutions.R640x360P30">
866             <summary>
867             W-640, H-360, 30 fps.
868             </summary>
869         </member>
870         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringState">
871             <summary>
872             Specifies the states of <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>.
873             </summary>
874         </member>
875         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Idle">
876             <summary>
877             Idle.
878             </summary>
879         </member>
880         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Prepared">
881             <summary>
882             Prepared.
883             </summary>
884             <seealso cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.Prepare(Tizen.Multimedia.Display,Tizen.Multimedia.Remoting.ScreenMirroringResolutions)"/>
885         </member>
886         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Connected">
887             <summary>
888             Connected to a source.
889             </summary>
890             <seealso cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.ConnectAsync(System.String)"/>
891         </member>
892         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Playing">
893             <summary>
894             Playing.
895             </summary>
896             <seealso cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.StartAsync"/>
897         </member>
898         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Paused">
899             <summary>
900             Paused while playing media.
901             </summary>
902             <seealso cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.PauseAsync"/>
903         </member>
904         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringState.Disconnected">
905             <summary>
906             Disconnected from source.
907             </summary>
908             <seealso cref="M:Tizen.Multimedia.Remoting.ScreenMirroring.Disconnect"/>
909         </member>
910         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringError">
911             <summary>
912             Specifies errors for <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/>.
913             </summary>
914         </member>
915         <member name="F:Tizen.Multimedia.Remoting.ScreenMirroringError.InvalidOperation">
916             <summary>
917             Invalid operation.
918             </summary>
919         </member>
920         <member name="T:Tizen.Multimedia.Remoting.ScreenMirroringVideoInfo">
921             <summary>
922             Provides a means to retrieve the video information which is negotiated with the source device.
923             </summary>
924         </member>
925         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringVideoInfo.Codec">
926             <summary>
927             Gets the negotiated video codec.
928             </summary>
929             <exception cref="T:System.InvalidOperationException">
930                 Not connected to a source.\n
931                 \n
932                 An internal error occurs.
933             </exception>
934             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
935         </member>
936         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringVideoInfo.Resolution">
937             <summary>
938             Gets the negotiated video resolution.
939             </summary>
940             <exception cref="T:System.InvalidOperationException">
941                 Not connected to a source.\n
942                 \n
943                 An internal error occurs.
944             </exception>
945             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
946         </member>
947         <member name="P:Tizen.Multimedia.Remoting.ScreenMirroringVideoInfo.FrameRate">
948             <summary>
949             Gets the negotiated video frame rate.
950             </summary>
951             <exception cref="T:System.InvalidOperationException">
952                 Not connected to a source.\n
953                 \n
954                 An internal error occurs.
955             </exception>
956             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.Remoting.ScreenMirroring"/> has already been disposed.</exception>
957         </member>
958     </members>
959 </doc>