Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProlinkNetwork

Hierarchy

  • ProlinkNetwork

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • internal

    Parameters

    • __namedParameters: ConstructOpts

    Returns ProlinkNetwork

Properties

Private #announceSocket

#announceSocket: Socket

Private #beatSocket

#beatSocket: Socket

Private #config

#config: null | NetworkConfig

Private #connection

#connection: null | ConnectionService

Private #deviceManager

#deviceManager: DeviceManager

Private #mixstatus

#mixstatus: null | MixstatusProcessor

Private #state

#state: NetworkState = NetworkState.Online

Private #statusEmitter

#statusEmitter: StatusEmitter

Private #statusSocket

#statusSocket: Socket

Accessors

control

  • get control(): null | default

  • Get the @{link Control} service. This service can be used to control the Playstate of CDJs on the network.

    Returns null | default

db

  • get db(): null | Database

  • Get the @{link Database} service. This service is used to retrieve metadata and listings from devices on the network, automatically choosing the best strategy to access the data.

    Returns null | Database

deviceManager

  • get deviceManager(): DeviceManager

  • Get the @{link DeviceManager} service. This service is used to monitor and react to devices connecting and disconnecting from the prolink network.

    Returns DeviceManager

isConfigured

  • get isConfigured(): boolean

  • Check if the network has been configured. You cannot connect to the network until it has been configured.

    Returns boolean

localdb

  • get localdb(): null | LocalDatabase

  • Get the @{link LocalDatabase} service. This service is used to query and sync metadata that is downloaded directly from the rekordbox database present on media connected to the CDJs.

    Returns null | LocalDatabase

mixstatus

  • Get (and initalize) the @{link MixstatusProcessor} service. This service can be used to monitor the 'status' of devices on the network as a whole.

    Returns null | MixstatusProcessor

remotedb

  • get remotedb(): null | default

  • Get the @{link RemoteDatabase} service. This service is used to query metadata directly from the database service running on Rekordbox and the CDJs themselves.

    NOTE: To use this service to access the CDJ remote database service, the Virtual CDJ must report itself as an ID between 1 and 6. This means there cannot be four physical CDJs on the network to access any CDJs remote database.

    Returns null | default

state

  • Get the current NetworkState of the network.

    When the network is Online you may use the deviceManager to list and react to devices on the nettwork

    Once the network is Connected you may use the statusEmitter to listen for player status events, query the media databases of devices using the db service (or specifically query the localdb or remotedb).

    Returns NetworkState

statusEmitter

  • get statusEmitter(): null | StatusEmitter

  • Get the @{link StatusEmitter} service. This service is used to monitor status updates on each CDJ.

    Returns null | StatusEmitter

Methods

autoconfigFromPeers

  • autoconfigFromPeers(): Promise<void>

  • Wait for another device to show up on the network to determine which network interface to listen on.

    Defaults the Virtual CDJ ID to 5.

    Returns Promise<void>

close

  • close(): Promise<[unknown, unknown, unknown]>

  • Close UDP sockets.

    Returns Promise<[unknown, unknown, unknown]>

configure

  • Configure / reconfigure the network with an explicit configuration.

    You may need to disconnect and re-connect the network after making a networking configuration change.

    Parameters

    Returns void

connect

  • connect(): void

  • Connect to the network.

    The network must first have been configured (either with autoconfigFromPeers or manual configuration). This will then initialize all the network services.

    Returns void

disconnect

  • disconnect(): () => Promise<[unknown, unknown, unknown]>

  • Disconnect from the network

    Returns () => Promise<[unknown, unknown, unknown]>

      • (): Promise<[unknown, unknown, unknown]>

      • Close UDP sockets.

        Returns Promise<[unknown, unknown, unknown]>

isConnected

  • Typescript discriminate helper. Refines the type of the network to one that reflects the connected status. Useful to avoid having to gaurd the service getters from nulls.

    Returns this is ConnectedProlinkNetwork

Generated using TypeDoc