Developer
Log in

Actions

Avatars

1 action in the Avatars group. Each is its own JSON-RPC method, and also runs through action.run.

avatar.lipsyncAvatar lip sync

Turns a lip-sync pairing on or off: a voice moving an avatar's mouth in an avatar app over VMC (Settings › Avatars). Off, the avatar's mouth closes and Studio stops sending to it. Needs Avatars turned on (Settings › Advanced › Avatars).

Keyscope: control

Parameters

  • pairingtextrequired

    The pairing: its id, or its name ("Cory → Warudo Cory"); choices from the avatars topic.

    Up to 80 characters

  • modechoiceoptional

    On, off, or toggle.

    One of on off toggle · Default "toggle"

Result

  • changedbooleanalways

    False when it already was as asked.

  • enabledbooleanalways

    Whether it runs now.

  • namestringalways

    Its name.

  • pairingstringalways

    The pairing's id.

Live state

avatars.items[pairing].enabled bool

On while the pairing runs. From the avatars topic. How to read it.

Request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "avatar.lipsync",
  "params": {
    "pairing": "<text>"
  }
}

In the SDKs

C#
Task<AvatarLipsyncResult> AvatarLipsyncAsync(AvatarLipsyncParams parameters, CancellationToken cancellationToken = default)
TypeScript
avatarLipsync(params: AvatarLipsyncParams): Promise<AvatarLipsyncResult>
Python
async def avatar_lipsync(self, *, pairing: str, mode: AvatarLipsyncMode | None = None) -> AvatarLipsyncResult
JSON Schema
JSON
{
  "params_schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "additionalProperties": false,
    "properties": {
      "mode": {
        "default": "toggle",
        "description": "On, off, or toggle.",
        "enum": [
          "on",
          "off",
          "toggle"
        ],
        "type": "string"
      },
      "pairing": {
        "description": "The pairing: its id, or its name (\"Cory → Warudo Cory\"); choices from the avatars topic.",
        "maxLength": 80,
        "type": "string"
      }
    },
    "required": [
      "pairing"
    ],
    "type": "object"
  },
  "result_schema": {
    "additionalProperties": false,
    "properties": {
      "changed": {
        "description": "False when it already was as asked.",
        "type": "boolean"
      },
      "enabled": {
        "description": "Whether it runs now.",
        "type": "boolean"
      },
      "name": {
        "description": "Its name.",
        "type": "string"
      },
      "pairing": {
        "description": "The pairing's id.",
        "type": "string"
      }
    },
    "required": [
      "pairing",
      "name",
      "enabled",
      "changed"
    ],
    "type": "object"
  }
}

to open · ↑ ↓ to move · Esc to close