Inheritance diagram for OpenSim.Region.CoreModules.World.Sound.SoundModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Sound.SoundModule:

Public Types
enum	SoundFlags : byte { SoundFlags.NONE = 0, SoundFlags.LOOP = 1 << 0, SoundFlags.SYNC_MASTER = 1<<1, SoundFlags.SYNC_SLAVE = 1<<2, SoundFlags.SYNC_PENDING = 1<<3, SoundFlags.QUEUE = 1<<4, SoundFlags.STOP = 1<<5, SoundFlags.SYNC_MASK = SYNC_MASTER \| SYNC_SLAVE \| SYNC_PENDING }

Public Member Functions
void	Initialise (IConfigSource configSource)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

virtual void	PlayAttachedSound (UUID soundID, UUID ownerID, UUID objectID, double gain, Vector3 position, byte flags, float radius)
	Play a sound from an object. More...

virtual 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...

virtual void	StopSound (UUID objectID)
	Stop sounds eminating from an object. More...

virtual void	PreloadSound (UUID objectID, UUID soundID, float radius)
	Preload sound to viewers within range. More...

void	LoopSound (UUID objectID, UUID soundID, double volume, 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 soundID, 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
bool	Enabled `[get, set]`

float	MaxDistance `[get, set]`

Type	ReplaceableInterface `[get]`

string	Name `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Properties inherited from OpenSim.Region.Framework.Interfaces.ISoundModule
float	MaxDistance `[get]`
	Maximum distance between a sound source and a recipient. More...

Detailed Description

Definition at line 44 of file SoundModule.cs.

Member Enumeration Documentation

enum OpenSim.Region.CoreModules.World.Sound.SoundModule.SoundFlags : byte

Enumerator
NONE
LOOP
SYNC_MASTER
SYNC_SLAVE
SYNC_PENDING
QUEUE
STOP
SYNC_MASK

Definition at line 51 of file SoundModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Sound.SoundModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 87 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 105 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 69 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.LoopSound	(	UUID	objectID,
		UUID	soundID,
		double	gain,
		double	radius,
		bool	isMaster,
		bool	isSlave
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 262 of file SoundModule.cs.

virtual void OpenSim.Region.CoreModules.World.Sound.SoundModule.PlayAttachedSound	(	UUID	soundID,
		UUID	ownerID,
		UUID	objectID,
		double	gain,
		Vector3	position,
		byte	flags,
		float	radius
	)

inlinevirtual

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.

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 127 of file SoundModule.cs.

virtual void OpenSim.Region.CoreModules.World.Sound.SoundModule.PreloadSound	(	UUID	objectID,
		UUID	soundID,
		float	radius
	)

inlinevirtual

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.

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 235 of file SoundModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Sound.SoundModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 94 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 89 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.SendSound	(	UUID	objectID,
		UUID	sound,
		double	volume,
		bool	triggered,
		byte	flags,
		float	radius,
		bool	useMaster,
		bool	isMaster
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 287 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.SetSoundQueueing	(	UUID	objectID,
		bool	shouldQueue
	)

inline

Set whether sounds on the given prim should be queued.

Parameters

objectID
shouldQueue

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 350 of file SoundModule.cs.

virtual void OpenSim.Region.CoreModules.World.Sound.SoundModule.StopSound ( UUID objectID )

inlinevirtual

Stop sounds eminating from an object.

Parameters

objectID Sound source ID

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 215 of file SoundModule.cs.

virtual void OpenSim.Region.CoreModules.World.Sound.SoundModule.TriggerSound	(	UUID	soundId,
		UUID	ownerID,
		UUID	objectID,
		UUID	parentID,
		double	gain,
		Vector3	position,
		UInt64	handle,
		float	radius
	)

inlinevirtual

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.

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 166 of file SoundModule.cs.

void OpenSim.Region.CoreModules.World.Sound.SoundModule.TriggerSoundLimited	(	UUID	objectID,
		UUID	sound,
		double	volume,
		Vector3	min,
		Vector3	max
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.ISoundModule.

Definition at line 320 of file SoundModule.cs.

Property Documentation

bool OpenSim.Region.CoreModules.World.Sound.SoundModule.Enabled

getset

Definition at line 63 of file SoundModule.cs.

float OpenSim.Region.CoreModules.World.Sound.SoundModule.MaxDistance

getset

Definition at line 65 of file SoundModule.cs.

string OpenSim.Region.CoreModules.World.Sound.SoundModule.Name

get

Definition at line 112 of file SoundModule.cs.

Type OpenSim.Region.CoreModules.World.Sound.SoundModule.ReplaceableInterface

get

Definition at line 108 of file SoundModule.cs.

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

Region/CoreModules/World/Sound/SoundModule.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation