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