Class QrwcSvelte

constructor

• new QrwcSvelte(coreIP: string): QrwcSvelte

• Starts a new instance of the QRWC Wrapper. This will automatically connect to the specified Q-SYS core. Connection will be maintained until the instance is disconnected. This version of the constructor will connect via non-secure WebSocket, subscribe to all external components, and poll at 35ms.

  Parameters

  • coreIP: string

    The IP or Hostname of the core system to connect to.

  Returns QrwcSvelte
• new QrwcSvelte(connectionOptions: ConnectionOptions): QrwcSvelte

• Starts a new instance of the QRWC Wrapper. This will automatically connect to the specified Q-SYS core. Connection will be maintained until the instance is disconnected. This version of the constructor allows for more advanced connection options.

  Parameters

  • connectionOptions: ConnectionOptions

    Connection options for the QRWC WebSocket, See ConnectionOptions

  Returns QrwcSvelte

activeCore

connectionAttemptCount

connectionStatus

coreIp

isConnected

disconnect

• disconnect(): void

• Manually disconnect the QRWC WebSocket, and no longer attempt to reconnect. This method should be called when the QRWC instance is no longer needed.

  This method will flush all subscriptions and disconnect the WebSocket. A new instance of the QRWC Wrapper will need to be created to reconnect.

  Any controls that were fetched will no longer be valid and will need to be re-fetched.

  Returns void

getComponentList

• getComponentList(): string[]

• Get the list of components in the current Q-SYS design. Only returns components that have external script access, and are not excluded by a component filter passed into this wrapper instance.

  Returns string[]

  Array of component names with external script access in the current Q-SYS design.

useComponent

• useComponent(componentId: string): Component

• Fetch a specific component in the current Q-SYS design. This will return a component instance that provides metadata and access to controls within the component. Controls within the component can be fetched using the appropriate use method.

  Parameters

  • componentId: string

    ID of the component to use. This is the "Code Name" under Script Access in Q-SYS Designer

  Returns Component

  component instance that provides metadata and access to controls within the component.

  Throws

  If the component does not exist in the Q-SYS design or is excluded by the control filter.