Command Implementations in Engine

How to Add a New Command Implementation

1. Create a new Operation subclass for the command.

1. In the ptsl/ops directory, create a new source file for the command or commands you wish to implement.

   For the implementation to work correctly, the name of the operation subclass must be identical to the name of the Command in the PTSL protocol.

   In general, this class shouldn’t need to have any implementation (the class block can simply be a pass). The Operation class handles looking up the request and response types, looks up the command ID, and maps kwargs of the operation to request args. Sometimes some implementation is required to clean up erroneous JSON data from the server or to rationalize certain responses.

2. In ptsl/ops/__init__.py, import the name of the operation class.

1. Add a new method to ptsl.Engine.

1. On the Engine class create a new method to offer callers.

   This method should accept all request arguments in its signature. If the method requres ptsl types that are not currently imported into engine.py, you should import these at the time and refer to them by their short name in the signature. Do not accept a PTSL Request type as a parameter.

2. In the method body, create an instance of the Operation class you created in step 1.

   Pass all request arguments as kwargs to the operation’s initializer. Use the field names for your operation’s corresponding request type.

3. Pass the operation to client.run().

   This will encode the operation as a request, post it to the server and capture the response, if any.

4. If there was a response, it will be set on the operation object you created in the response field.

   Access that field’s members and return fields from it to the caller.

PTSL Version 1

Command	Version	Engine method
CreateSession	>=2022.12	create_session()
OpenSession	>=2022.12	open_session()
Import	>=2022.12	import_data()
GetTrackList	>=2022.12	track_list()
SelectAllClipsOnTrack	>=2022.12	select_all_clips_on_track()
ExtendSelectionToTargetTracks	>=2022.12	extend_selection_to_target_tracks()
TrimToSelection	>=2022.12	trim_to_selection()
CreateFadesBasedOnPreset	>=2022.12	create_batch_fades()
RenameTargetTrack	>=2022.12	rename_target_track()
ConsolidateClip	>=2022.12	consolidate_clip()
ExportClipsAsFiles	>=2022.12	export_clips_as_files()
ExportSelectedTracksAsAAFOMF	>=2022.12
GetTaskStatus	>=2022.12
HostReadyCheck	>=2022.12	host_ready_check()
RefreshTargetAudioFiles	>=2022.12	refresh_target_audio_files()
RefreshAllModifiedAudioFiles	>=2022.12	refresh_all_modified_audio_flles()
GetFileLocation	>=2022.12	get_file_location()
CloseSession	>=2022.12	close_session()
SaveSession	>=2022.12	save_session()
SaveSessionAs	>=2022.12	save_session_as()
Cut	>=2022.12	cut()
Copy	>=2022.12	copy()
Paste	>=2022.12	paste()
Clear	>=2022.12	clear()
CutSpecial	>=2022.12	cut()
CopySpecial	>=2022.12	copy()
ClearSpecial	>=2022.12	clear()
PasteSpecial	>=2022.12	paste()
ExportMix	>=2022.12	export_mix()
Spot	>=2022.12
ExportSessionInfoAsText	>=2022.12
GetDynamicProperties	>=2022.12
SetPlaybackMode	>=2022.12	set_playback_mode()
SetRecordMode	>=2022.12	set_record_mode()
GetSessionAudioFormat	>=2022.12	session_audio_format()
GetSessionSampleRate	>=2022.12	session_sample_rate()
GetSessionBitDepth	>=2022.12	session_bit_depth()
GetSessionInterleavedState	>=2022.12	session_interleaved_state()
GetSessionTimeCodeRate	>=2022.12	session_timecode_rate()
GetSessionFeetFramesRate	>=2022.12	session_feet_frames_rate()
GetSessionAudioRatePullSettings	>=2022.12	session_audio_rate_pull()
GetSessionVideoRatePullSettings	>=2022.12	session_video_rate_pull()
GetSessionName	>=2022.12	session_name()
GetSessionPath	>=2022.12	session_path()
GetSessionStartTime	>=2022.12	session_start_time()
GetSessionLength	>=2022.12	session_length()
SetSessionAudioFormat	>=2022.12	set_session_audio_format()
SetSessionBitDepth	>=2022.12	set_session_bit_depth()
SetSessionInterleavedState	>=2022.12	set_session_interleaved_state()
SetSessionTimeCodeRate	>=2022.12	set_session_time_code_rate()
SetSessionFeetFramesRate	>=2022.12	set_session_feet_frames_rate()
SetSessionAudioRatePullSettings	>=2022.12	set_session_audio_rate_pull()
SetSessionVideoRatePullSettings	>=2022.12	set_session_video_rate_pull()
SetSessionStartTime	>=2022.12	set_session_start_time()
SetSessionLength	>=2022.12	set_session_length()
GetPTSLVersion	>=2022.12	ptsl_version()
GetPlaybackMode	>=2022.12	playback_modes()
GetRecordMode	>=2022.12	record_mode()
GetTransportArmed	>=2022.12	transport_armed()
GetTransportState	>=2022.12	transport_state()
AuthorizeConnection	==2022.12	Implicit in __init__()
RenameSelectedClip	>=2023.3	rename_selected_clip()
RenameTargetClip	>=2023.3	rename_target_clip()
TogglePlayState	>=2023.3	toggle_play_state()
ToggleRecordEnable	>=2023.3	toggle_record_enable()
PlayHalfSpeed	>=2023.3	play_half_speed()
RecordHalfSpeed	>=2023.3	record_half_speed()
EditMemoryLocation	>=2023.3	edit_memory_location()
GetMemoryLocations	>=2023.3	get_memory_locations()
RegisterConnection	>=2023.3	Implicit in __init__()
CreateMemoryLocation	>=2023.6
CreateNewTracks	>=2023.7
GetEditMode	>=2023.7
SetEditMode	>=2023.7
GetEditModeOptions	>=2023.7
SetEditModeOptions	>=2023.7
SelectTracksByName	>=2023.7
SetZoomPreset	>=2023.7
RecallZoomPreset	>=2023.7
GetEditTool	>=2023.7
SetEditTool	>=2023.7
GetTimelineSelection	>=2023.7
SetTimelineSelection	>=2023.7