OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule Class Reference
Inheritance diagram for OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule:
Collaboration graph
[legend]

Public Member Functions

void Initialise (IConfigSource config)
 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 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 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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void OnRegisterCaps (Scene scene, UUID agentID, Caps caps)
 
string ProvisionVoiceAccountRequest (Scene scene, string request, string path, string param, UUID agentID, Caps caps)
 Callback for a client request for Voice Account Details More...
 
string ParcelVoiceInfoRequest (Scene scene, string request, string path, string param, UUID agentID, Caps caps)
 Callback for a client request for ParcelVoiceInfo More...
 
string ChatSessionRequest (Scene scene, string request, string path, string param, UUID agentID, Caps caps)
 Callback for a client request for a private chat channel More...
 

Public Attributes

const int CHAN_DIST_NONE = 0
 
const int CHAN_DIST_INVERSE = 1
 
const int CHAN_DIST_LINEAR = 2
 
const int CHAN_DIST_EXPONENT = 3
 
const int CHAN_DIST_DEFAULT = CHAN_DIST_LINEAR
 
const double CHAN_ROLL_OFF_DEFAULT = 2.0
 
const double CHAN_ROLL_OFF_MIN = 1.0
 
const double CHAN_ROLL_OFF_MAX = 4.0
 
const int CHAN_MAX_RANGE_DEFAULT = 80
 
const int CHAN_MAX_RANGE_MIN = 0
 
const int CHAN_MAX_RANGE_MAX = 160
 
const int CHAN_CLAMPING_DISTANCE_DEFAULT = 10
 
const int CHAN_CLAMPING_DISTANCE_MIN = 0
 
const int CHAN_CLAMPING_DISTANCE_MAX = 160
 

Static Public Attributes

static readonly string CHAN_TYPE_POSITIONAL = "positional"
 
static readonly string CHAN_TYPE_CHANNEL = "channel"
 
static readonly string CHAN_TYPE_DEFAULT = CHAN_TYPE_POSITIONAL
 
static readonly string CHAN_MODE_OPEN = "open"
 
static readonly string CHAN_MODE_LECTURE = "lecture"
 
static readonly string CHAN_MODE_PRESENTATION = "presentation"
 
static readonly string CHAN_MODE_AUDITORIUM = "auditorium"
 
static readonly string CHAN_MODE_DEFAULT = CHAN_MODE_OPEN
 

Properties

Type ReplaceableInterface [get]
 
string Name [get]
 
bool IsSharedModule [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...
 

Detailed Description

Definition at line 54 of file VivoxVoiceModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 231 of file VivoxVoiceModule.cs.

string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.ChatSessionRequest ( Scene  scene,
string  request,
string  path,
string  param,
UUID  agentID,
Caps  caps 
)
inline

Callback for a client request for a private chat channel

Parameters
scenecurrent scene object of the client
request
path
param
agentID
caps
Returns

Definition at line 695 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.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 372 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 122 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.OnRegisterCaps ( Scene  scene,
UUID  agentID,
Caps  caps 
)
inline

Definition at line 411 of file VivoxVoiceModule.cs.

string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.ParcelVoiceInfoRequest ( Scene  scene,
string  request,
string  path,
string  param,
UUID  agentID,
Caps  caps 
)
inline

Callback for a client request for ParcelVoiceInfo

Parameters
scenecurrent scene object of the client
request
path
param
agentID
caps
Returns

Definition at line 609 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 367 of file VivoxVoiceModule.cs.

string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.ProvisionVoiceAccountRequest ( Scene  scene,
string  request,
string  path,
string  param,
UUID  agentID,
Caps  caps 
)
inline

Callback for a client request for Voice Account Details

Parameters
scenecurrent scene object of the client
request
path
param
agentID
caps
Returns

Definition at line 458 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 307 of file VivoxVoiceModule.cs.

void OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 312 of file VivoxVoiceModule.cs.

Member Data Documentation

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_CLAMPING_DISTANCE_DEFAULT = 10

Definition at line 83 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_CLAMPING_DISTANCE_MAX = 160

Definition at line 85 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_CLAMPING_DISTANCE_MIN = 0

Definition at line 84 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_DIST_DEFAULT = CHAN_DIST_LINEAR

Definition at line 62 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_DIST_EXPONENT = 3

Definition at line 61 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_DIST_INVERSE = 1

Definition at line 59 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_DIST_LINEAR = 2

Definition at line 60 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_DIST_NONE = 0

Definition at line 58 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MAX_RANGE_DEFAULT = 80

Definition at line 80 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MAX_RANGE_MAX = 160

Definition at line 82 of file VivoxVoiceModule.cs.

const int OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MAX_RANGE_MIN = 0

Definition at line 81 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MODE_AUDITORIUM = "auditorium"
static

Definition at line 73 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MODE_DEFAULT = CHAN_MODE_OPEN
static

Definition at line 74 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MODE_LECTURE = "lecture"
static

Definition at line 71 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MODE_OPEN = "open"
static

Definition at line 70 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_MODE_PRESENTATION = "presentation"
static

Definition at line 72 of file VivoxVoiceModule.cs.

const double OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_ROLL_OFF_DEFAULT = 2.0

Definition at line 77 of file VivoxVoiceModule.cs.

const double OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_ROLL_OFF_MAX = 4.0

Definition at line 79 of file VivoxVoiceModule.cs.

const double OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_ROLL_OFF_MIN = 1.0

Definition at line 78 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_TYPE_CHANNEL = "channel"
static

Definition at line 66 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_TYPE_DEFAULT = CHAN_TYPE_POSITIONAL
static

Definition at line 67 of file VivoxVoiceModule.cs.

readonly string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.CHAN_TYPE_POSITIONAL = "positional"
static

Definition at line 65 of file VivoxVoiceModule.cs.

Property Documentation

bool OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.IsSharedModule
get

Definition at line 389 of file VivoxVoiceModule.cs.

string OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.Name
get

Definition at line 384 of file VivoxVoiceModule.cs.

Type OpenSim.Region.OptionalModules.Avatar.Voice.VivoxVoice.VivoxVoiceModule.ReplaceableInterface
get

Definition at line 379 of file VivoxVoiceModule.cs.

The documentation for this class was generated from the following file:
Generated on Wed Apr 6 2016 04:35:13 for OpenSim by   doxygen 1.8.6