Class Transport

The Reaper transport

Implements

INotifyPropertyChanged

Constructors

constructor

new Transport(send: SendCommand): Transport
Parameters
- send: SendCommand
  A callback used to send typed commands to Reaper
Returns Transport
- Defined in Transport.ts:66

Accessors

beat

get beat(): string
Indicates the current transport beat in format mm.bb.xx

Returns string
- Defined in Transport.ts:71

frames

get frames(): string
Indicates the current transport from in format h:m:s:f

Returns string
- Defined in Transport.ts:76

isFastForwarding

get isFastForwarding(): boolean
Indicates whether fast-foward is active

Returns boolean
- Defined in Transport.ts:106

isPaused

get isPaused(): boolean
Indicates whether playback is paused

Returns boolean
- Defined in Transport.ts:81

isPlaying

get isPlaying(): boolean
Indicates whether playback is active

Returns boolean
- Defined in Transport.ts:86

isRecording

get isRecording(): boolean
Indicates whether recording is active

Returns boolean
- Defined in Transport.ts:96

isRepeatEnabled

get isRepeatEnabled(): boolean
Indicates whether repeat is enabled

Returns boolean
- Defined in Transport.ts:111

isRewindByMarker

get isRewindByMarker(): boolean
Indicates whether rewind-to-previous-marker is enabled

Returns boolean
- Defined in Transport.ts:116

isRewinding

get isRewinding(): boolean
Indicates whether rewind is active

Returns boolean
- Defined in Transport.ts:101

isSetLoop

get isSetLoop(): boolean
Indicates whether the set-loop-points mode is enabled

Returns boolean
- Defined in Transport.ts:121

isStopped

get isStopped(): boolean
Indicates whether playback is stopped

Returns boolean
- Defined in Transport.ts:91

lastMarker

get lastMarker(): LastMarker
The most recently passed marker

Returns LastMarker
- Defined in Transport.ts:126

lastRegion

get lastRegion(): LastRegion
The most recently entered region

Returns LastRegion
- Defined in Transport.ts:131

loopEnd

get loopEnd(): number
Indicates the end time of the loop (in seconds)

Returns number
- Defined in Transport.ts:136

loopStart

get loopStart(): number
Indicates the start time of the loop (in seconds)

Returns number
- Defined in Transport.ts:141

time

get time(): number
Indicates the current transport time in seconds

Returns number
- Defined in Transport.ts:146

Methods

gotoMarker

gotoMarker(markerNumber: number): void
Jump to the marker with the given user-assigned number (as shown in Reaper's UI).
Parameters
- markerNumber: number
  The user-assigned marker number to jump to
Returns void
- Defined in Transport.ts:286

gotoRegion

gotoRegion(regionNumber: number): void
Jump to the region with the given user-assigned number (as shown in Reaper's UI).
Parameters
- regionNumber: number
  The user-assigned region number to jump to
Returns void
- Defined in Transport.ts:294

handleEvent

handleEvent(event: ReaperOscEvent): void
Handle a typed incoming event
Parameters
- event: ReaperOscEvent
  The event to handle
Returns void
- Defined in Transport.ts:154

jumpToBeat

jumpToBeat(beat: Beat): void
Jumps to the specified beat (absolute)
Parameters
- beat: Beat
  The beat to jump to
Returns void
- Defined in Transport.ts:178

jumpToFrame

jumpToFrame(frame: string): void
Jumps to the specified frame (absolute)
Parameters
- frame: string
  Frame to jump to (in format h:m:s:f). Values in an invalid format will be ignored by Reaper
Returns void
- Defined in Transport.ts:185

jumpToTime

jumpToTime(time: number): void
Jumps to the specified time in seconds (absolute)
Parameters
- time: number
  The time to jump to (in seconds). If this value is negative, Reaper will jump to 0
Returns void
- Defined in Transport.ts:192

jumpToTimeRelative

jumpToTimeRelative(time: number): void
Jumps to a relative time in seconds. Note that the absolute value to jump to is calculated by the library based on the currently known time, as Reaper does not appear to support jumping to a relative time via OSC
Parameters
- time: number
  The relative time jump (in seconds)
Returns void
- Defined in Transport.ts:202

onPropertyChanged

onPropertyChanged(property: string, callback: () => void): () => void
An event that can be subscribed to for property change notifications
Parameters
- property: string
  The name of the property to subscribe to
- callback: () => void
  A callback to be called when the state of the specified property changes
Returns () => void
A function that unsubscribes the event handler
Implementation of INotifyPropertyChanged.onPropertyChanged
- Defined in Transport.ts:207

pause

pause(): void
Toggle pause

Returns void
- Defined in Transport.ts:212

play

play(): void
Toggle play

Returns void
- Defined in Transport.ts:217

record

record(): void
Toggle recording

Returns void
- Defined in Transport.ts:222

setLoopEnd

setLoopEnd(time: number): void
Sets the loop end time
Parameters
- time: number
  End time for the loop (in seconds)
Returns void
- Defined in Transport.ts:230

setLoopStart

setLoopStart(time: number): void
Sets the loop start time
Parameters
- time: number
  Start time for the loop (in seconds)
Returns void
- Defined in Transport.ts:238

startFastForwarding

startFastForwarding(): void
Start fast fowarding. Will continue until stopped

Returns void
- Defined in Transport.ts:243

startRewinding

startRewinding(): void
Start rewinding. Will continue until stopped

Returns void
- Defined in Transport.ts:248

stop

stop(): void
Stop playback or recording

Returns void
- Defined in Transport.ts:253

stopFastForwarding

stopFastForwarding(): void
Stop fast forwarding

Returns void
- Defined in Transport.ts:258

stopRewinding

stopRewinding(): void
Stop rewinding

Returns void
- Defined in Transport.ts:263

toggleRepeat

toggleRepeat(): void
Toggle repeat on or off

Returns void
- Defined in Transport.ts:268

toggleRewindByMarker

toggleRewindByMarker(): void
Toggle rewind-to-previous-marker on or off

Returns void
- Defined in Transport.ts:273

toggleSetLoop

toggleSetLoop(): void
Toggle the set-loop-points mode on or off

Returns void
- Defined in Transport.ts:278