Click or drag to resize
Connection Properties

The Connection type exposes the following members.

Properties
  NameDescription
Public propertyAllChannels
A list of all channels on the virtual server
Public propertyAllClients
A list of all currently visible clients on the virtual server
Public propertyCaptureDevice
Currently open capture device. Set using OpenCapture(ISoundDevice)
Public propertyChannels
A list of channels who have the channel as a parent
Public propertyChannelsOnline
Number of channels currently on this virtual server. Needs to be requested using RefreshVariables.
Public propertyClientsOnline
Number of clients currently on this virtual server. Needs to be requested using RefreshVariables.
Public propertyCodecEncryptionMode
Defines if voice data encryption is configured per channel, globally forced on or globally forced off for this virtual server. The default behavior is configure per channel, in this case modifying CodecIsUnencrypted defines voice data encryption of individual channels.
Public propertyCreated
Time when this virtual server was created. Always available when connected.
Public propertyID
ID of the client
Public propertyIsVoiceRecording
When using EditCapturedVoiceData to record voice, you should notify the server when recording starts or stops
Public propertyLocalTestMode
Instead of sending the sound through the network, it can be routed directly through the playback device, so the user will get immediate audible feedback when for example configuring some sound settings.
Public propertyMaxClients
Defines maximum number of clients which may connect to this server. Needs to be requested using RefreshVariables.
Public propertyName
Name of this virtual server. Always available when connected.
Public propertyPlatform
Operating system used by this server. Always available when connected.
Public propertyPlaybackDevice
Currently open playback device. Set using OpenPlayback(ISoundDevice)
Public propertyPreprocessor
Sound Preprocessor Parameters
Public propertySelf
the connection as a client object
Public propertyServerIp
IP of the server (seen from the client side)
Public propertyServerPort
Port of the server (seen from the client side)
Public propertySpeedLimitDown
The download speed limit for the specified virtual server in bytes/s.
Public propertySpeedLimitUp
The upload speed limit for the specified virtual server in bytes/s.
Public propertyStatus
Status of the connection to the given server
Public propertyUniqueIdentifier
Unique ID for this virtual server. Stays the same after restarting the server application. Always available when connected.
Public propertyUptime
Uptime of this virtual server. Needs to be requested using RefreshVariables.
Public propertyVersion
Application version of this server. Always available when connected.
Public propertyVolumeFactorWave
Adjust the volume of wave files played by PlayWaveFile(String, Boolean). The value is a float defining the volume reduction in decibel. Reasonable values range from “-40.0” (very silent) to “0.0” (loudest).
Public propertyVolumeModifier
Modify the voice volume of other speakers. Value is in decibel, so 0 is no modification, negative values make the signal quieter and values greater than zero boost the signal louder than it is. Be careful with high positive values, as you can really cause bad audio quality due to clipping. The maximum possible Value is 30. Zero and all negative values cannot cause clipping and distortion, and are preferred for optimal audio quality. Values greater than zero and less than +6 dB might cause moderate clipping and distortion, but should still be within acceptable bounds. Values greater than +6 dB will cause clipping and distortion that will negatively affect your audio quality. It is advised to choose lower values. Generally we recommend to not allow values higher than 15 db.
Public propertyWelcomeMessage
Optional welcome message sent to the client on login. This value should be queried by the client after connection has been established, it is not updated afterwards.
Top
See Also