[MediaController] Add new APIs for sending command and its callback (#396)
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Remoting / MediaController / PlaybackCommandReceivedEventArgs.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 using System;
18
19 namespace Tizen.Multimedia.Remoting
20 {
21     /// <summary>
22     /// Provides data for the <see cref="MediaControlServer.PlaybackCommandReceived"/> event.
23     /// </summary>
24     /// <since_tizen> 4 </since_tizen>
25     [Obsolete("Please do not use! This will be deprecated. Please use PlaybackActionCommandReceived instead.")]
26     public class PlaybackCommandReceivedEventArgs : EventArgs
27     {
28         /// <summary>
29         /// Initializes a new instance of the <see cref="PlaybackCommandReceivedEventArgs"/> class.
30         /// </summary>
31         /// <param name="clientAppId">The client application id.</param>
32         /// <param name="command">The playback command.</param>
33         /// <exception cref="ArgumentNullException"><paramref name="clientAppId"/> is null.</exception>
34         /// <exception cref="ArgumentException"><paramref name="command"/> is invalid.</exception>
35         /// <since_tizen> 4 </since_tizen>
36         public PlaybackCommandReceivedEventArgs(string clientAppId, MediaControlPlaybackCommand command)
37         {
38             if (clientAppId == null)
39             {
40                 throw new ArgumentNullException(nameof(clientAppId));
41             }
42
43             ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackCommand), command, nameof(command));
44
45             ClientAppId = clientAppId;
46             Command = command;
47         }
48
49         /// <summary>
50         /// Gets the application id of the client that sent command.
51         /// </summary>
52         /// <value>The client application id.</value>
53         /// <since_tizen> 4 </since_tizen>
54         public string ClientAppId { get; }
55
56         /// <summary>
57         /// Gets the command.
58         /// </summary>
59         /// <value>The <see cref="MediaControlPlaybackCommand"/>.</value>
60         /// <since_tizen> 4 </since_tizen>
61         public MediaControlPlaybackCommand Command { get; }
62     }
63 }