Index (vts4j 1.3.4 API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

accept(String) - Method in class dev.adlin.vts4j.network.MessageHandler: Intercepts an inbound raw JSON payload from the network socket and orchestrates its routing.
action() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns the value of the action record component.
addField(String, Boolean) - Method in class dev.adlin.vts4j.request.PayloadBuilder: Appends a boolean property to the JSON object.
addField(String, Character) - Method in class dev.adlin.vts4j.request.PayloadBuilder: Appends a character property to the JSON object.
addField(String, Number) - Method in class dev.adlin.vts4j.request.PayloadBuilder: Appends a numeric property (Integer, Double, Long, etc.) to the JSON object.
addField(String, String) - Method in class dev.adlin.vts4j.request.PayloadBuilder: Appends a text property to the JSON object.
addOfNullable(String, JsonObject) - Method in class dev.adlin.vts4j.request.PayloadBuilder: Conditionally appends a nested JsonObject if the provided value is not null.
animationEventData() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the animationEventData record component.
animationEventTime() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the animationEventTime record component.
animationEventType() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the animationEventType record component.
animationLength() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the animationLength record component.
animationName() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the animationName record component.
API_STATE - Enum constant in enum class dev.adlin.vts4j.request.RequestType
API_STATE_BROADCAST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
APIErrorException - Exception Class in dev.adlin.vts4j.exception
APIErrorException(String, int) - Constructor for exception class dev.adlin.vts4j.exception.APIErrorException
apiName() - Method in record class dev.adlin.vts4j.entity.Request: Returns the value of the apiName record component.
apiName() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the apiName record component.
apiVersion() - Method in record class dev.adlin.vts4j.entity.Request: Returns the value of the apiVersion record component.
apiVersion() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the apiVersion record component.
ART_MESH_COLOR_PRESET - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
ART_MESH_LIST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ART_MESH_SELECTION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
artMeshHits() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the artMeshHits record component.
authenticate(PluginMeta) - Method in interface dev.adlin.vts4j.VTSClient: Requests a brand new authentication token from VTube Studio for the specified plugin metadata.
authenticate(PluginMeta) - Method in class dev.adlin.vts4j.VTSClientImpl
authenticate(PluginMeta, String) - Method in interface dev.adlin.vts4j.VTSClient: Authenticates the plugin session instantly using a previously saved existing authentication token.
authenticate(PluginMeta, String) - Method in class dev.adlin.vts4j.VTSClientImpl
authenticateWithExistingToken(PluginMeta, String) - Method in class dev.adlin.vts4j.authentication.AuthenticationProvider: Authenticates a plugin using an already existing token.
authenticateWithNewToken(PluginMeta) - Method in class dev.adlin.vts4j.authentication.AuthenticationProvider: Performs a full authentication workflow for a plugin by generating a new token.
AUTHENTICATION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
AUTHENTICATION_TOKEN - Enum constant in enum class dev.adlin.vts4j.request.RequestType
AuthenticationProvider - Class in dev.adlin.vts4j.authentication: Authentication provider responsible for managing token requests.
AuthenticationProvider() - Constructor for class dev.adlin.vts4j.authentication.AuthenticationProvider
AVAILABLE_MODELS - Enum constant in enum class dev.adlin.vts4j.request.RequestType
awaitConnect() - Method in class dev.adlin.vts4j.network.NetworkClient: Establishes a synchronous connection to the remote server, blocking the calling thread indefinitely until the handshake completes or fails.
awaitConnect() - Method in interface dev.adlin.vts4j.VTSClient: Establishes a synchronous connection to the remote server, blocking the calling thread indefinitely until the connection handshake completes or fails.
awaitConnect() - Method in class dev.adlin.vts4j.VTSClientImpl
awaitConnect(long, TimeUnit) - Method in class dev.adlin.vts4j.network.NetworkClient: Establishes a synchronous connection to the remote server, blocking the calling thread up to the specified timeout interval.
awaitConnect(long, TimeUnit) - Method in interface dev.adlin.vts4j.VTSClient: Establishes a synchronous connection to the remote server, blocking the calling thread up to the specified timeout interval.
awaitConnect(long, TimeUnit) - Method in class dev.adlin.vts4j.VTSClientImpl
awaitDisconnect() - Method in class dev.adlin.vts4j.network.NetworkClient: Synchronously tears down the active socket session, blocking the calling thread until the close handshake is acknowledged.
awaitDisconnect() - Method in interface dev.adlin.vts4j.VTSClient: Synchronously tears down the active socket session, blocking the calling thread until the close handshake is acknowledged.
awaitDisconnect() - Method in class dev.adlin.vts4j.VTSClientImpl

B

BackgroundChangedEvent - Record Class in dev.adlin.vts4j.event.impl
BackgroundChangedEvent(String) - Constructor for record class dev.adlin.vts4j.event.impl.BackgroundChangedEvent: Creates an instance of a BackgroundChangedEvent record class.
backgroundName() - Method in record class dev.adlin.vts4j.event.impl.BackgroundChangedEvent: Returns the value of the backgroundName record component.
build() - Method in class dev.adlin.vts4j.request.PayloadBuilder: Concludes the construction process and returns the fully assembled JSON structure.
build() - Method in class dev.adlin.vts4j.request.RequestBuilder: Builds and returns a new Request object with the configured parameters.
build() - Method in class dev.adlin.vts4j.VTSClientBuilder: Assembles, interconnects, and encapsulates all architectural layers into a ready-to-use VTSClient.
builder() - Static method in class dev.adlin.vts4j.request.PayloadBuilder: Creates a new fluent instance of PayloadBuilder.

C

CALIBRATE_CAM - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
callEvent(Event) - Method in class dev.adlin.vts4j.event.EventHandler: Dispatches the specified event to all registered listeners subscribed to its type.
CHANGE_BACKGROUND - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
CHANGE_IDLE_ANIMATION - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
CHANGE_VTS_MODEL - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
clickedArtMeshCount() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the clickedArtMeshCount record component.
clickPosition() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the clickPosition record component.
closeAll() - Method in class dev.adlin.vts4j.request.RequestDispatcher: Purges all active pending trackers and forces their exceptional completion.
closeReason() - Method in record class dev.adlin.vts4j.event.impl.WebsocketCloseEvent: Returns the value of the closeReason record component.
CloseReason - Record Class in dev.adlin.vts4j.network: An object for convenient work with reasons for WebSocket closure
CloseReason(int, String, boolean) - Constructor for record class dev.adlin.vts4j.network.CloseReason: Creates an instance of a CloseReason record class.
code() - Method in record class dev.adlin.vts4j.network.CloseReason: Returns the value of the code record component.
COLOR_TINT - Enum constant in enum class dev.adlin.vts4j.request.RequestType
connect() - Method in class dev.adlin.vts4j.network.NetworkClient: Initiates a non-blocking background connection routine to the remote server.
connect() - Method in interface dev.adlin.vts4j.VTSClient: Initiates a non-blocking background connection routine to the remote VTube Studio server.
connect() - Method in class dev.adlin.vts4j.VTSClientImpl
connected() - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Returns the value of the connected record component.
contains(String) - Method in class dev.adlin.vts4j.request.RequestDispatcher: Verifies if a specific request identifier is currently registered and awaiting a server reply.
convexHull() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns the value of the convexHull record component.
convexHullCenter() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns the value of the convexHullCenter record component.
counter() - Method in record class dev.adlin.vts4j.event.impl.TestEvent: Returns the value of the counter record component.
create() - Static method in class dev.adlin.vts4j.VTSClientBuilder: Initializes a fresh fluent instance of VTSClientBuilder.
CURRENT_MODEL - Enum constant in enum class dev.adlin.vts4j.request.RequestType
currentOnState() - Method in record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Returns the value of the currentOnState record component.
currentPreset() - Method in record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Returns the value of the currentPreset record component.

D

description() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns the value of the description record component.
dev.adlin.vts4j - package dev.adlin.vts4j
dev.adlin.vts4j.authentication - package dev.adlin.vts4j.authentication
dev.adlin.vts4j.entity - package dev.adlin.vts4j.entity
dev.adlin.vts4j.event - package dev.adlin.vts4j.event
dev.adlin.vts4j.event.impl - package dev.adlin.vts4j.event.impl
dev.adlin.vts4j.exception - package dev.adlin.vts4j.exception
dev.adlin.vts4j.hotkey - package dev.adlin.vts4j.hotkey
dev.adlin.vts4j.network - package dev.adlin.vts4j.network
dev.adlin.vts4j.request - package dev.adlin.vts4j.request
developer() - Method in record class dev.adlin.vts4j.PluginMeta: Returns the value of the developer record component.
disconnect() - Method in class dev.adlin.vts4j.network.NetworkClient: Initiates an asynchronous non-blocking disconnection routine.
disconnect() - Method in interface dev.adlin.vts4j.VTSClient: Initiates an asynchronous, non-blocking disconnection routine to close the socket session.
disconnect() - Method in class dev.adlin.vts4j.VTSClientImpl
dispatch(Response) - Method in class dev.adlin.vts4j.request.RequestDispatcher: Routes an incoming response from the network layer to its corresponding pending future track.
DOWNLOAD_RANDOM_WORKSHOP_ITEM - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction

E

equals(Object) - Method in record class dev.adlin.vts4j.entity.Request: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.entity.Response: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.BackgroundChangedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.TestEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.WebsocketCloseEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.WebsocketErrorEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.event.impl.WebsocketOpenEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.network.CloseReason: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.adlin.vts4j.PluginMeta: Indicates whether some other object is "equal to" this one.
Event - Interface in dev.adlin.vts4j.event: A marker interface representing the root of all system and network-driven events.
EVENT_SUBSCRIPTION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
EventHandler - Class in dev.adlin.vts4j.event: Event handler (Event Bus) responsible for registering event listeners and dispatching events to their respective subscribers based on priority.
EventHandler() - Constructor for class dev.adlin.vts4j.event.EventHandler
EventListener - Annotation Interface in dev.adlin.vts4j.event: Annotation used to mark methods that act as subscribers for system events.
EventPriority - Enum Class in dev.adlin.vts4j.event: Represents the execution priority for event listeners managed by the EventHandler.
EventRegistry - Class in dev.adlin.vts4j.event: A registry that provides bidirectional mapping between unique event string identifiers and their respective Event class types.
EventRegistry() - Constructor for class dev.adlin.vts4j.event.EventRegistry
EventSubscriptionProvider - Class in dev.adlin.vts4j.event: Provider responsible for managing event subscriptions by sending subscribe or unsubscribe requests to the remote server via a request dispatcher.
EventSubscriptionProvider() - Constructor for class dev.adlin.vts4j.event.EventSubscriptionProvider
exception() - Method in record class dev.adlin.vts4j.event.impl.WebsocketErrorEvent: Returns the value of the exception record component.
EXECUTE_ITEM_ACTION - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
exists(Class<? extends Event>) - Static method in class dev.adlin.vts4j.event.EventRegistry: Checks if the specified event class is registered.
exists(String) - Static method in class dev.adlin.vts4j.event.EventRegistry: Checks if the specified event name identifier is registered.
EXPRESSION_ACTIVATION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
EXPRESSION_STATE - Enum constant in enum class dev.adlin.vts4j.request.RequestType

F

FACE_FOUND - Enum constant in enum class dev.adlin.vts4j.request.RequestType
faceFound() - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Returns the value of the faceFound record component.
findByName(String) - Method in class dev.adlin.vts4j.hotkey.Hotkeys: Searches the local cache for a hotkey with the specified human-readable name.

G

GET_CURRENT_MODEL_PHYSICS - Enum constant in enum class dev.adlin.vts4j.request.RequestType
getEventClass(RequestType) - Static method in class dev.adlin.vts4j.event.EventRegistry: Resolves the Event class associated with the string representation of a request type.
getEventClass(String) - Static method in class dev.adlin.vts4j.event.EventRegistry: Resolves the Event class associated with the provided unique event name.
getHotkeys() - Method in class dev.adlin.vts4j.hotkey.Hotkeys: Returns an unmodifiable thread-safe view of the currently cached hotkeys.
getName(Class<? extends Event>) - Static method in class dev.adlin.vts4j.event.EventRegistry: Retrieves the unique string name identifier for the given event class.

H

handshake() - Method in record class dev.adlin.vts4j.event.impl.WebsocketOpenEvent: Returns the value of the handshake record component.
hashCode() - Method in record class dev.adlin.vts4j.entity.Request: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.entity.Response: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.BackgroundChangedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.TestEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.WebsocketCloseEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.WebsocketErrorEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.event.impl.WebsocketOpenEvent: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.network.CloseReason: Returns a hash code value for this object.
hashCode() - Method in record class dev.adlin.vts4j.PluginMeta: Returns a hash code value for this object.
HIGH - Enum constant in enum class dev.adlin.vts4j.event.EventPriority
Hotkey - Record Class in dev.adlin.vts4j.hotkey: The object needed for deserialization into JSON.
Hotkey(String, HotkeyAction, String, String, String) - Constructor for record class dev.adlin.vts4j.hotkey.Hotkey: Creates an instance of a Hotkey record class.
HOTKEY_TRIGGER - Enum constant in enum class dev.adlin.vts4j.request.RequestType
hotkeyAction() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the hotkeyAction record component.
HotkeyAction - Enum Class in dev.adlin.vts4j.hotkey: Represents the available actions that can be triggered via hotkeys.
hotkeyConfigChanged() - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Returns the value of the hotkeyConfigChanged record component.
hotkeyFile() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the hotkeyFile record component.
hotkeyId() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the hotkeyId record component.
hotkeyName() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the hotkeyName record component.
Hotkeys - Class in dev.adlin.vts4j.hotkey: Manages hotkey operations by loading available hotkeys, triggering executions, and providing a fast-access thread-safe local cache for hotkey information.
Hotkeys() - Constructor for class dev.adlin.vts4j.hotkey.Hotkeys
HOTKEYS_IN_CURRENT_MODEL - Enum constant in enum class dev.adlin.vts4j.request.RequestType
hotkeyTriggeredByAPI() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the hotkeyTriggeredByAPI record component.
HotkeyTriggeredEvent - Record Class in dev.adlin.vts4j.event.impl
HotkeyTriggeredEvent(String, String, String, String, Boolean, String, String, Boolean) - Constructor for record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Creates an instance of a HotkeyTriggeredEvent record class.

I

icon() - Method in record class dev.adlin.vts4j.PluginMeta: Returns the value of the icon record component.
id() - Method in record class dev.adlin.vts4j.entity.Request: Returns the value of the id record component.
id() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns the value of the id record component.
INJECT_PARAMETER_DATA - Enum constant in enum class dev.adlin.vts4j.request.RequestType
INPUT_PARAMETER_LIST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
isIdleAnimation() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the isIdleAnimation record component.
isLive2DItem() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the isLive2DItem record component.
isLive2DItem() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the isLive2DItem record component.
ITEM_ANIMATION_CONTROL - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_LIST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_LOAD - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_MOVE - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_PIN - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_SORT - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ITEM_UNLOAD - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ItemEvent - Record Class in dev.adlin.vts4j.event.impl
ItemEvent(String, String, String, JsonObject) - Constructor for record class dev.adlin.vts4j.event.impl.ItemEvent: Creates an instance of a ItemEvent record class.
itemEventType() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns the value of the itemEventType record component.
itemFileName() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns the value of the itemFileName record component.
itemInstanceId() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns the value of the itemInstanceId record component.
itemInstanceID() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns the value of the itemInstanceID record component.
itemPosition() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns the value of the itemPosition record component.

L

leftHandFound() - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Returns the value of the leftHandFound record component.
Listener - Interface in dev.adlin.vts4j.event: A marker interface used to discover and register event listener classes within the EventHandler.
LIVE2D_PARAMETER_LIST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
Live2DCubismEditorConnectedEvent - Record Class in dev.adlin.vts4j.event.impl
Live2DCubismEditorConnectedEvent(Boolean, Boolean, Boolean) - Constructor for record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Creates an instance of a Live2DCubismEditorConnectedEvent record class.
LOAD_EFFECT_PRESET - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
loadedModelId() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the loadedModelId record component.
loadedModelName() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the loadedModelName record component.
LOW - Enum constant in enum class dev.adlin.vts4j.event.EventPriority

M

MessageHandler - Class in dev.adlin.vts4j.network: Core inbound message broker responsible for intercepting raw text payloads from the network, parsing them into system responses, and routing them either to awaiting request futures or distributing them as system events via the event bus.
MessageHandler() - Constructor for class dev.adlin.vts4j.network.MessageHandler
MODEL_LOAD - Enum constant in enum class dev.adlin.vts4j.request.RequestType
ModelAnimationEvent - Record Class in dev.adlin.vts4j.event.impl
ModelAnimationEvent(String, Double, String, String, Double, Boolean, String, String, Boolean) - Constructor for record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Creates an instance of a ModelAnimationEvent record class.
ModelClickedEvent - Record Class in dev.adlin.vts4j.event.impl
ModelClickedEvent(Boolean, String, String, Boolean, Integer, JsonObject, JsonObject, Integer, JsonObject) - Constructor for record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Creates an instance of a ModelClickedEvent record class.
ModelConfigChangedEvent - Record Class in dev.adlin.vts4j.event.impl
ModelConfigChangedEvent(String, String, Boolean) - Constructor for record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Creates an instance of a ModelConfigChangedEvent record class.
modelId() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the modelId record component.
modelId() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the modelId record component.
modelId() - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Returns the value of the modelId record component.
modelId() - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Returns the value of the modelId record component.
modelId() - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Returns the value of the modelId record component.
modelId() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns the value of the modelId record component.
modelLoaded() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the modelLoaded record component.
modelLoaded() - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Returns the value of the modelLoaded record component.
ModelLoadedEvent - Record Class in dev.adlin.vts4j.event.impl
ModelLoadedEvent(Boolean, String, String) - Constructor for record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Creates an instance of a ModelLoadedEvent record class.
ModelMovedEvent - Record Class in dev.adlin.vts4j.event.impl
ModelMovedEvent(String, String, JsonObject) - Constructor for record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Creates an instance of a ModelMovedEvent record class.
modelName() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns the value of the modelName record component.
modelName() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns the value of the modelName record component.
modelName() - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Returns the value of the modelName record component.
modelName() - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Returns the value of the modelName record component.
modelName() - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Returns the value of the modelName record component.
modelName() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns the value of the modelName record component.
ModelOutlineEvent - Record Class in dev.adlin.vts4j.event.impl
ModelOutlineEvent(String, String, JsonObject, JsonObject, JsonObject) - Constructor for record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Creates an instance of a ModelOutlineEvent record class.
modelPosition() - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Returns the value of the modelPosition record component.
modelWasClicked() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the modelWasClicked record component.
mouseButtonId() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the mouseButtonId record component.
MOVE_MODEL - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
MOVE_MODEL - Enum constant in enum class dev.adlin.vts4j.request.RequestType

N

name() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns the value of the name record component.
name() - Method in record class dev.adlin.vts4j.PluginMeta: Returns the value of the name record component.
NDI_CONFIG - Enum constant in enum class dev.adlin.vts4j.request.RequestType
NetworkClient - Class in dev.adlin.vts4j.network: High-level network client that delegates infrastructure operations to an underlying socket client.
NetworkClient(URI) - Constructor for class dev.adlin.vts4j.network.NetworkClient
NORMAL - Enum constant in enum class dev.adlin.vts4j.event.EventPriority

O

of(RequestType) - Static method in class dev.adlin.vts4j.request.RequestBuilder
of(String) - Static method in class dev.adlin.vts4j.request.RequestBuilder
onClose(int, String, boolean) - Method in class dev.adlin.vts4j.network.SocketClient
onError(Exception) - Method in class dev.adlin.vts4j.network.SocketClient
onMessage(String) - Method in class dev.adlin.vts4j.network.SocketClient
onOpen(ServerHandshake) - Method in class dev.adlin.vts4j.network.SocketClient

P

PARAMETER_CREATION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
PARAMETER_DELETION - Enum constant in enum class dev.adlin.vts4j.request.RequestType
PARAMETER_VALUE - Enum constant in enum class dev.adlin.vts4j.request.RequestType
payload() - Method in record class dev.adlin.vts4j.entity.Request: Returns the value of the payload record component.
payload() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the payload record component.
PayloadBuilder - Class in dev.adlin.vts4j.request: A fluent builder utility designed for constructing GSON JsonObject instances.
PayloadBuilder() - Constructor for class dev.adlin.vts4j.request.PayloadBuilder
PluginMeta - Record Class in dev.adlin.vts4j: An immutable data record representing metadata configuration for a plugin.
PluginMeta(String, String) - Constructor for record class dev.adlin.vts4j.PluginMeta: Overloaded constructor to initialize plugin metadata without an icon.
PluginMeta(String, String, String) - Constructor for record class dev.adlin.vts4j.PluginMeta: Creates an instance of a PluginMeta record class.
POST_PROCESSING_LIST - Enum constant in enum class dev.adlin.vts4j.request.RequestType
POST_PROCESSING_UPDATE - Enum constant in enum class dev.adlin.vts4j.request.RequestType
PostProcessingEvent - Record Class in dev.adlin.vts4j.event.impl
PostProcessingEvent(Boolean, String) - Constructor for record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Creates an instance of a PostProcessingEvent record class.
priority() - Element in annotation interface dev.adlin.vts4j.event.EventListener: Defines the execution priority of the annotated event listener.

R

reason() - Method in record class dev.adlin.vts4j.network.CloseReason: Returns the value of the reason record component.
refresh() - Method in class dev.adlin.vts4j.hotkey.Hotkeys: Refreshes the internal cache by fetching the latest hotkeys from VTube Studio.
registerEventListener(Listener) - Method in interface dev.adlin.vts4j.VTSClient: Registers an event listener object within the client's internal event bus.
registerEventListener(Listener) - Method in class dev.adlin.vts4j.VTSClientImpl
registerListener(Listener) - Method in class dev.adlin.vts4j.event.EventHandler: Scans the provided listener instance for valid event listener methods and registers them.
registerListeners(Listener...) - Method in class dev.adlin.vts4j.VTSClientBuilder: Registers one or more initial event listener subscribers to the client's event bus upon construction.
RELOAD_MICROPHONE - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
RELOAD_TEXTURES - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
remote() - Method in record class dev.adlin.vts4j.network.CloseReason: Returns the value of the remote record component.
REMOVE_ALL_EXPRESSIONS - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
REMOVE_ALL_ITEMS - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
Request - Record Class in dev.adlin.vts4j.entity: An object used to deserialize a request into JSON format and send it to the server.
Request(String, String, String, String, JsonObject) - Constructor for record class dev.adlin.vts4j.entity.Request: Creates an instance of a Request record class.
RequestBuilder - Class in dev.adlin.vts4j.request
RequestBuilder() - Constructor for class dev.adlin.vts4j.request.RequestBuilder
RequestDispatcher - Class in dev.adlin.vts4j.request: Dispatches outbound requests, manages tracking futures for expected asynchronous responses, and routes inbound network responses back to their matching execution tracks.
RequestDispatcher() - Constructor for class dev.adlin.vts4j.request.RequestDispatcher
requestId() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the requestId record component.
requestType() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the requestType record component.
RequestType - Enum Class in dev.adlin.vts4j.request: Types of Request
Response - Record Class in dev.adlin.vts4j.entity: An object used to serialize the response from the server.
Response(String, String, long, String, String, JsonObject) - Constructor for record class dev.adlin.vts4j.entity.Response: Creates an instance of a Response record class.
rightHandFound() - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Returns the value of the rightHandFound record component.

S

SCENE_COLOR_OVERLAY_INFO - Enum constant in enum class dev.adlin.vts4j.request.RequestType
SCREEN_COLOR_OVERLAY - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
send(Request) - Method in class dev.adlin.vts4j.request.RequestDispatcher: Dispatches an asynchronous request over the network layer and registers a tracking future to capture the incoming response.
send(String) - Method in class dev.adlin.vts4j.network.NetworkClient: Transmits a raw string payload over the active socket session.
sendRequest(Request) - Method in interface dev.adlin.vts4j.VTSClient: Serializes and dispatches an asynchronous request packet to the server over the active socket session.
sendRequest(Request) - Method in class dev.adlin.vts4j.VTSClientImpl
sendSubscribeRequest(Class<? extends Event>, JsonObject, boolean) - Method in class dev.adlin.vts4j.event.EventSubscriptionProvider: Sends an asynchronous event subscription or unsubscription request to the remote server.
SET_CURRENT_MODEL_PHYSICS - Enum constant in enum class dev.adlin.vts4j.request.RequestType
setAddress(URI) - Method in class dev.adlin.vts4j.VTSClientBuilder: Configures the target destination WebSocket address for the VTube Studio API server.
setApiName(String) - Method in class dev.adlin.vts4j.request.RequestBuilder: Sets the name of the API for the request.
setApiVersion(String) - Method in class dev.adlin.vts4j.request.RequestBuilder: Sets the version of the API for the request.
setCloseHandler(Consumer<CloseReason>) - Method in class dev.adlin.vts4j.network.NetworkClient: Assigns a callback hook triggered immediately after the socket session terminates.
setCloseHandler(Consumer<CloseReason>) - Method in class dev.adlin.vts4j.network.SocketClient: Sets the handler to be called when the WebSocket connection terminates.
setErrorHandler(Consumer<Exception>) - Method in class dev.adlin.vts4j.network.NetworkClient: Assigns a custom error monitoring callback hook.
setErrorHandler(Consumer<Exception>) - Method in class dev.adlin.vts4j.network.SocketClient: Sets the handler to be called when an unhandled exception or protocol error occurs.
setMessageHandler(Consumer<String>) - Method in class dev.adlin.vts4j.network.NetworkClient: Assigns the main core callback interceptor for incoming data packets.
setMessageHandler(Consumer<String>) - Method in class dev.adlin.vts4j.network.SocketClient: Sets the handler to be called when a raw string message frame is received from the WebSocket.
setOpenHandler(Consumer<ServerHandshake>) - Method in class dev.adlin.vts4j.network.NetworkClient: Assigns a callback hook triggered upon successful completion of the opening handshake.
setOpenHandler(Consumer<ServerHandshake>) - Method in class dev.adlin.vts4j.network.SocketClient: Sets the handler to be called when the WebSocket connection is opened.
setPayload(JsonObject) - Method in class dev.adlin.vts4j.request.RequestBuilder: Sets payload required for certain types of requests.
setRequestId(String) - Method in class dev.adlin.vts4j.request.RequestBuilder: Sets the unique identifier for the request.
shouldSendParameters() - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Returns the value of the shouldSendParameters record component.
SocketClient - Class in dev.adlin.vts4j.network: Low-level WebSocket client implementation that bridges underlying socket events (open, message, close, error) to configurable functional consumers.
SocketClient(URI) - Constructor for class dev.adlin.vts4j.network.SocketClient: Constructs a new SocketClient with the specified remote server URI.
STATISTICS - Enum constant in enum class dev.adlin.vts4j.request.RequestType
subscribe(Class<? extends Event>) - Method in interface dev.adlin.vts4j.VTSClient: Subscribes the current plugin session to a specific system event type using default configurations.
subscribe(Class<? extends Event>) - Method in class dev.adlin.vts4j.VTSClientImpl
subscribe(Class<? extends Event>, JsonObject) - Method in interface dev.adlin.vts4j.VTSClient: Subscribes the current plugin session to a specific system event type using extended configuration arguments.
subscribe(Class<? extends Event>, JsonObject) - Method in class dev.adlin.vts4j.VTSClientImpl

T

TAKE_SCREENSHOT - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TestEvent - Record Class in dev.adlin.vts4j.event.impl
TestEvent(String, Integer) - Constructor for record class dev.adlin.vts4j.event.impl.TestEvent: Creates an instance of a TestEvent record class.
testMessage() - Method in record class dev.adlin.vts4j.event.impl.TestEvent: Returns the value of the testMessage record component.
timestamp() - Method in record class dev.adlin.vts4j.entity.Response: Returns the value of the timestamp record component.
TOGGLE_EXPRESSION - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TOGGLE_ITEM_SCENE - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TOGGLE_LIVE2D_EDITOR_API - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TOGGLE_MODEL_SOUND - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TOGGLE_TRACKER - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
TOGGLE_TWITCH_FEATURE - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
toString() - Method in record class dev.adlin.vts4j.entity.Request: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.entity.Response: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.BackgroundChangedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.HotkeyTriggeredEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ItemEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelAnimationEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelConfigChangedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelLoadedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelMovedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.PostProcessingEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.TestEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.WebsocketCloseEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.WebsocketErrorEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.event.impl.WebsocketOpenEvent: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.hotkey.Hotkey: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.network.CloseReason: Returns a string representation of this record class.
toString() - Method in record class dev.adlin.vts4j.PluginMeta: Returns a string representation of this record class.
toString() - Method in enum class dev.adlin.vts4j.request.RequestType
TrackingStatusChangedEvent - Record Class in dev.adlin.vts4j.event.impl
TrackingStatusChangedEvent(Boolean, Boolean, Boolean) - Constructor for record class dev.adlin.vts4j.event.impl.TrackingStatusChangedEvent: Creates an instance of a TrackingStatusChangedEvent record class.
trigger(Hotkey) - Method in class dev.adlin.vts4j.hotkey.Hotkeys: Triggers the specified hotkey execution on the remote server.
trigger(String) - Method in class dev.adlin.vts4j.hotkey.Hotkeys: Triggers the hotkey that matches the specified human-readable name.
TRIGGER_ANIMATION - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
tryingToConnect() - Method in record class dev.adlin.vts4j.event.impl.Live2DCubismEditorConnectedEvent: Returns the value of the tryingToConnect record component.
type() - Method in record class dev.adlin.vts4j.entity.Request: Returns the value of the type record component.

U

UNSET - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
unsubscribe(Class<? extends Event>) - Method in interface dev.adlin.vts4j.VTSClient: Unsubscribes the current plugin session from all instances of the specified system event type.
unsubscribe(Class<? extends Event>) - Method in class dev.adlin.vts4j.VTSClientImpl
unsubscribe(Class<? extends Event>, JsonObject) - Method in interface dev.adlin.vts4j.VTSClient: Unsubscribes the current plugin session from a specific system event matching the provided configuration filters.
unsubscribe(Class<? extends Event>, JsonObject) - Method in class dev.adlin.vts4j.VTSClientImpl

V

valueOf(String) - Static method in enum class dev.adlin.vts4j.event.EventPriority: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.adlin.vts4j.hotkey.HotkeyAction: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.adlin.vts4j.request.RequestType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.adlin.vts4j.event.EventPriority: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.adlin.vts4j.hotkey.HotkeyAction: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.adlin.vts4j.request.RequestType: Returns an array containing the constants of this enum class, in the order they are declared.
VTS_FOLDER_INFO - Enum constant in enum class dev.adlin.vts4j.request.RequestType
VTSClient - Interface in dev.adlin.vts4j: The primary high-level client interface for interacting with the VTube Studio Public API.
VTSClientBuilder - Class in dev.adlin.vts4j: A fluent builder utility designed to orchestrate dependency injection, wire internal network handlers, and construct fully initialized VTSClient instances.
VTSClientBuilder() - Constructor for class dev.adlin.vts4j.VTSClientBuilder
VTSClientImpl - Class in dev.adlin.vts4j: Robust implementation of the VTSClient interface.
VTSClientImpl(NetworkClient, EventHandler, RequestDispatcher) - Constructor for class dev.adlin.vts4j.VTSClientImpl

W

WEB_ITEM_ACTION - Enum constant in enum class dev.adlin.vts4j.hotkey.HotkeyAction
WebsocketCloseEvent - Record Class in dev.adlin.vts4j.event.impl
WebsocketCloseEvent(CloseReason) - Constructor for record class dev.adlin.vts4j.event.impl.WebsocketCloseEvent: Creates an instance of a WebsocketCloseEvent record class.
WebsocketErrorEvent - Record Class in dev.adlin.vts4j.event.impl
WebsocketErrorEvent(Exception) - Constructor for record class dev.adlin.vts4j.event.impl.WebsocketErrorEvent: Creates an instance of a WebsocketErrorEvent record class.
WebsocketOpenEvent - Record Class in dev.adlin.vts4j.event.impl
WebsocketOpenEvent(ServerHandshake) - Constructor for record class dev.adlin.vts4j.event.impl.WebsocketOpenEvent: Creates an instance of a WebsocketOpenEvent record class.
windowSize() - Method in record class dev.adlin.vts4j.event.impl.ModelClickedEvent: Returns the value of the windowSize record component.
windowSize() - Method in record class dev.adlin.vts4j.event.impl.ModelOutlineEvent: Returns the value of the windowSize record component.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form