TransportManager

TransportManager controls a single track at a time,
allowing a wide variety of external control methods.

It contains a player member which is the local live view of the playback status.

Category: Transports

Base class: SuperTransportManager

Properties

customFpsType : int

Synonym for ‘enableCustomFps’

customTimelineFps : float

If the custom FPS override is set to ‘Custom’, this is the FPS to use.

enableCustomFps : int

Select the type of FPS override for the transport commands

engaged : bool

Synonym for status - if disabled, external commands are ignored.

local_transports : List[EventTransport]

The set of local transport sources. These are always used, even if disengaged.

Category: Event Transports
UserName: Local Transports

monitorString : str

Timecode monitor

on_clock_lost : int

What to do when the Timecode is lost.

Options: {0: ‘Keep Playing’, 1: ‘Stop’}
Category: Timecode
UserName: On clock lost

on_clock_regained : int

What to do when Timecode is regained

Options: {0: ‘Reset to start’, 1: ‘Play from current’}
Category: Timecode
UserName: On clock regained

play_mode : int

Play mode to use when chasing timecode.

Options: {0: ‘Play’, 1: ‘Play To End Of Section’, 2: ‘Loop Section’}
Category: Timecode
UserName: Play mode

playbackStatusMonitor : PlaybackStatusMonitor

A device used to externally monitor current playback status.

player : TrackPlayer (Read-Only)

The player responsible for updating the compositor

preRollMatch : float (Read-Only)

If timecode is prerolling, how long until playback, in seconds.

remote_transports : List[EventTransport]

The set of show-wide external transport sources. These are ignored if the transport is disengaged.

Category: Event Transports
UserName: Remote Transports

remotetransportmode : int

Allow editors to interact with the session (controls live update, transport locking)

schedule : Schedule

Used to automatically control the transport manager.

Category: Schedule
UserName: Schedule

sendTransportCommands : int

Whether transport commands should be sent or blocked (stops actors getting updates)

sendTransportCommandsMode : int

Synonym for sendTransportCommands - if set to “Do not send”, transport commands are not sent to connected devices.

setList : SetList

The set list determines the set of available tracks (e.g. for timecode or other global cue matching)

Category: Set List
UserName: Set list

status : int

If disabled, external sources are ignored

statusString : str

Timecode status

tcStatusString : str (Read-Only)

The same as statusString, before the ‘Forced’ behaviour is applied

timecode : TimecodeTransport

Timecode source

Category: Timecode
UserName: Timecode

timecode_can_change_track : int

Whether the timecode can change the track.

Options: {0: ‘No’, 1: ‘Yes’}
Category: Timecode
UserName: If set, then timecode is allowed to change tracks

traceLevel : int

What level of debug tracing to issue commands at.

0: off, 1: all CMDs except Status, 2: all CMDs

track : Track (Read-Only)

Convenience wrapper to get currently selected track (see player)

trackToLoad : str

The track used before the transport manager receives any track-selecting commands.

Variables

custom : Final[int] = 2

globalRefreshRate : Final[int] = 1

none : Final[int] = 0

Methods

addCommand(self, trCmd: TransportCommand)

Adds a command to the transport manager’s local queue.

This method adds a command to the transport manager’s local queue, which is used to manage the transport of data between the client and server.

Parameters:

• trCmd: The command to add to the local queue.

beatToTimecode(self, tBeat: float) -> Timecode

Converts a beat to a timecode.

This method converts a beat value to a timecode using the transport manager’s SMPTE clock type and custom frame rate.

Parameters:

• tBeat: The beat value to convert.

Returns The corresponding timecode.

customFps(self) -> optional[float]

Returns the custom FPS value if set, otherwise an empty optional.

This method returns the custom FPS value if it has been set using the setCustomFps method, or an empty optional if no custom FPS value has been set.

Returns The custom FPS value, or an empty optional if no custom FPS value has been set.

forceJump(self)

Forces a jump in the transport manager.

This method forces a jump in the transport manager, indicating that bias or tag has changed while playing so force a jump.

lockToDirector(self, source: Resource, jumpDirectorToMe: bool)

Locks the transport to the director.

Parameters:

• source: The resource that triggered the locking, used as the TransportCommand source.
• jumpDirectorToMe: If true, the local machine does not move, but the director (and the rest of the session) does.

smpteClockType(self) -> int

Returns the SMPTE clock type used by the transport manager.

This method returns the SMPTE clock type used by the transport manager, which is determined based on the current timecode transport and custom FPS type settings. If a timecode transport is set and the custom FPS type is not set to GLOBAL_REFRESH_RATE, the SMPTE clock type of the timecode transport is returned. Otherwise, the project clock type is used.

Returns The SMPTE clock type used by the transport manager.