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