py-ptsl 600.2.0

Native Python PTSL (Pro Tools Scripting Library) RPC interface

py-ptsl

Native Python PTSL (Pro Tools Scripting Library) RPC interface

Important Notice!

This software is developed by enthusiasts and is not a work of or supported by Avid. Developers who wish to contribute to this project should obtain the PTSL SDK from Avid's Developer site for the most current documentation and protobuf source files.

Example

See the examples directory for scripts demonstrating how to use the client.

• session_info.py - This example prints a list of gettable properties from the currently-open session.
• print_tracks.py - This example prints a list of every track in the currently-open session, including state information like selection, mute and solo state, track color and track ID.
• make_session.py - Creates a new session interactively from the terminal.
• pt_set.py - Allows several session setup options to be set from the terminal.
• pt_pasteboard.py - Demonstrates triggering cut/copy/paste actions.
• toolshell.py - Implements a command line interface for Pro Tools.

Sending Commands To Pro Tools with the Engine class

The Engine class exposes ptsl commands with a method call interface.

from ptsl import open_engine

with open_engine(company_name="MY_COMPANY", application_name="MY_TOOL") as engine:
    session_name = engine.session_name()

Sending Commands to Pro Tools from the Command Line

The module implements a main function that can be called from the shell. Pass request JSON to the standard input and any response will be passed to standard output.

bash-3.2$ poetry run python3 -m ptsl GetTrackList <<JSON 
{"pagination_request": {
  "limit": 100, "offset": 0
  },
"track_filter_list": [
  {"filter": 0, "is_inverted": false}
  ]
}
JSON
{'pagination_response': {'total': 4, 'offset': 0, 'limit': 100}, 'track_list':
[{'name': 'Au dio 1', 'type': 'TT_Audio', 'format': 'TF_Mono', ...

bash-3.2$ poetry run python3 -m ptsl -n GetPTSLVersion
{"version": 2025}