Methods
getAutoMuteRampDuration() → {Float}
Get the duration (in secs) of the auto-mute ramping.
Returns:
duration in seconds
- Type
- Float
getCommInterval() → {Float}
Get the current communications interval.
Returns:
comm interval in seconds
- Type
- Float
getLocalPttMode() → {Boolean}
Get the current local push-to-talk state.
Returns:
true if local connection is in PTT mode
- Type
- Boolean
getMicAttenuation() → {Float}
Get the amount of attenuation applied to the mic signal when in its "mute" state.
Returns:
attenuation
- Type
- Float
getRemotePttMode() → {Boolean}
Get the current remote push-to-talk state.
Returns:
true if remote connection is in PTT mode
- Type
- Boolean
getSpeakerMuted() → {Boolean}
Get the speaker mute state.
Returns:
current speaker mute state
- Type
- Boolean
getStreamQuality() → {kMdpsQuality}
Get the current stream quality.
- See:
-
- Constants.kMdpsQuality
Returns:
stream quality integer
- Type
- kMdpsQuality
getUnmuteDelay() → {Float}
Get the current unmute delay.
Returns:
unmute delay in seconds
- Type
- Float
setAutoMuteRampDuration(secs)
Set the duration (in secs) of the auto-mute ramping. A linear ramp will be applied
to attenuation used when muting the signal, both when ramping down (mute) and
ramping back up (unmute).
Parameters:
| Name | Type | Description |
|---|---|---|
secs |
Float | duration in seconds (.003 - .3 s) |
setCommInterval(secs)
Set the communications interval for the data channel communications between peers. This frequency
determines how often data such as NoiseGate release state is propagated.
Parameters:
| Name | Type | Description |
|---|---|---|
secs |
Float | comm interval in seconds (0.02 - 0.2) |
setMicAttenuation(val)
Set the amount of attenuation applied to the mic signal when in its "mute" state.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
Float | attenuation (0 - 1) |
setSpeakerMuted(muted)
Set the speaker mute state.
Parameters:
| Name | Type | Description |
|---|---|---|
muted |
Boolean | new speaker mute state (true is muted) |
setStreamQuality(quality)
Set the current stream quality.
Parameters:
| Name | Type | Description |
|---|---|---|
quality |
kMdpsQuality |
- See:
-
- Constants.kMdpsQuality
setUnmuteDelay(secs)
Set the unmute delay. This determines the amount of delay before the transition from the muted to unmuted state
at the end of a push-to-talk session.
Parameters:
| Name | Type | Description |
|---|---|---|
secs |
Float | unmute delay in seconds (0 - 3) |