![]() | Connection Properties |
The Connection type exposes the following members.
Name | Description | |
---|---|---|
![]() | AllChannels |
A list of all channels on the virtual server
|
![]() | AllClients |
A list of all currently visible clients on the virtual server
|
![]() | CaptureDevice |
Currently open capture device. Set using OpenCapture(ISoundDevice) |
![]() | Channels |
A list of channels who have the channel as a parent
|
![]() | ChannelsOnline |
Number of channels currently on this virtual server. Needs to be requested using RefreshVariables.
|
![]() | ClientsOnline |
Number of clients currently on this virtual server. Needs to be requested using RefreshVariables.
|
![]() | CodecEncryptionMode |
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.
|
![]() | Created |
Time when this virtual server was created. Always available when connected.
|
![]() | ID |
ID of the client
|
![]() | IsVoiceRecording |
When using EditCapturedVoiceData to record voice, you should notify the server when recording starts or stops
|
![]() | LocalTestMode |
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.
|
![]() | MaxClients |
Defines maximum number of clients which may connect to this server. Needs to be requested using RefreshVariables.
|
![]() | Name |
Name of this virtual server. Always available when connected.
|
![]() | Platform |
Operating system used by this server. Always available when connected.
|
![]() | PlaybackDevice |
Currently open playback device. Set using OpenPlayback(ISoundDevice) |
![]() | Preprocessor |
Sound Preprocessor Parameters
|
![]() | Self |
the connection as a client object
|
![]() | ServerIp |
IP of the server (seen from the client side)
|
![]() | ServerPort |
Port of the server (seen from the client side)
|
![]() | SpeedLimitDown |
The download speed limit for the specified virtual server in bytes/s.
|
![]() | SpeedLimitUp |
The upload speed limit for the specified virtual server in bytes/s.
|
![]() | Status |
Status of the connection to the given server
|
![]() | UniqueIdentifier |
Unique ID for this virtual server. Stays the same after restarting the server application. Always available when connected.
|
![]() | Uptime |
Uptime of this virtual server. Needs to be requested using RefreshVariables.
|
![]() | Version |
Application version of this server. Always available when connected.
|
![]() | VolumeFactorWave |
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).
|
![]() | VolumeModifier |
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.
|
![]() | WelcomeMessage |
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.
|