SlimDXc_Jun2010(VC++2008)/source/xact3/TrackProperties.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 namespace SlimDX
  25 {
  26         namespace XACT3
  27         {
  28                 /// <summary>
  29                 /// The properties of a track in an active sound variation in a cue instance.
  30                 /// </summary>
  31                 /// <unmanaged>XACT_TRACK_PROPERTIES</unmanaged>
  32                 public value class TrackProperties
  33                 {
  34                 private:
  35                         int duration;
  36                         int numVariations;
  37                         int numChannels;
  38                         int waveVariation;
  39                         int loopCount;
  40
  41                 internal:
  42                         TrackProperties(const XACT_TRACK_PROPERTIES& data);
  43
  44                 public:
  45                         /// <summary>
  46                         /// Gets the duration of the track in milliseconds.
  47                         /// </summary>
  48                         property int Duration
  49                         {
  50                                 int get() { return duration; }
  51                         }
  52
  53                         /// <summary>
  54                         /// Gets the number of wave variations in the track.
  55                         /// </summary>
  56                         property int VariationCount
  57                         {
  58                                 int get() { return numVariations; }
  59                         }
  60
  61                         /// <summary>
  62                         /// Gets the number of channels that are required to play the track.
  63                         /// </summary>
  64                         property int ChannelCount
  65                         {
  66                                 int get() { return numChannels; }
  67                         }
  68
  69                         /// <summary>
  70                         /// Gets the index of the currently active wave variation.
  71                         /// </summary>
  72                         property int WaveVariation
  73                         {
  74                                 int get() { return waveVariation; }
  75                         }
  76
  77                         /// <summary>
  78                         /// Gets the current loop count on the track.
  79                         /// </summary>
  80                         property int LoopCount
  81                         {
  82                                 int get() { return loopCount; }
  83                         }
  84                 };
  85         }
  86 }