aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorSignpostMarv2012-10-05 14:46:31 +0100
committerJustin Clark-Casey (justincc)2012-10-29 23:38:58 +0000
commitb9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73 (patch)
tree2fb0c31842c7caf0f12427c34d6012a9109aea01
parentformatting ISoundModule prior to documentation (diff)
downloadopensim-SC_OLD-b9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73.zip
opensim-SC_OLD-b9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73.tar.gz
opensim-SC_OLD-b9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73.tar.bz2
opensim-SC_OLD-b9e0f1cd2be3fe8b20d639d66f5f4fc8f1995d73.tar.xz
documenting ISoundModule methods & fields
-rw-r--r--OpenSim/Region/Framework/Interfaces/ISoundModule.cs28
1 files changed, 28 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
index 90fe0bc..6930d78 100644
--- a/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/ISoundModule.cs
@@ -32,11 +32,39 @@ namespace OpenSim.Region.Framework.Interfaces
32{ 32{
33 public interface ISoundModule 33 public interface ISoundModule
34 { 34 {
35 /// <summary>
36 /// Maximum distance between a sound source and a recipient.
37 /// </summary>
35 float MaxDistance { get; } 38 float MaxDistance { get; }
36 39
40 /// <summary>
41 /// Play a sound from an object.
42 /// </summary>
43 /// <param name="soundID">Sound asset ID</param>
44 /// <param name="ownerID">Sound source owner</param>
45 /// <param name="objectID">Sound source ID</param>
46 /// <param name="gain">Sound volume</param>
47 /// <param name="position">Sound source position</param>
48 /// <param name="flags">Sound flags</param>
49 /// <param name="radius">
50 /// Radius used to affect gain over distance.
51 /// </param>
37 void PlayAttachedSound(UUID soundID, UUID ownerID, UUID objectID, 52 void PlayAttachedSound(UUID soundID, UUID ownerID, UUID objectID,
38 double gain, Vector3 position, byte flags, float radius); 53 double gain, Vector3 position, byte flags, float radius);
39 54
55 /// <summary>
56 /// Trigger a sound in the scene.
57 /// </summary>
58 /// <param name="soundId">Sound asset ID</param>
59 /// <param name="ownerID">Sound source owner</param>
60 /// <param name="objectID">Sound source ID</param>
61 /// <param name="parentID">Sound source parent.</param>
62 /// <param name="gain">Sound volume</param>
63 /// <param name="position">Sound source position</param>
64 /// <param name="handle"></param>
65 /// <param name="radius">
66 /// Radius used to affect gain over distance.
67 /// </param>
40 void TriggerSound( 68 void TriggerSound(
41 UUID soundId, UUID ownerID, UUID objectID, UUID parentID, 69 UUID soundId, UUID ownerID, UUID objectID, UUID parentID,
42 double gain, Vector3 position, UInt64 handle, float radius); 70 double gain, Vector3 position, UInt64 handle, float radius);