ISoundAgentHelper.cs 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. using System;
  8. namespace GameFramework.Sound
  9. {
  10. /// <summary>
  11. /// 声音代理辅助器接口。
  12. /// </summary>
  13. public interface ISoundAgentHelper
  14. {
  15. /// <summary>
  16. /// 获取当前是否正在播放。
  17. /// </summary>
  18. bool IsPlaying
  19. {
  20. get;
  21. }
  22. /// <summary>
  23. /// 获取声音长度。
  24. /// </summary>
  25. float Length
  26. {
  27. get;
  28. }
  29. /// <summary>
  30. /// 获取或设置播放位置。
  31. /// </summary>
  32. float Time
  33. {
  34. get;
  35. set;
  36. }
  37. /// <summary>
  38. /// 获取或设置是否静音。
  39. /// </summary>
  40. bool Mute
  41. {
  42. get;
  43. set;
  44. }
  45. /// <summary>
  46. /// 获取或设置是否循环播放。
  47. /// </summary>
  48. bool Loop
  49. {
  50. get;
  51. set;
  52. }
  53. /// <summary>
  54. /// 获取或设置声音优先级。
  55. /// </summary>
  56. int Priority
  57. {
  58. get;
  59. set;
  60. }
  61. /// <summary>
  62. /// 获取或设置音量大小。
  63. /// </summary>
  64. float Volume
  65. {
  66. get;
  67. set;
  68. }
  69. /// <summary>
  70. /// 获取或设置声音音调。
  71. /// </summary>
  72. float Pitch
  73. {
  74. get;
  75. set;
  76. }
  77. /// <summary>
  78. /// 获取或设置声音立体声声相。
  79. /// </summary>
  80. float PanStereo
  81. {
  82. get;
  83. set;
  84. }
  85. /// <summary>
  86. /// 获取或设置声音空间混合量。
  87. /// </summary>
  88. float SpatialBlend
  89. {
  90. get;
  91. set;
  92. }
  93. /// <summary>
  94. /// 获取或设置声音最大距离。
  95. /// </summary>
  96. float MaxDistance
  97. {
  98. get;
  99. set;
  100. }
  101. /// <summary>
  102. /// 获取或设置声音多普勒等级。
  103. /// </summary>
  104. float DopplerLevel
  105. {
  106. get;
  107. set;
  108. }
  109. /// <summary>
  110. /// 重置声音代理事件。
  111. /// </summary>
  112. event EventHandler<ResetSoundAgentEventArgs> ResetSoundAgent;
  113. /// <summary>
  114. /// 播放声音。
  115. /// </summary>
  116. /// <param name="fadeInSeconds">声音淡入时间,以秒为单位。</param>
  117. void Play(float fadeInSeconds);
  118. /// <summary>
  119. /// 停止播放声音。
  120. /// </summary>
  121. /// <param name="fadeOutSeconds">声音淡出时间,以秒为单位。</param>
  122. void Stop(float fadeOutSeconds);
  123. /// <summary>
  124. /// 暂停播放声音。
  125. /// </summary>
  126. /// <param name="fadeOutSeconds">声音淡出时间,以秒为单位。</param>
  127. void Pause(float fadeOutSeconds);
  128. /// <summary>
  129. /// 恢复播放声音。
  130. /// </summary>
  131. /// <param name="fadeInSeconds">声音淡入时间,以秒为单位。</param>
  132. void Resume(float fadeInSeconds);
  133. /// <summary>
  134. /// 重置声音代理辅助器。
  135. /// </summary>
  136. void Reset();
  137. /// <summary>
  138. /// 设置声音资源。
  139. /// </summary>
  140. /// <param name="soundAsset">声音资源。</param>
  141. /// <returns>是否设置声音资源成功。</returns>
  142. bool SetSoundAsset(object soundAsset);
  143. }
  144. }