src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.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 get max volume levels.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public class MaxVolumeLevel
  26     {
  27         internal MaxVolumeLevel()
  28         {
  29         }
  30
  31         /// <summary>
  32         /// Gets the max volume level of the specified <see cref="AudioVolumeType"/>.
  33         /// </summary>
  34         /// <param name="type">The <see cref="AudioVolumeType"/> to query.</param>
  35         /// <value>The maximum volume level.</value>
  36         /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
  37         /// <exception cref="ArgumentOutOfRangeException"><paramref name="type"/> is <see cref="AudioVolumeType.None"/>.</exception>
  38         /// <since_tizen> 3 </since_tizen>
  39         public int this[AudioVolumeType type]
  40         {
  41             get
  42             {
  43                 ValidationUtil.ValidateEnum(typeof(AudioVolumeType), type, nameof(type));
  44
  45                 if (type == AudioVolumeType.None)
  46                 {
  47                     throw new ArgumentOutOfRangeException(nameof(type),
  48                         "Cannot get max volume level for AudioVolumeType.None");
  49                 }
  50
  51                 Interop.AudioVolume.GetMaxVolume(type, out var maxVolume).
  52                     Validate("Failed to get the max volume level");
  53
  54                 return maxVolume;
  55             }
  56         }
  57     }
  58 }