NVorbis/NewStreamEventArgs.cs

   1 /****************************************************************************
   2  * NVorbis                                                                  *
   3  * Copyright (C) 2014, Andrew Ward <afward@gmail.com>                       *
   4  *                                                                          *
   5  * See COPYING for license terms (Ms-PL).                                   *
   6  *                                                                          *
   7  ***************************************************************************/
   8 using System;
   9
  10 namespace NVorbis
  11 {
  12     /// <summary>
  13     /// Event data for when a new logical stream is found in a container.
  14     /// </summary>
  15     [Serializable]
  16     public class NewStreamEventArgs : EventArgs
  17     {
  18         /// <summary>
  19         /// Creates a new instance of <see cref="NewStreamEventArgs"/> with the specified <see cref="IPacketProvider"/>.
  20         /// </summary>
  21         /// <param name="packetProvider">An <see cref="IPacketProvider"/> instance.</param>
  22         public NewStreamEventArgs(IPacketProvider packetProvider)
  23         {
  24             if (packetProvider == null) throw new ArgumentNullException("packetProvider");
  25
  26             PacketProvider = packetProvider;
  27         }
  28
  29         /// <summary>
  30         /// Gets new the <see cref="IPacketProvider"/> instance.
  31         /// </summary>
  32         public IPacketProvider PacketProvider { get; private set; }
  33
  34         /// <summary>
  35         /// Gets or sets whether to ignore the logical stream associated with the packet provider.
  36         /// </summary>
  37         public bool IgnoreStream { get; set; }
  38     }
  39 }