OpenSim.Region.Framework.Interfaces.ISoundModule Interface Reference

Inheritance diagram for OpenSim.Region.Framework.Interfaces.ISoundModule:

Public Member Functions
void	PlayAttachedSound (UUID soundID, UUID ownerID, UUID objectID, double gain, Vector3 position, byte flags, float radius)
	Play a sound from an object. More...
void	TriggerSound (UUID soundId, UUID ownerID, UUID objectID, UUID parentID, double gain, Vector3 position, UInt64 handle, float radius)
	Trigger a sound in the scene. More...
void	StopSound (UUID objectID)
	Stop sounds eminating from an object. More...
void	PreloadSound (UUID objectID, UUID soundID, float radius)
	Preload sound to viewers within range. More...
void	LoopSound (UUID objectID, UUID soundID, double gain, double radius, bool isMaster, bool isSlave)
	Loop specified sound at specified volume with specified radius, optionally declaring object as new sync master. More...
void	SendSound (UUID objectID, UUID sound, double volume, bool triggered, byte flags, float radius, bool useMaster, bool isMaster)
	Trigger or play an attached sound in this part's inventory. More...
void	TriggerSoundLimited (UUID objectID, UUID sound, double volume, Vector3 min, Vector3 max)
	Trigger a sound to be played to all agents within an axis-aligned bounding box. More...
void	SetSoundQueueing (UUID objectID, bool shouldQueue)
	Set whether sounds on the given prim should be queued. More...

Properties
float	MaxDistance [get]
	Maximum distance between a sound source and a recipient. More...

Detailed Description

Definition at line 33 of file ISoundModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.ISoundModule.LoopSound	(	UUID	objectID,
		UUID	soundID,
		double	gain,
		double	radius,
		bool	isMaster,
		bool	isSlave
	)

Loop specified sound at specified volume with specified radius, optionally declaring object as new sync master.

Parameters

objectID	Sound source ID
soundID	Sound asset ID
gain	Sound volume
radius	Sound radius
isMaster	Set object to sync master if true

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.PlayAttachedSound	(	UUID	soundID,
		UUID	ownerID,
		UUID	objectID,
		double	gain,
		Vector3	position,
		byte	flags,
		float	radius
	)

Play a sound from an object.

Parameters

soundID	Sound asset ID
ownerID	Sound source owner
objectID	Sound source ID
gain	Sound volume
position	Sound source position
flags	Sound flags
radius	Radius used to affect gain over distance.

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.PreloadSound	(	UUID	objectID,
		UUID	soundID,
		float	radius
	)

Preload sound to viewers within range.

Parameters

objectID	Sound source ID
soundID	Sound asset ID
radius	Radius used to determine which viewers should preload the sound.

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.SendSound	(	UUID	objectID,
		UUID	sound,
		double	volume,
		bool	triggered,
		byte	flags,
		float	radius,
		bool	useMaster,
		bool	isMaster
	)

Trigger or play an attached sound in this part's inventory.

Parameters

objectID	Sound source ID
sound	Sound asset ID
volume	Sound volume
triggered	Triggered or not.
radius	Sound radius
useMaster	Play using sound master
isMaster	Play as sound master

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.SetSoundQueueing	(	UUID	objectID,
		bool	shouldQueue
	)

Set whether sounds on the given prim should be queued.

Parameters

objectID
shouldQueue

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.StopSound

(

UUID

objectID

)

Stop sounds eminating from an object.

Parameters

objectID

Sound source ID

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.TriggerSound	(	UUID	soundId,
		UUID	ownerID,
		UUID	objectID,
		UUID	parentID,
		double	gain,
		Vector3	position,
		UInt64	handle,
		float	radius
	)

Trigger a sound in the scene.

Parameters

soundId	Sound asset ID
ownerID	Sound source owner
objectID	Sound source ID
parentID	Sound source parent.
gain	Sound volume
position	Sound source position
handle
radius	Radius used to affect gain over distance.

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

void OpenSim.Region.Framework.Interfaces.ISoundModule.TriggerSoundLimited	(	UUID	objectID,
		UUID	sound,
		double	volume,
		Vector3	min,
		Vector3	max
	)

Trigger a sound to be played to all agents within an axis-aligned bounding box.

Parameters

objectID	Sound source ID
sound	Sound asset ID
volume	Sound volume
min	AABB bottom south-west corner
max	AABB top north-east corner

Implemented in OpenSim.Region.CoreModules.World.Sound.SoundModule.

Property Documentation

float OpenSim.Region.Framework.Interfaces.ISoundModule.MaxDistance

get

Maximum distance between a sound source and a recipient.

Definition at line 38 of file ISoundModule.cs.

---

The documentation for this interface was generated from the following file:

• Region/Framework/Interfaces/ISoundModule.cs