Some Bugs

[JamieHardt]

Command
SetSessionLength

Observed Behavior
When trying to set a session length less than "06:00:00:00", Pro Tools
returns an Response with an response_error_json with a
command_error value of "PT_InvalidParameter", a string. An error
by this name does not exist in the CommandErrorType
enumeration, and it is a string, and not an integer as required by the
proto.

Expected Behavior
Pro Tools should return a response_error_json with a numeric
command_error whose value exists in the
CommandErrorType enumeration.

---

Command
SetSessionBitDepth
SetSessionAudioFormat
SetSessionLength
SetSessionAudioPullRateSetting
SetSessionVideoPullRateSetting


Observed Behavior
Using these commands does not change the settings in the session setup
window. The session must be saved, closed and reopened before the changes
are visible in Setup.

Expected Behavior
The Session setup window should change its visible settings immediately.


---

Command
PasteSpecial

Observed Behvaior
When PasteSpecial is used with the `To_Current_Automation_Type`, nothing
happens.

Expected Behavior
When used in this way, this command should do a Paste to Current.

---

Command
CreateSession

Observed Behavior
When this command is used with the path and name of an existing session,
it will overwrite the existing file on disk without reporting an error.

Expected Behavior
This command should fail with an error if the path and name of a session
that exists on disk are given. A session exitsing on disk should never be
overwritten.

---

Command
GetTrackList

Observed Behavior
When there are no tracks in the session, the track_list value in the
response contains an empty JSON set object `{}` and not an empty JSON list
`[]`. This is not the correct type for this variable.

Expected Behavior
Pro Tools should return an empty list value for this value.

[rmajors]

Thanks for reporting these. We have been able to reproduce each of them here, and we are now tracking them with the following bug numbers:

PT-298374 Set commands don't change values in UI

PT-298375 PasteSpecial works only with the Repeat to Fill Selection option

PT-298376 GetTrackList returns and empty {} instead of [] when there are no tracks in the session

PT-298422 CreateSession deletes existing session file

The first SetSessionLength issue you mentioned has already been addressed and you should see the fix in the next Pro Tools release.

[Pete Gates]

Hey Rob,
Can I ask for clarification on something? You said about a fix in the next Pro Tools release. Is that for the PTSL lib in Pro Tools or the SDK or both? If it's in the PTSL lib, does that mean that people who are running the current Pro Tools release won't be able to benefit from future bug fixes if it's tied into a library within Pro Tools, and the same with progressive Pro Tools releases and bug fixes?

Thanks,
Pete

[alvin28]

Command
OpenSession

'Save Changes?' dialogue box appears.
Additional commands before this is dismissed causes Pro Tools to crash. closeSessionRequest.savePreviousOnClose would solve?

Command Request:
setOnline - Puts Pro Tools online so that playback and recording is triggered by an external timecode source.

[rmajors]

Originally Posted by Pete Gates

Hey Rob,
Can I ask for clarification on something? You said about a fix in the next Pro Tools release. Is that for the PTSL lib in Pro Tools or the SDK or both? If it's in the PTSL lib, does that mean that people who are running the current Pro Tools release won't be able to benefit from future bug fixes if it's tied into a library within Pro Tools, and the same with progressive Pro Tools releases and bug fixes?

In most cases a fix or improvement for the Pro Tools Scripting SDK will require a change on the Pro Tools side. If a change is required on the Pro Tools side then access to the updated version of Pro Tools will be required. We don't have any plans to deploy or version the PTSL binary separately from Pro Tools. In general, you can consider the Pro Tools Scripting SDK support in Pro Tools to be treated the same as other Pro Tools application features.

The Pro Tools Scripting SDK does include versioning information in its messages and responses, as well as a way to query the host version, so client apps will be able to use that information e.g. to work around known issues when interacting with an older version of Pro Tools that did not yet include a fix.

[Farid M]

Originally Posted by alvin28

Command
OpenSession

'Save Changes?' dialogue box appears.
Additional commands before this is dismissed causes Pro Tools to crash. closeSessionRequest.savePreviousOnClose would solve?

Hello Alvin, Farid here, could you please provide some additional details on this bug? I didn't manage to get a repro, based on your initial description. What commands you were passing with the SaveChanges dialogue box opened?

[Pete Gates]

Originally Posted by rmajors

In most cases a fix or improvement for the Pro Tools Scripting SDK will require a change on the Pro Tools side. If a change is required on the Pro Tools side then access to the updated version of Pro Tools will be required. We don't have any plans to deploy or version the PTSL binary separately from Pro Tools. In general, you can consider the Pro Tools Scripting SDK support in Pro Tools to be treated the same as other Pro Tools application features.

The Pro Tools Scripting SDK does include versioning information in its messages and responses, as well as a way to query the host version, so client apps will be able to use that information e.g. to work around known issues when interacting with an older version of Pro Tools that did not yet include a fix.

Thanks Rob,
That was the general assumption I think, just wanted it confirmed.

Cheers,
Pete

[alvin28]

Hi Farid,
Thanks for your reply.
I would assume most workflows would precursor an openSession with a closeSession command, but wanted to highlight that an openSession with session loaded would bring up ‘save changes’ box.
Follow this with a closeSession, then dismiss dialogue will crash Pro Tools every time.
Hope this helps..

[Farid M]

Thanks, Alvin, we've been able to get a repro on your report and logged a bug under PT-299188 number. Thanks for bringing this up!

[rmajors]

The crash when dismissing the "Save Changes" dialog after executing a PTSL closeSession request is fixed in Pro Tools 2023.3.