LocalCallSilenceExtension
@ExperimentalAppActions
interface LocalCallSilenceExtension
Add support for this remote surface to display information related to the local call silence state for this call.
Local Call Silence means that the call should be silenced at the application layer (local silence) instead of the hardware layer (global silence). Using a local call silence over global silence is advantageous when the application wants to still receive the audio input data while not transmitting audio input data to remote users. This allows applications to do stuff like nudge the user when they are silenced but talking into the microphone.
| See also | |
|---|---|
addLocalCallSilenceExtension |
Summary
Public functions |
|
|---|---|
suspend Unit |
updateCanUserUpdateSilence(canUserUpdateSilence: Boolean)Updates whether the user is allowed to change the silence state on remote surfaces. |
suspend Unit |
updateIsLocallySilenced(isSilenced: Boolean)Update all of the remote surfaces that the local call silence state of this call has changed. |
Public functions
updateCanUserUpdateSilence
suspend fun updateCanUserUpdateSilence(canUserUpdateSilence: Boolean): Unit
Updates whether the user is allowed to change the silence state on remote surfaces. This should be set to 'false' when the user is in a state where audio input is disabled by the a moderator or the environment (e.g. hardware limitations).
| Parameters | |
|---|---|
canUserUpdateSilence: Boolean |
True if the user can toggle silence, false if the control should be disabled. |
updateIsLocallySilenced
suspend fun updateIsLocallySilenced(isSilenced: Boolean): Unit
Update all of the remote surfaces that the local call silence state of this call has changed.
| Parameters | |
|---|---|
isSilenced: Boolean |
The new local call silence state associated with this call. |