ISoundAgent.cs 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  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. namespace GameFramework.Sound
  8. {
  9. /// <summary>
  10. /// 声音代理接口。
  11. /// </summary>
  12. public interface ISoundAgent
  13. {
  14. /// <summary>
  15. /// 获取所在的声音组。
  16. /// </summary>
  17. ISoundGroup SoundGroup
  18. {
  19. get;
  20. }
  21. /// <summary>
  22. /// 获取声音的序列编号。
  23. /// </summary>
  24. int SerialId
  25. {
  26. get;
  27. }
  28. /// <summary>
  29. /// 获取当前是否正在播放。
  30. /// </summary>
  31. bool IsPlaying
  32. {
  33. get;
  34. }
  35. /// <summary>
  36. /// 获取声音长度。
  37. /// </summary>
  38. float Length
  39. {
  40. get;
  41. }
  42. /// <summary>
  43. /// 获取或设置播放位置。
  44. /// </summary>
  45. float Time
  46. {
  47. get;
  48. set;
  49. }
  50. /// <summary>
  51. /// 获取或设置是否静音。
  52. /// </summary>
  53. bool Mute
  54. {
  55. get;
  56. }
  57. /// <summary>
  58. /// 获取或设置在声音组内是否静音。
  59. /// </summary>
  60. bool MuteInSoundGroup
  61. {
  62. get;
  63. set;
  64. }
  65. /// <summary>
  66. /// 获取或设置是否循环播放。
  67. /// </summary>
  68. bool Loop
  69. {
  70. get;
  71. set;
  72. }
  73. /// <summary>
  74. /// 获取或设置声音优先级。
  75. /// </summary>
  76. int Priority
  77. {
  78. get;
  79. set;
  80. }
  81. /// <summary>
  82. /// 获取音量大小。
  83. /// </summary>
  84. float Volume
  85. {
  86. get;
  87. }
  88. /// <summary>
  89. /// 获取或设置在声音组内音量大小。
  90. /// </summary>
  91. float VolumeInSoundGroup
  92. {
  93. get;
  94. set;
  95. }
  96. /// <summary>
  97. /// 获取或设置声音音调。
  98. /// </summary>
  99. float Pitch
  100. {
  101. get;
  102. set;
  103. }
  104. /// <summary>
  105. /// 获取或设置声音立体声声相。
  106. /// </summary>
  107. float PanStereo
  108. {
  109. get;
  110. set;
  111. }
  112. /// <summary>
  113. /// 获取或设置声音空间混合量。
  114. /// </summary>
  115. float SpatialBlend
  116. {
  117. get;
  118. set;
  119. }
  120. /// <summary>
  121. /// 获取或设置声音最大距离。
  122. /// </summary>
  123. float MaxDistance
  124. {
  125. get;
  126. set;
  127. }
  128. /// <summary>
  129. /// 获取或设置声音多普勒等级。
  130. /// </summary>
  131. float DopplerLevel
  132. {
  133. get;
  134. set;
  135. }
  136. /// <summary>
  137. /// 获取声音代理辅助器。
  138. /// </summary>
  139. ISoundAgentHelper Helper
  140. {
  141. get;
  142. }
  143. /// <summary>
  144. /// 播放声音。
  145. /// </summary>
  146. void Play();
  147. /// <summary>
  148. /// 播放声音。
  149. /// </summary>
  150. /// <param name="fadeInSeconds">声音淡入时间,以秒为单位。</param>
  151. void Play(float fadeInSeconds);
  152. /// <summary>
  153. /// 停止播放声音。
  154. /// </summary>
  155. void Stop();
  156. /// <summary>
  157. /// 停止播放声音。
  158. /// </summary>
  159. /// <param name="fadeOutSeconds">声音淡出时间,以秒为单位。</param>
  160. void Stop(float fadeOutSeconds);
  161. /// <summary>
  162. /// 暂停播放声音。
  163. /// </summary>
  164. void Pause();
  165. /// <summary>
  166. /// 暂停播放声音。
  167. /// </summary>
  168. /// <param name="fadeOutSeconds">声音淡出时间,以秒为单位。</param>
  169. void Pause(float fadeOutSeconds);
  170. /// <summary>
  171. /// 恢复播放声音。
  172. /// </summary>
  173. void Resume();
  174. /// <summary>
  175. /// 恢复播放声音。
  176. /// </summary>
  177. /// <param name="fadeInSeconds">声音淡入时间,以秒为单位。</param>
  178. void Resume(float fadeInSeconds);
  179. /// <summary>
  180. /// 重置声音代理。
  181. /// </summary>
  182. void Reset();
  183. }
  184. }