Skip to main content

POST 
/jacktrip/startHubClient

Starts a JackTrip Hub Client Instance. This will send a response if the process is up & running.

Request​

Body

required

    channels number

    Default value: 2

    Number of Input and output channels

    debug boolean

    Show debug information

    killAllJacktripBeforeStart boolean

    Kills all jacktrip instances before startup

    localPort number

    Default value: 4464

    The local port on which the Jacktrip instance is running

    connectDefaultAudioPorts boolean

    Default value: true

    Boolean if we need to make default audio connections

    queueBuffer number

    Default value: 4

    Queue Buffer Length, in packet size

    realtimePriority boolean

    Default value: true

    Enable realtime priority for networking threads

    bitRate number

    Default value: 16

    Audio Bit Rate Resolutions. Possible values are 8 | 16 | 24 | 32

    clientName string

    Default value: beeworker

    This is the name of the client (also the remote name)

    host string

    Default value: localhost

    This is the ip address of the JackTrip server

    receiveChannels number

    Default value: 2

    Numbers of channels received from network

    redundancy number

    Default value: 1

    Packet Redundancy to avoid glitches with packet losses

    remotePort number

    Default value: 4464

    The remote port

    sendChannels number

    Default value: 2

    Numbers of channels sent to network

Responses​

Schema

    message stringrequired

    A message with clear information what's going on.

    runningCommand string[]required

    The current running command on the host.

Loading...