su.plo.voice.api.client.audio.capture

Interface ClientActivation

All Superinterfaces:

Activation

public interface ClientActivation
extends Activation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientActivation.Result
static class	ClientActivation.Type

Method Summary

Modifier and Type	Method and Description
int	getDistance()
KeyBinding	getDistanceDecreaseKey()
KeyBinding	getDistanceIncreaseKey()
long	getLastActivation()
KeyBinding	getPttKey()
KeyBinding	getToggleKey()
ClientActivation.Type	getType()
boolean	isActivated() Checks if activation is activated
boolean	isDisabled() Checks if activation is disabled by toggle or manually by setDisabled(boolean)
@NotNull ClientActivation.Result	process(short[] samples, @Nullable ClientActivation.Result result)
void	reset()
void	setDisabled(boolean disabled) Sets the activation's disabled state If activation is disabled, it always returns ClientActivation.Result.NOT_ACTIVATED in the process(short[], Result) method

Methods inherited from interface su.plo.voice.proto.data.audio.capture.Activation

getDefaultDistance, getDistances, getIcon, getId, getMaxDistance, getMinDistance, getName, getTranslation, getWeight, isProximity, isStereoSupported, isTransitive

Method Detail

getType

ClientActivation.Type getType()

getPttKey

KeyBinding getPttKey()

getToggleKey

KeyBinding getToggleKey()

getDistanceIncreaseKey

KeyBinding getDistanceIncreaseKey()

getDistanceDecreaseKey

KeyBinding getDistanceDecreaseKey()

setDisabled

void setDisabled(boolean disabled)

Sets the activation's disabled state If activation is disabled, it always returns ClientActivation.Result.NOT_ACTIVATED in the process(short[], Result) method

Parameters:

disabled -

isDisabled

boolean isDisabled()

Checks if activation is disabled by toggle or manually by setDisabled(boolean)

Returns:

true if activation is disabled

isActivated

boolean isActivated()

Checks if activation is activated

Returns:

true if activation is activated

getLastActivation

long getLastActivation()

getDistance

int getDistance()

process

@NotNull
@NotNull ClientActivation.Result process(short[] samples,
                                                   @Nullable
                                                   @Nullable ClientActivation.Result result)

reset

void reset()