src/Tizen.Multimedia.Recorder/Recorder/AudioStreamStoringEventArgs.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="Recorder.AudioStreamStoring"/> event.
  23     /// </summary>
  24     public class AudioStreamStoringEventArgs : EventArgs
  25     {
  26         internal AudioStreamStoringEventArgs(IMediaBuffer stream, AudioSampleType type, int channel,
  27             uint recordingTime)
  28         {
  29             Stream = stream;
  30             Type = type;
  31             Channels = channel;
  32             Timestamp = recordingTime;
  33         }
  34
  35         /// <summary>
  36         /// Gets the audio stream buffer.
  37         /// </summary>
  38         /// <remarks>
  39         /// If the stream is modified in the event handler, the modified data will be stored.<br/>
  40         /// <br/>
  41         /// The buffer is only valid in the event.<br/>
  42         /// Any attempt to access to this buffer after the event ends will throw an exception.
  43         /// </remarks>
  44         public IMediaBuffer Stream { get; }
  45
  46         /// <summary>
  47         /// Gets the audio format type.
  48         /// </summary>
  49         public AudioSampleType Type { get; }
  50
  51         /// <summary>
  52         /// Gets the number of channels.
  53         /// </summary>
  54         public int Channels { get; }
  55
  56         /// <summary>
  57         /// Gets the timestamp(PTS) of stream buffer in milliseconds.
  58         /// </summary>
  59         public long Timestamp { get; }
  60     }
  61 }