2 * Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using System.Collections.Generic;
19 using System.Threading.Tasks;
20 using Tizen.Applications;
21 using Native = Interop.MediaControllerServer;
23 namespace Tizen.Multimedia.Remoting
26 /// Provides a means to set playback information and metadata and receive commands from clients.
28 /// <seealso cref="MediaControllerManager"/>
29 /// <seealso cref="MediaController"/>
30 /// <since_tizen> 4 </since_tizen>
31 public static partial class MediaControlServer
33 private static IntPtr _handle = IntPtr.Zero;
34 private static bool? _isRunning;
37 /// Gets a value indicating whether the server is running.
39 /// <value>true if the server has started; otherwise, false.</value>
40 /// <seealso cref="Start"/>
41 /// <seealso cref="Stop"/>
42 /// <since_tizen> 4 </since_tizen>
43 public static bool IsRunning
47 if (_isRunning.HasValue == false)
49 _isRunning = GetRunningState();
52 return _isRunning.Value;
56 private static bool GetRunningState()
58 IntPtr handle = IntPtr.Zero;
61 Native.ConnectDb(out handle).ThrowIfError("Failed to retrieve the running state.");
63 Native.CheckServerExist(handle, Applications.Application.Current.ApplicationInfo.ApplicationId,
64 out var value).ThrowIfError("Failed to retrieve the running state.");
70 if (handle != IntPtr.Zero)
72 Native.DisconnectDb(handle);
77 private static void EnsureInitializedIfRunning()
79 if (_handle != IntPtr.Zero)
84 if (IsRunning == false)
86 throw new InvalidOperationException("The server is not running.");
92 private static IntPtr Handle
96 EnsureInitializedIfRunning();
102 private static void Initialize()
104 Native.Create(out _handle).ThrowIfError("Failed to create media controller server.");
108 RegisterPlaybackActionCommandReceivedEvent();
109 RegisterPlaybackPositionCommandReceivedEvent();
110 RegisterPlaylistCommandReceivedEvent();
111 RegisterShuffleModeCommandReceivedEvent();
112 RegisterRepeatModeCommandReceivedEvent();
113 RegisterCustomCommandReceivedEvent();
114 RegisterCommandCompletedEvent();
115 RegisterSearchCommandReceivedEvent();
121 Native.Destroy(_handle);
122 _playbackCommandCallback = null;
123 _handle = IntPtr.Zero;
129 /// Starts the media control server.
132 /// When the server starts, <see cref="MediaControllerManager.ServerStarted"/> will be raised.
134 /// <privilege>http://tizen.org/privilege/mediacontroller.server</privilege>
135 /// <exception cref="InvalidOperationException">An internal error occurs.</exception>
136 /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege.</exception>
137 /// <seealso cref="MediaControllerManager.ServerStarted"/>
138 /// <since_tizen> 4 </since_tizen>
139 public static void Start()
145 /// Stops the media control server.
148 /// When the server stops, <see cref="MediaControllerManager.ServerStopped"/> will be raised.
150 /// <exception cref="InvalidOperationException">
151 /// The server is not running .<br/>
153 /// An internal error occurs.
155 /// <seealso cref="MediaControllerManager.ServerStopped"/>
156 /// <since_tizen> 4 </since_tizen>
157 public static void Stop()
159 EnsureInitializedIfRunning();
161 Native.Destroy(_handle).ThrowIfError("Failed to stop the server.");
163 _handle = IntPtr.Zero;
164 _playbackCommandCallback = null;
169 /// Updates playback state and playback position.</summary>
170 /// <param name="state">The playback state.</param>
171 /// <param name="position">The playback position in milliseconds.</param>
172 /// <exception cref="ArgumentException"><paramref name="state"/> is not valid.</exception>
173 /// <exception cref="ArgumentOutOfRangeException"><paramref name="position"/> is less than zero.</exception>
174 /// <exception cref="InvalidOperationException">
175 /// The server is not running .<br/>
177 /// An internal error occurs.
179 /// <since_tizen> 4 </since_tizen>
180 public static void SetPlaybackState(MediaControlPlaybackState state, long position)
182 ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackState), state, nameof(state));
186 throw new ArgumentOutOfRangeException(nameof(position), position, "position can't be less than zero.");
189 Native.SetPlaybackState(Handle, state.ToNative()).ThrowIfError("Failed to set playback state.");
191 Native.SetPlaybackPosition(Handle, (ulong)position).ThrowIfError("Failed to set playback position.");
193 Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");
196 private static void SetMetadata(MediaControllerNativeAttribute attribute, string value)
198 Native.SetMetadata(Handle, attribute, value).ThrowIfError($"Failed to set metadata({attribute}).");
202 /// Updates metadata information.
204 /// <param name="metadata">The metadata to update.</param>
205 /// <exception cref="ArgumentNullException"><paramref name="metadata"/> is null.</exception>
206 /// <exception cref="InvalidOperationException">
207 /// The server is not running .<br/>
209 /// An internal error occurs.
211 /// <since_tizen> 4 </since_tizen>
212 public static void SetMetadata(MediaControlMetadata metadata)
214 if (metadata == null)
216 throw new ArgumentNullException(nameof(metadata));
219 SetMetadata(MediaControllerNativeAttribute.Title, metadata.Title);
220 SetMetadata(MediaControllerNativeAttribute.Artist, metadata.Artist);
221 SetMetadata(MediaControllerNativeAttribute.Album, metadata.Album);
222 SetMetadata(MediaControllerNativeAttribute.Author, metadata.Author);
223 SetMetadata(MediaControllerNativeAttribute.Genre, metadata.Genre);
224 SetMetadata(MediaControllerNativeAttribute.Duration, metadata.Duration);
225 SetMetadata(MediaControllerNativeAttribute.Date, metadata.Date);
226 SetMetadata(MediaControllerNativeAttribute.Copyright, metadata.Copyright);
227 SetMetadata(MediaControllerNativeAttribute.Description, metadata.Description);
228 SetMetadata(MediaControllerNativeAttribute.TrackNumber, metadata.TrackNumber);
229 SetMetadata(MediaControllerNativeAttribute.Picture, metadata.AlbumArtPath);
231 Native.UpdateMetadata(Handle).ThrowIfError("Failed to set metadata.");
235 /// Updates the shuffle mode.
237 /// <param name="enabled">A value indicating whether the shuffle mode is enabled.</param>
238 /// <exception cref="InvalidOperationException">
239 /// The server is not running .<br/>
241 /// An internal error occurs.
243 /// <since_tizen> 4 </since_tizen>
244 public static void SetShuffleModeEnabled(bool enabled)
246 Native.UpdateShuffleMode(Handle, enabled ? MediaControllerNativeShuffleMode.On : MediaControllerNativeShuffleMode.Off).
247 ThrowIfError("Failed to set shuffle mode.");
251 /// Updates the repeat mode.
253 /// <param name="mode">A value indicating the repeat mode.</param>
254 /// <exception cref="InvalidOperationException">
255 /// The server is not running .<br/>
257 /// An internal error occurs.
259 /// <exception cref="ArgumentException"><paramref name="mode"/> is invalid.</exception>
260 /// <since_tizen> 4 </since_tizen>
261 public static void SetRepeatMode(MediaControlRepeatMode mode)
263 ValidationUtil.ValidateEnum(typeof(MediaControlRepeatMode), mode, nameof(mode));
265 Native.UpdateRepeatMode(Handle, mode.ToNative()).ThrowIfError("Failed to set repeat mode.");
269 /// Sets the index of current playing media.
271 /// <param name="index">The index of current playing media.</param>
272 /// <exception cref="ArgumentNullException"><paramref name="index"/> is null.</exception>
273 /// <exception cref="InvalidOperationException">
274 /// The server is not running .<br/>
276 /// An internal error occurs.
278 /// <since_tizen> 5 </since_tizen>
279 [Obsolete("Please do not use! This will be deprecated. Please use SetInfoOfCurrentPlayingMedia instead.")]
280 public static void SetIndexOfCurrentPlayingMedia(string index)
284 throw new ArgumentNullException(nameof(index));
287 Native.SetIndexOfCurrentPlayingMedia(Handle, index)
288 .ThrowIfError("Failed to set the index of current playing media");
290 Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");
294 /// Sets the playlist name and index of current playing media.
296 /// <param name="playlistName">The playlist name of current playing media.</param>
297 /// <param name="index">The index of current playing media.</param>
298 /// <exception cref="ArgumentNullException">
299 /// <paramref name="playlistName"/> or <paramref name="index"/> is null.
301 /// <exception cref="InvalidOperationException">
302 /// The server is not running .<br/>
304 /// An internal error occurs.
306 /// <since_tizen> 5 </since_tizen>
307 public static void SetInfoOfCurrentPlayingMedia(string playlistName, string index)
309 if (playlistName == null)
311 throw new ArgumentNullException(nameof(playlistName));
315 throw new ArgumentNullException(nameof(index));
318 Native.SetInfoOfCurrentPlayingMedia(Handle, playlistName, index)
319 .ThrowIfError("Failed to set the playlist name and index of current playing media");
321 Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");
327 /// <param name="playlist">The name of playlist.</param>
328 /// <exception cref="ArgumentNullException"><paramref name="playlist"/> is null.</exception>
329 /// <exception cref="InvalidOperationException">
330 /// The server is not running .<br/>
332 /// An internal error occurs.
334 /// <since_tizen> 5 </since_tizen>
335 public static void RemovePlaylist(MediaControlPlaylist playlist)
337 if (playlist == null)
339 throw new ArgumentNullException(nameof(playlist));
342 Native.DeletePlaylist(Handle, playlist.Handle);
346 // Saves the playlist to the persistent storage.
347 internal static void SavePlaylist(IntPtr playlistHandle)
349 Native.SavePlaylist(Handle, playlistHandle).ThrowIfError("Failed to save playlist");
352 // Gets the playlist handle by name.
353 internal static IntPtr GetPlaylistHandle(string name)
355 Native.GetPlaylistHandle(Handle, name, out IntPtr playlistHandle)
356 .ThrowIfError("Failed to get playlist handle by name");
358 return playlistHandle;
362 /// Gets the active clients.
364 /// <exception cref="InvalidOperationException">
365 /// The server is not running .<br/>
367 /// An internal error occurs.
369 /// <returns>the activated client ids.</returns>
370 /// <since_tizen> 5 </since_tizen>
371 public static IEnumerable<string> GetActivatedClients()
373 var clientIds = new List<string>();
375 Native.ActivatedClientCallback activatedClientCallback = (name, _) =>
381 Native.ForeachActivatedClient(Handle, activatedClientCallback).
382 ThrowIfError("Failed to get activated client.");
384 return clientIds.AsReadOnly();
388 /// Requests commands to the client.
391 /// The client can request the command to execute <see cref="Command"/>, <br/>
392 /// and then, the server receive the result of each request(command).
394 /// <param name="command">A <see cref="Command"/> class.</param>
395 /// <param name="clientId">The client Id to send command.</param>
396 /// <returns><see cref="Bundle"/> represents the extra data from client and it can be null.</returns>
397 /// <exception cref="ArgumentNullException">
398 /// <paramref name="command"/> or <paramref name="clientId"/> is null.
400 /// <exception cref="InvalidOperationException">
401 /// The server has already been stopped.<br/>
403 /// An internal error occurs.
405 /// <since_tizen> 5 </since_tizen>
406 public static async Task<Bundle> RequestAsync(Command command, string clientId)
410 throw new ArgumentNullException(nameof(command));
412 if (clientId == null)
414 throw new ArgumentNullException(nameof(clientId));
417 command.SetRequestInformation(clientId);
419 var tcs = new TaskCompletionSource<MediaControllerError>();
420 string reqeustId = null;
421 Bundle bundle = null;
423 EventHandler<CommandCompletedEventArgs> eventHandler = (s, e) =>
425 if (e.RequestId == reqeustId)
428 tcs.TrySetResult(e.Result);
434 CommandCompleted += eventHandler;
436 reqeustId = command.Request(Handle);
438 (await tcs.Task).ThrowIfError("Failed to request event.");
444 CommandCompleted -= eventHandler;
449 /// Sends the result of each command.
451 /// <param name="command">The command that return to client.</param>
452 /// <param name="result">The result of <paramref name="command"/>.</param>
453 /// <param name="bundle">The extra data.</param>
454 /// <exception cref="ArgumentNullException"><paramref name="command"/> is null.</exception>
455 /// <exception cref="InvalidOperationException">
456 /// The server is not running .<br/>
458 /// An internal error occurs.
460 /// <since_tizen> 5 </since_tizen>
461 public static void Response(Command command, int result, Bundle bundle)
465 throw new ArgumentNullException(nameof(command));
468 command.Response(Handle, result, bundle);
472 /// Sends the result of each command.
474 /// <param name="command">The command that return to client.</param>
475 /// <param name="result">The result of <paramref name="command"/>.</param>
476 /// <exception cref="ArgumentNullException"><paramref name="command"/> is null.</exception>
477 /// <exception cref="InvalidOperationException">
478 /// The server is not running .<br/>
480 /// An internal error occurs.
482 /// <since_tizen> 5 </since_tizen>
483 public static void Response(Command command, int result)
487 throw new ArgumentNullException(nameof(command));
490 command.Response(Handle, result, null);
495 /// Sets the content type of latest played media.
497 /// <param name="type">A value indicating the content type of the latest played media.</param>
498 /// <exception cref="InvalidOperationException">
499 /// The server is not running .<br/>
501 /// An internal error occurs.
503 /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
504 /// <since_tizen> 5 </since_tizen>
505 public static void SetPlaybackContentType(MediaControlContentType type)
507 ValidationUtil.ValidateEnum(typeof(MediaControlContentType), type, nameof(type));
509 Native.SetPlaybackContentType(Handle, type).ThrowIfError("Failed to set playback content type.");
511 Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");
515 /// Sets the path of icon.
517 /// <param name="path">The path of icon.</param>
518 /// <exception cref="InvalidOperationException">
519 /// The server is not running .<br/>
521 /// An internal error occurs.
523 /// <exception cref="ArgumentNullException"><paramref name="path"/> is invalid.</exception>
524 /// <since_tizen> 5 </since_tizen>
525 public static void SetIconPath(string path)
529 throw new ArgumentNullException(nameof(path));
532 Native.SetIconPath(Handle, path).ThrowIfError("Failed to set uri path.");
536 /// Sets the capabilities by <see cref="MediaControlPlaybackCommand"/>.
538 /// <param name="capabilities">The set of <see cref="MediaControlPlaybackCommand"/> and <see cref="MediaControlCapabilitySupport"/>.</param>
539 /// <exception cref="InvalidOperationException">
540 /// The server is not running .<br/>
542 /// An internal error occurs.
544 /// <exception cref="ArgumentException"><paramref name="capabilities"/> is invalid.</exception>
545 /// <since_tizen> 5 </since_tizen>
546 public static void SetPlaybackCapabilities(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities)
548 foreach (var pair in capabilities)
550 ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackCommand), pair.Key, nameof(pair.Key));
551 ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), pair.Value, nameof(pair.Value));
553 SetPlaybackCapability(pair.Key, pair.Value);
554 Native.SetPlaybackCapability(Handle, pair.Key.ToNative(), pair.Value).
555 ThrowIfError("Failed to set playback capability.");
558 Native.SaveAndNotifyPlaybackCapabilityUpdated(Handle).ThrowIfError("Failed to update playback capability.");
562 /// Sets the capabilities by <see cref="MediaControlPlaybackCommand"/>.
564 /// <param name="action">A playback command.</param>
565 /// <param name="support">A value indicating whether the <paramref name="action"/> is supported or not.</param>
566 /// <exception cref="InvalidOperationException">
567 /// The server is not running .<br/>
569 /// An internal error occurs.
571 /// <exception cref="ArgumentException"><paramref name="action"/> or <paramref name="support"/> is invalid.</exception>
572 /// <since_tizen> 5 </since_tizen>
573 public static void SetPlaybackCapability(MediaControlPlaybackCommand action, MediaControlCapabilitySupport support)
575 ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackCommand), action, nameof(action));
576 ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
578 Native.SetPlaybackCapability(Handle, action.ToNative(), support).ThrowIfError("Failed to set playback capability.");
580 Native.SaveAndNotifyPlaybackCapabilityUpdated(Handle).ThrowIfError("Failed to update playback capability.");
584 /// Sets the <see cref="MediaControlCapabilitySupport"/> indicating shuffle mode is supported or not.
586 /// <param name="support">A value indicating whether the shuffle mode is supported or not.</param>
587 /// <exception cref="InvalidOperationException">
588 /// The server is not running .<br/>
590 /// An internal error occurs.
592 /// <exception cref="ArgumentException"><paramref name="support"/> is invalid.</exception>
593 /// <since_tizen> 5 </since_tizen>
594 public static void SetShuffleModeCapability(MediaControlCapabilitySupport support)
596 ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
598 Native.SetShuffleModeCapability(Handle, support).ThrowIfError("Failed to set shuffle mode capability.");
602 /// Sets the content type of latest played media.
604 /// <param name="support">A value indicating whether the <see cref="MediaControlRepeatMode"/> is supported or not.</param>
605 /// <exception cref="InvalidOperationException">
606 /// The server is not running .<br/>
608 /// An internal error occurs.
610 /// <exception cref="ArgumentException"><paramref name="support"/> is invalid.</exception>
611 /// <since_tizen> 5 </since_tizen>
612 public static void SetRepeatModeCapability(MediaControlCapabilitySupport support)
614 ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
616 Native.SetRepeatModeCapability(Handle, support).ThrowIfError("Failed to set shuffle mode capability.");
618 #endregion Capabilities
621 /// Sets the age rating of latest played media.
623 /// <param name="ageRating">
624 /// The Age rating of latest played media. The valid range is 0 to 19, inclusive.
625 /// Especially, 0 means that media is suitable for all ages.
627 /// <exception cref="ArgumentOutOfRangeException">The specified <paramref name="ageRating"/> is not valid.</exception>
628 /// <exception cref="InvalidOperationException">
629 /// The server is not running .<br/>
631 /// An internal error occurs.
633 /// <since_tizen> 5 </since_tizen>
634 public static void SetAgeRating(int ageRating)
636 if (ageRating < 0 || ageRating > 19)
638 throw new ArgumentOutOfRangeException(nameof(ageRating));
641 Native.SetAgeRating(Handle, ageRating).ThrowIfError("Failed to set age rating.");
643 Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");