src/Tizen.Multimedia/AudioManager/StreamFocusStateChangedEventArgs.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 data for the <see cref="AudioStreamPolicy.StreamFocusStateChanged"/> event.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public class StreamFocusStateChangedEventArgs : EventArgs
  26     {
  27         internal StreamFocusStateChangedEventArgs(AudioStreamFocusOptions options,
  28             AudioStreamFocusState focusState, AudioStreamFocusChangedReason reason, string extraInfo)
  29         {
  30             FocusOptions = options;
  31             FocusState = focusState;
  32             Reason = reason;
  33             ExtraInfo = extraInfo;
  34         }
  35
  36         /// <summary>
  37         /// Gets the focus options.
  38         /// </summary>
  39         /// <value>The focus options.</value>
  40         /// <since_tizen> 4 </since_tizen>
  41         public AudioStreamFocusOptions FocusOptions { get; }
  42
  43         /// <summary>
  44         /// Gets the changed focus state.
  45         /// </summary>
  46         /// <value>The focus state.</value>
  47         /// <since_tizen> 4 </since_tizen>
  48         public AudioStreamFocusState FocusState { get; }
  49
  50         /// <summary>
  51         /// Gets the reason for state change of the focus.
  52         /// </summary>
  53         /// <value>The reason for state change of the focus.</value>
  54         /// <since_tizen> 4 </since_tizen>
  55         public AudioStreamFocusChangedReason Reason { get; }
  56
  57         /// <summary>
  58         /// Gets the extra information.
  59         /// </summary>
  60         /// <value>
  61         /// The extra information specified in <see cref="AudioStreamPolicy.AcquireFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)"/> or
  62         /// <see cref="AudioStreamPolicy.ReleaseFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)"/>.
  63         /// </value>
  64         /// <seealso cref="AudioStreamPolicy.AcquireFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)"/>
  65         /// <seealso cref="AudioStreamPolicy.ReleaseFocus(AudioStreamFocusOptions, AudioStreamBehaviors, string)"/>
  66         /// <since_tizen> 4 </since_tizen>
  67         public string ExtraInfo { get; }
  68     }
  69 }