Module vtubestudio::data
source · [−]Expand description
Request/response types for the VTube Studio API.
- For a list of all request types, see the implementors for
Request. - For the corresponding response types, see
Response. - For event types specifically, see
EventandEventConfig.
Structs
Error returned by the VTube Studio API.
Get the current state of the API.
The API state.
Requesting list of art meshes in current model.
List of art meshes.
Used in
ColorTintRequest.Asking user to select ArtMeshes.
ArtMesh selection response.
Authenticate with the API using a token.
Whether the authentication request was successful.
Request an authentication token.
Authentication token response.
Used in
ItemListResponse.Getting a list of available VTS models
List of available models.
An event that is triggered every time the background is changed by the user
(manually or via hotkey).
Config for
BackgroundChangedEvent.
Used in EventSubscriptionRequest.Used in
ColorTintRequest.Tint art meshes with color
Number of matched art meshes.
Getting the currently loaded model.
Information about the current model.
Wrapper type for an
enum with a serialized string representation.Subscribe or unsubscribe from events.
Information about subscriptions.
Used in
ExpressionStateResponse.Requesting activation or deactivation of expressions.
Empty response on successful expression activation/deactivation.
Used in
Expression.Requesting current expression state list.
Data about the requested expressions.
Used in
Expression.Checking if face is currently found by tracker.
Whether the face was found.
Get the physics settings of the current model.
Data about the requested physics settings.
Used in
HotkeysInCurrentModelResponse.Requesting execution of hotkeys.
The hotkey that was triggered.
Requesting list of hotkeys available in current or other VTS model.
Model info and list of hotkeys.
Feeding in data for default or custom parameters.
Empty response on parameter injection success.
Requesting list of available tracking parameters.
List of available parameters.
Controling items and item animations.
Item animation updated successfully.
Used in
ItemListResponse.Requesting list of available items or items in scene.
Item data.
Loading item into the scene.
Item loaded successfully.
Moving items in the scene.
Item movement requested successfully.
Used in
ItemMoveRequest.Removing item from the scene.
Items unloaded successfully.
Get the value for all Live2D parameters in the current model.
Info about the current model and list of parameters.
Used in
AvailableModelsResponse.An event that is triggered every time the user manually changes the the
settings/config of the currently loaded VTube Studio model.
Config for
ModelConfigChangedEvent.
Used in EventSubscriptionRequest.Loading a VTS model by its ID.
Information about the loaded model ID.
An event that is triggered every time a VTube Studio model is loaded or unloaded.
Config for
ModelLoadedEvent.
Used in EventSubscriptionRequest.An event that is triggered every time a model is moved, resized or rotated.
Config for
ModelMovedEvent.
Used in EventSubscriptionRequest.An event that is triggered at a constant 15 FPS and sends subscribed plugins the
model outline.
Config for
ModelOutlineEvent.
Used in EventSubscriptionRequest.Used in
CurrentModelResponse and ModelMovedEvent.Moving the currently loaded VTS model.
Empty response on model move success.
Used in
ItemMoveResponse.Get and set NDI settings.
Data about the requested expressions.
Arbitrary JSON data used in
RequestEnvelope and ResponseEnvelope.Adding new tracking parameters (“custom parameters”).
Name of the created parameter.
Delete custom parameters.
Name of the deleted parameter.
Get the value for one specific parameter, default or custom.
The requested parameter.
A VTube Studio API request.
Request ID used in
RequestEnvelope and ResponseEnvelope.Response data wrapper for
ResponseEnvelope (typically for non-error responses).A VTube Studio API response.
Getting scene lighting overlay color.
Info about the color overlay.
Overriding physics settings of currently loaded VTS model.
Empty response on successful physics override.
Getting current VTS statistics.
Statistics about the VTube Studio session.
An event for testing the event API.
Config for
TestEvent.
Used in EventSubscriptionRequest.An event that is triggered every time the face tracker finds/loses the face or
hands.
Config for
TrackingStatusChangedEvent.
Used in EventSubscriptionRequest.Used in
ItemUnloadResponse.API server discovery message (sent over UDP).
Struct representing a coordinate or dimensions. Used in
ModelOutlineEvent.Getting list of VTS folders.
Names of various folders in the
StreamingAssets directory.Enums
Event types. Events can be requested via
EventSubscriptionRequest.Known message types for
EnumString<FadeMode>. Used in ItemToMove.Known hotkey types for
EnumString<HotkeyAction>. Used in Hotkey.Known message types for
EnumString<InjectParameterDataMode> (used in
InjectParameterDataRequest).Known message types for
EnumString<ItemType>. Used in ItemInstanceInScene.Known message types for
EnumString<RequestType>.Known message types for
EnumString<ResponseType>.Constants
The default
api_name value in requests and responses.The default
api_version value in requests and responses.Traits
Trait describing a VTube Studio event’s config.
Trait describing VTube Studio event data.
Trait describing a VTube Studio request. Used to set data in
RequestEnvelope.Trait describing a VTube Studio response. Typically parsed from
ResponseEnvelope.