src/Tizen.Multimedia/AudioManager/VolumeLevel.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
  20 {
  21     /// <summary>
  22     /// Provides a means to control volume levels.
  23     /// </summary>
  24     public class VolumeLevel
  25     {
  26         internal VolumeLevel()
  27         {
  28         }
  29
  30         /// <summary>
  31         /// Gets or sets the volume level of the specified <see cref="AudioVolumeType"/>
  32         /// </summary>
  33         /// <param name="type">The <see cref="AudioVolumeType"/> to control.</param>
  34         /// <value>The current volume level.</value>
  35         /// <remarks>To set volumes, the specified privilege is required.</remarks>
  36         /// <privilege>http://tizen.org/privilege/volume.set</privilege>
  37         /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
  38         /// <exception cref="ArgumentOutOfRangeException">
  39         ///     <paramref name="type"/> is <see cref="AudioVolumeType.None"/>.
  40         ///     -or-
  41         ///     <paramref name="value"/> is less than zero.
  42         ///     -or-
  43         ///     <paramref name="value"/> is greater than <see cref="MaxVolumeLevel.this[AudioVolumeType]"/>.
  44         /// </exception>
  45         /// <exception cref="UnauthorizedAccessException">The caller does not have required privilege to set volume.</exception>
  46         public int this[AudioVolumeType type]
  47         {
  48             get
  49             {
  50                 ValidationUtil.ValidateEnum(typeof(AudioVolumeType), type, nameof(type));
  51
  52                 if (type == AudioVolumeType.None)
  53                 {
  54                     throw new ArgumentOutOfRangeException(nameof(type),
  55                         "Cannot get volume level for AudioVolumeType.None");
  56                 }
  57
  58                 Interop.AudioVolume.GetVolume(type, out var volume).Validate("Failed to get the volume level");
  59
  60                 return volume;
  61             }
  62             set
  63             {
  64                 ValidationUtil.ValidateEnum(typeof(AudioVolumeType), type, nameof(value));
  65
  66                 if (type == AudioVolumeType.None)
  67                 {
  68                     throw new ArgumentOutOfRangeException(nameof(type),
  69                         "Cannot set volume level for AudioVolumeType.None");
  70                 }
  71
  72                 var ret = Interop.AudioVolume.SetVolume(type, value);
  73
  74                 if (ret == AudioManagerError.InvalidParameter)
  75                 {
  76                     throw new ArgumentOutOfRangeException(nameof(value), value,
  77                         $"valid volume level range is 0 <= x <= {nameof(MaxVolumeLevel)}[{nameof(AudioVolumeType)}]");
  78                 }
  79
  80                 ret.Validate("Failed to set the volume level");
  81             }
  82         }
  83     }
  84 }