Class Voicemeeter

Hierarchy

Voicemeeter

Constructors

constructor

new Voicemeeter(): Voicemeeter

Returns Voicemeeter

Properties

Private eventPool

eventPool: (() => void)[] = ...

Private inputDevices

inputDevices: Device[] = []

Private isConnected

isConnected: boolean = false

Private isInitialised

isInitialised: boolean = false

Private outputDevices

outputDevices: Device[] = []

Private stringParameters

stringParameters: string[] = ...

Private type

type: VoiceMeeterTypes

Private version

version: string = ""

Accessors

$inputDevices

get $inputDevices(): Device[]

- Defined in lib/VoicemeeterConnector.ts:103
Getter $inputDevices

Returns Device[]

$outputDevices

get $outputDevices(): Device[]

- Defined in lib/VoicemeeterConnector.ts:95
Getter $outputDevices

Returns Device[]

$type

get $type(): VoiceMeeterTypes

- Defined in lib/VoicemeeterConnector.ts:119
Getter $type

Returns VoiceMeeterTypes

$version

get $version(): string

- Defined in lib/VoicemeeterConnector.ts:111
Getter $version

Returns string

Methods

attachChangeEvent

attachChangeEvent(fn: () => any): void

- Defined in lib/VoicemeeterConnector.ts:228
Parameters
- fn: () => any
  
  Function which should be called if something changes
  - - (): any
    - Returns any
Returns void

Private checkPropertyChange

checkPropertyChange(): void

- Defined in lib/VoicemeeterConnector.ts:272
Checks whether properties has been changed and calls all event listeners

Returns void

connect

connect(): void

- Defined in lib/VoicemeeterConnector.ts:73
Starts a connection to VoiceMeeter

Returns void

disconnect

disconnect(): void

- Defined in lib/VoicemeeterConnector.ts:126
Terminates the connection to VoiceMeeter

Returns void

getBusParameter

getBusParameter(index: number, property: BusProperties): any

- Defined in lib/VoicemeeterConnector.ts:192
Gets a bus parameter.

Parameters
- index: number
  
  Index of the bus
- property: BusProperties
  
  Property which should be get
Returns any

getLevel

getLevel(type: 0 | 1 | 2 | 3, channel: number): unknown

- Defined in lib/VoicemeeterConnector.ts:349
Gets realtime audio level see the VoicemeeterRemote API: VoicemeeterRemote.h GetLevel, for more details about the parameters

Parameters
- type: 0 | 1 | 2 | 3
  
  0 = pre fader input levels. 1 = post fader input levels. 2= post Mute input levels. 3= output levels
- channel: number
  
  audio channel zero based index
Returns unknown
Current audio level

getOption

getOption(parameterName: string): any

- Defined in lib/VoicemeeterConnector.ts:235
Parameters
- parameterName: string
  
  Name of the parameter that should be get
Returns any
Parameter value

Private getParameter

getParameter(selector: "Strip" | "Bus", index: number, property: BusProperties | StripProperties): any

- Defined in lib/VoicemeeterConnector.ts:318
Gets a parameter of voicemeeter

Parameters
- selector: "Strip" | "Bus"
  
  Strip or Bus
- index: number
  
  Number of strip or bus
- property: BusProperties | StripProperties
  
  Property which should be read
Returns any

getStripParameter

getStripParameter(index: number, property: StripProperties): any

- Defined in lib/VoicemeeterConnector.ts:201
Gets a strip parameter

Parameters
- index: number
  
  Index of the strip
- property: StripProperties
  
  Property which should be get
Returns any

Private getVoicemeeterType

getVoicemeeterType(): VoiceMeeterTypes

- Defined in lib/VoicemeeterConnector.ts:284
Gets installed voicemeeter type. Means Voicemeeter(normal,banana,potato)

Returns VoiceMeeterTypes

Private getVoicemeeterVersion

getVoicemeeterVersion(): any

- Defined in lib/VoicemeeterConnector.ts:304
Returns the installed voicemeeter version

Returns any

isParametersDirty

isParametersDirty(): any

- Defined in lib/VoicemeeterConnector.ts:182
Returns wheter a parameter has been changed

Returns any

setBusParameter

setBusParameter(index: number, property: BusProperties, value: any): Promise<any>

- Defined in lib/VoicemeeterConnector.ts:221
Sets a parameter of a bus.

Parameters
- index: number
  
  Bus number
- property: BusProperties
  
  Propertyname which should be changed
- value: any
  
  Property value
Returns Promise<any>

setOption

setOption(option: string): Promise<unknown>

- Defined in lib/VoicemeeterConnector.ts:262
Sets an option.

Parameters
- option: string
  
  Option to set
Returns Promise<unknown>

Private setParameter

setParameter(selector: "Strip" | "Bus", index: number, property: BusProperties | StripProperties, value: any): Promise<any>

- Defined in lib/VoicemeeterConnector.ts:330
Sets a parameter of a bus or Strip

Parameters
- selector: "Strip" | "Bus"
- index: number
  
  Number of strip or bus
- property: BusProperties | StripProperties
  
  Propertyname which should be changed
- value: any
  
  Property value
Returns Promise<any>

setStripParameter

setStripParameter(index: number, property: StripProperties, value: any): Promise<any>

- Defined in lib/VoicemeeterConnector.ts:211
Sets a parameter of a strip.

Parameters
- index: number
  
  Strip number
- property: StripProperties
  
  Propertyname which should be changed
- value: any
  
  Property value
Returns Promise<any>

updateDeviceList

updateDeviceList(): void

- Defined in lib/VoicemeeterConnector.ts:144
Updates all input and ouput devices

Returns void

Static init

init(): Promise<Voicemeeter>

- Defined in lib/VoicemeeterConnector.ts:33
Initializes the voice meeter dll connection. This call is neccessary to use the api. It returns a promise with a VoiceMeeter instance

Returns Promise<Voicemeeter>

Generated using TypeDoc