JSPM

ttls-controller

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q70636F
  • License MIT

CLI tool to control TikTok Live Studio (TTLS) via its local Socket.IO API

Package Exports

  • ttls-controller
  • ttls-controller/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ttls-controller) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TTLS Controller CLI

Control TikTok Live Studio (TTLS) directly from your terminal! 🎬✨

This is a modern Node.js Command Line Interface (CLI) built on top of a reverse-engineered local Socket.IO API that TTLS uses to communicate with its official Elgato Stream Deck plugin.

Features

  • 🕵️ Port Scanning: Automatically finds and connects to the active TTLS local server.
  • 🔄 State Sync: Retrieve the current scenes and settings from TTLS.
  • 🎬 Scene Switcher: Switch to any of your scenes with a single command.
  • 🎛️ Quick Toggles: Toggle your Microphone, System Audio, Recording, and Live status instantly.

Installation

You can install ttls-cli globally via npm to make it available anywhere on your system.

npm install -g @2null/ttls-controller

(Note: If you are running from the source repository, you can use npm link instead to install the CLI locally.)

Usage

Once installed, you can use the ttls-cli command anywhere in your terminal.

1. Get Current Info

Connects to TTLS, fetches current settings (like active and available scenes), and prints the data:

ttls-cli info

2. Switch Scenes

Switch your TTLS layout to a specific scene by name:

ttls-cli scene "Just Chatting"

3. Toggles

Quickly toggle specific stream states. The <target> can be mic, audio, record, or live:

# Toggle the Microphone
ttls-cli toggle mic

# Toggle Desktop/System Audio
ttls-cli toggle audio

# Toggle Local Recording
ttls-cli toggle record

# Start / End the LIVE broadcast
ttls-cli toggle live

How It Works 🛠️

TikTok Live Studio hosts a local Socket.IO server designed to communicate with the official Elgato Stream Deck plugin. Here is how ttls-cli interacts with it:

  1. Port Scanning: TTLS runs its Socket.IO server on one of several known ports (e.g., 28189, 39728, 34246, 42205, 38534, 40825, 40622). The CLI attempts to connect to these until it finds the active one.
  2. The Handshake: The connection requires a specific subprotocol (protocols: ["streamdeck_ttls_v1"]). Once connected, the client emits stream_deck/join_room followed by stream_deck/sync_settings to initialize state.
  3. Triggering Actions: To execute a command (like switching scenes), the CLI sends an event stream_deck/action_emit containing a stringified JSON payload with specific Action UUIDs (e.g., com.tiktok.livestudio.scene for scenes, com.tiktok.livestudio.mic for mic toggle, etc.).

Contributing

Contributions are always welcome! If you find new Action UUIDs, or want to add features like macro support, feel free to submit a Pull Request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.