Skip to main content
Corvus Connection

IVtubeStudioApi

Interface
TheOmenDen.StreamPulse.Scripting.IVtubeStudioApiVTube Studio control + read operations available inside a script handler (specs 039 + 041), bound to the local VTube Studio connection. Every method is failure-safe: a disconnected or unauthenticated VTube Studio, a request error, or an unexpected throw is logged (a stable message only, never confidential data) and surfaced as a benign no-op (actions) or an Empty result (queries). A failing call can never propagate out of a node. Query results are the failure-safe records below, so callers/emitted graphs bind fields without guards.

Members

20
  • ActivateExpressionAsync
    method
    Task ActivateExpressionAsync(string expressionFile, bool active, double fadeSeconds = default, CancellationToken cancellationToken = default)
    Activates or deactivates an expression by its file, with an optional fade (seconds).
  • ColorTintAsync
    method
    Task ColorTintAsync(int r, int g, int b, int a, IReadOnlyList<string> artMeshNames = default, CancellationToken cancellationToken = default)
    Tints the current model's art meshes (all when artMeshNames is empty/null).
  • ControlItemAnimationAsync
    method
    Task ControlItemAnimationAsync(string instanceId, bool play, int? frame = default, CancellationToken cancellationToken = default)
    Plays or stops a scene item's animation, optionally jumping to a specific frame.
  • GetCurrentModelAsync
    method
    Task<string> GetCurrentModelAsync(CancellationToken cancellationToken = default)
    The currently loaded model name, or null when none is loaded or not connected.
  • GetCurrentModelInfoAsync
    method
    Task<VtsModelInfo> GetCurrentModelInfoAsync(CancellationToken cancellationToken = default)
    Reads the current model info (name, id, loaded).
  • GetParameterValueAsync
    method
    Task<VtsParameterReading> GetParameterValueAsync(string name, CancellationToken cancellationToken = default)
    Reads a single input parameter (value/min/max/default).
  • GetSceneColorOverlayAsync
    method
    Task<VtsSceneColorOverlay> GetSceneColorOverlayAsync(CancellationToken cancellationToken = default)
    Reads the scene color-overlay state (active + rgb).
  • ListExpressionsAsync
    method
    Task<VtsExpressionList> ListExpressionsAsync(CancellationToken cancellationToken = default)
    Lists the current model's expressions (files + active files).
  • ListHotkeysAsync
    method
    Task<VtsNameIdList> ListHotkeysAsync(CancellationToken cancellationToken = default)
    Lists the current model's hotkeys (names + ids).
  • ListInputParametersAsync
    method
    Task<VtsNameList> ListInputParametersAsync(CancellationToken cancellationToken = default)
    Lists the current model's input parameter names.
  • ListItemsAsync
    method
    Task<VtsItemList> ListItemsAsync(CancellationToken cancellationToken = default)
    Lists the scene items currently loaded (instance ids + file names).
  • ListLive2DParametersAsync
    method
    Task<VtsNameList> ListLive2DParametersAsync(CancellationToken cancellationToken = default)
    Lists the current model's Live2D parameter names.
  • ListModelsAsync
    method
    Task<VtsNameIdList> ListModelsAsync(CancellationToken cancellationToken = default)
    Lists the available models (names + ids).
  • LoadItemAsync
    method
    Task<string> LoadItemAsync(string fileName, double positionX = default, double positionY = default, double size = default, double rotation = default, double fadeSeconds = default, CancellationToken cancellationToken = default)
    Loads a scene item/prop by file name; returns the new instance id, or null on failure.
  • LoadModelAsync
    method
    Task LoadModelAsync(string modelName, CancellationToken cancellationToken = default)
    Loads a model by its display name. An unknown/ambiguous name no-ops.
  • MoveItemAsync
    method
    Task MoveItemAsync(string instanceId, double? positionX = default, double? positionY = default, double? size = default, double? rotation = default, double timeSeconds = default, CancellationToken cancellationToken = default)
    Moves/rotates/scales a scene item by instance id. Null axes are left unchanged.
  • MoveModelAsync
    method
    Task MoveModelAsync(double? positionX = default, double? positionY = default, double? rotation = default, double? size = default, double timeSeconds = default, CancellationToken cancellationToken = default)
    Moves/rotates/scales the current model. Null axes are left unchanged.
  • SetParameterAsync
    method
    Task SetParameterAsync(string parameter, double value, CancellationToken cancellationToken = default)
    Sets a live-model parameter value. A blank parameter no-ops.
  • TriggerHotkeyAsync
    method
    Task TriggerHotkeyAsync(string hotkey, CancellationToken cancellationToken = default)
    Triggers a VTube Studio hotkey by its name or id. A blank name no-ops.
  • UnloadItemAsync
    method
    Task UnloadItemAsync(string instanceId, bool unloadAll = default, CancellationToken cancellationToken = default)
    Unloads a scene item by instance id, or all scene items when unloadAll is true.