Class Region

constructor

• new Region(slotIndex: number, _send: SendCommand): Region

  Parameters

  • slotIndex: number

    The 1-based slot index within the current device region bank

  • _send: SendCommand

  Returns Region

ReadonlyslotIndex

length

• get length(): number

  The region's length in seconds

  Returns number

name

• get name(): string

  The region's name

  Returns string

number

• get number(): string

  The user-assigned region number (as shown in Reaper's UI). This is a string because Reaper sends it as a string (e.g. "1", "2"). Empty string if not yet populated.

  Returns string

time

• get time(): number

  The region's start time in seconds

  Returns number

handleEvent

• handleEvent(event: ReaperOscEvent): void

  Handle a typed incoming event

  Parameters

  • event: ReaperOscEvent

    The event to handle

  Returns void

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

rename

• rename(name: string): void

  Rename this region. Uses write-by-ID: the user-assigned region number from number.

  Parameters

  • name: string

    The new name for the region

  Returns void

setLength

• setLength(length: number): void

  Set the length of this region. Uses write-by-ID.

  Parameters

  • length: number

    The new length in seconds

  Returns void

setNumber

• setNumber(number: number): void

  Change the user-assigned number of this region. Uses write-by-ID.

  Parameters

  • number: number

    The new user-assigned region number

  Returns void

setTime

• setTime(time: number): void

  Move this region to a new start time. Uses write-by-ID. Note: moving a region may change its bank slot index on the next sync.

  Parameters

  • time: number

    The new start time in seconds

  Returns void