This file was auto-generated with zdoccer.js 2.0.3

Index

• @holzchopf/flstudio-control-surface
  • class ControlSurfaceControl extends ControlSurfaceEventGroup
    • get name(): string | undefined
    • get enable(): ControlEnable | undefined
  • class ControlSurfaceEventGroup
    • getEventOfType(type: ControlSurfaceEventTypeId)
    • getEventOfTypeName(type: ControlSurfaceEventTypeName)
    • getEvents(): ControlSurfaceEvent[]
    • setEvents(events: ControlSurfaceEvent[])
  • type ControlSurfaceEventTypeName = keyof typeof ControlSurfaceEventTypeRaw
  • type ControlSurfaceEventTypeId = typeof ControlSurfaceEventTypeRaw[ControlSurfaceEventTypeName]
  • const ControlSurfaceEventType =
    • name: (id: number): ControlSurfaceEventTypeName | 'unknown' =>
    • byName: (name: string): ControlSurfaceEventTypeId | undefined =>
  • abstract class ControlSurfaceEvent<T = any>
    • type: number
    • get typeName()
    • value?: T
    • abstract getBinary(): ArrayBuffer
    • abstract setBinary(buffer: ArrayBuffer): void
    • static create(type: number)
  • class ControlSurfaceBinaryEvent extends ControlSurfaceEvent<ArrayBuffer>
  • class ControlSurfaceStringEvent extends ControlSurfaceEvent<string>
  • type ControlEnable =
    • current?: number,
    • default?: number,
    • index?: number,
  • class ControlSurfaceControlEnableEvent extends ControlSurfaceEvent<ControlEnable>
  • class ControlSurface
    • version: number = 1
    • options = new ControlSurfaceOptions()
    • controls: ControlSurfaceControl[] = []
    • getBinary(): ArrayBuffer
    • setBinary(buffer: ArrayBuffer)

original Markdown from src/_preamble.md

@holzchopf/flstudio-control-surface

Allows to read and write FL Studio Control Surface states.

transformed Javadoc from src/control-surface-control.ts

class ControlSurfaceControl extends ControlSurfaceEventGroup

Class representing a control on the surface. Extends ControlSurfaceEventGroup .

get name(): string | undefined

Name of this control.

get enable(): ControlEnable | undefined

ControlEnable  of this control.

transformed Javadoc from src/control-surface-event-group.ts

class ControlSurfaceEventGroup

Class representing a group of ControlSurfaceEvent s.

getEventOfType(type: ControlSurfaceEventTypeId)

Returns the first event in this group of given type id.

• param type — ControlSurfaceEventTypeId 

getEventOfTypeName(type: ControlSurfaceEventTypeName)

Returns the first event in this group of given type name.

• param type — ControlSurfaceEventTypeName 

getEvents(): ControlSurfaceEvent[]

Returns the ControlSurfaceEvent s making up this group.

setEvents(events: ControlSurfaceEvent[])

Sets the ControlSurfaceEvent s making up this group.

transformed Javadoc from src/control-surface-event-type.ts

type ControlSurfaceEventTypeName = keyof typeof ControlSurfaceEventTypeRaw

Known event names.

type ControlSurfaceEventTypeId = typeof ControlSurfaceEventTypeRaw[ControlSurfaceEventTypeName]

Known event IDs.

const ControlSurfaceEventType =

Types of the events in an ControlSurfaceEventGroup .

name: (id: number): ControlSurfaceEventTypeName | 'unknown' =>

Returns the name of a given event ID, or 'unknown'.

• param id — Event ID.

byName: (name: string): ControlSurfaceEventTypeId | undefined =>

Returns the ID for a given event name, or undefined

• param name — Event name.

transformed Javadoc from src/control-surface-event.ts

abstract class ControlSurfaceEvent<T = any>

Class for events.

type: number

Numeric ControlSurfaceEventType .

get typeName()

Name of ControlSurfaceEventType . Readonly.

value?: T

Event value. Data type varies by event type.

abstract getBinary(): ArrayBuffer

Creates the binary data for this event and returns it.

abstract setBinary(buffer: ArrayBuffer): void

Sets this event's values from binary data.

• param buffer — Binary data.

static create(type: number)

Factory function to create a new specific ControlSurfaceEvent.

• param type — ControlSurfaceEventType.

class ControlSurfaceBinaryEvent extends ControlSurfaceEvent<ArrayBuffer>

Event with binary value data.

class ControlSurfaceStringEvent extends ControlSurfaceEvent<string>

Event with string value data.

type ControlEnable =

Enabled controls will have a ControlSurfaceControlEnableEvent  with a value of this type.

current?: number,

Current value. Float, 0 ... 1

default?: number,

Default value. Float, 0 ... 1

index?: number,

List index. Integer >= 0

class ControlSurfaceControlEnableEvent extends ControlSurfaceEvent<ControlEnable>

Enabled controls will have one of these events.

transformed Javadoc from src/control-surface.ts

class ControlSurface

Class representing an FL Studio Control Surface plugin state.

version: number = 1

State version number.

options = new ControlSurfaceOptions()

Surface options.

controls: ControlSurfaceControl[] = []

Controls on this surface.

getBinary(): ArrayBuffer

Creates the binary data for this surface and returns it.

setBinary(buffer: ArrayBuffer)

Sets this surface's values from binary data.

• param buffer — Binary data.