PlasmoVoice/su.plo.voice.api.client.audio.capture/ClientActivation

ClientActivation

interface ClientActivation : Activation

Represents a client activation.

Types

Link copied to clipboard
enum Result
Link copied to clipboard
enum Type

Functions

Link copied to clipboard
open fun calculateAllowedDistance(distance: Int): Int
Link copied to clipboard
open fun checkDistance(distance: Int): Boolean
Link copied to clipboard
abstract fun cleanup()
Cleans up and releases resources associated with this activation.
Link copied to clipboard
abstract fun getDefaultDistance(): Int
Link copied to clipboard
abstract fun getDistance(): Int
Gets the activation distance.
Link copied to clipboard
@NotNull
abstract fun getDistanceDecreaseKey(): @NotNull Hotkey
Gets the key binding for decreasing activation distance.
Link copied to clipboard
@NotNull
abstract fun getDistanceIncreaseKey(): @NotNull Hotkey
Gets the key binding for increasing activation distance.
Link copied to clipboard
abstract fun getDistances(): List<Integer>
Link copied to clipboard
abstract fun getEncoderInfo(): Optional<CodecInfo>
Link copied to clipboard
abstract fun getIcon(): @NotNull String
Link copied to clipboard
abstract fun getId(): @NotNull UUID
Link copied to clipboard
abstract fun getLastActivation(): Long
Gets the timestamp of the last activation.
Link copied to clipboard
abstract fun getMaxDistance(): Int
Link copied to clipboard
abstract fun getMinDistance(): Int
Link copied to clipboard
abstract fun getMonoEncoder(): Optional<AudioEncoder>
Gets the mono audio encoder associated with this activation.
Link copied to clipboard
abstract fun getName(): @NotNull String
Link copied to clipboard
@NotNull
abstract fun getPttKey(): @NotNull Hotkey
Gets the key binding for Push-to-Talk.
Link copied to clipboard
abstract fun getStereoEncoder(): Optional<AudioEncoder>
Gets the stereo audio encoder associated with this activation.
Link copied to clipboard
@NotNull
abstract fun getToggleKey(): @NotNull Hotkey
Gets the key binding for toggling activation.
Link copied to clipboard
abstract fun getTranslation(): @NotNull String
Link copied to clipboard
@NotNull
abstract fun getType(): @NotNull ClientActivation.Type
Gets the type of client activation.
Link copied to clipboard
open fun getWeight(): Int
Link copied to clipboard
abstract fun isActive(): Boolean
Checks if activation is currently active.
Link copied to clipboard
abstract fun isDisabled(): Boolean
Checks if activation is disabled by toggle or manually using setDisabled.
Link copied to clipboard
abstract fun isProximity(): Boolean
Link copied to clipboard
Link copied to clipboard
abstract fun isTransitive(): Boolean
Link copied to clipboard
@NotNull
abstract fun process(samples: Array<Short>, @Nullable result: @Nullable ClientActivation.Result): @NotNull ClientActivation.Result
Processes audio samples.
Link copied to clipboard
abstract fun reset()
Resets the activation state.
Link copied to clipboard
abstract fun setDisabled(disabled: Boolean)
Sets the activation's disabled state.