---
title: "PJLink"
canonical: "https://docs.cuesystem.com/space/CVCDD/572555360/PJLink"
format: markdown
---
> Macro (toc)

<details>
<summary>Detail contents</summary>

> Macro (toc)
</details>

# Description

The PJLink driver is used to control devices over the LAN according to the specification **JBMIA: PJLink Specification Version 2.00, 2017.1.31** and implements Class 1 commands, including authentication.  
Each command performs TCP connection, command, response check, and TCP connection disconnection.

# Resources

[https://pjlink.jbmia.or.jp/english/data_cl2/PJLink_5-1.pdf](https://pjlink.jbmia.or.jp/english/data_cl2/PJLink_5-1.pdf)

# Properties

|  |  |  |  |
| --- | --- | --- | --- |
| Property name | Data type | Default value | Description |
| Connection |
| Address | Text | 127.0.0.1 | IP address of controlled device. |
| Port | Long | 4352 | TCP port for control. |
| Password | Text | empty | Password, if authentication is used |

# Functions

## SetPowerON

Switches on the device. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetPowerON() As Boolean
```

## SetPowerOFF

Shuts down the device. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetPowerOFF() As Boolean
```

## GetPower

Returns the power status:

- -1 – error
- 0 – off
- 1 – on

#### Syntax

```visualbasic
Function GetPower() As Long
```

## SetInput

Switches the device input signal to the desired **input**. Returns False in case of error, otherwise True.

***input ****parameter:*

- 11 – RGB1
- 12 – RGB2
- 13 – RGB3
- 21 – Video1
- 22 – Video2
- 23 – Video3
- 31 – Digital1
- 32 – Digital2
- 33 – Digital3

#### Syntax

```visualbasic
Function SetInput(input As Byte) As Boolean
```

## GetInput

Returns the current signal input (see device documentation for value). In case of an error, returns -1.

#### Syntax

```visualbasic
Function GetInput() As Long
```

## GetInputList

Fills the **list **parameter with a list of available input signals (see device documentation for values). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function GetInputList(ByRef list As ByteString) As Boolean
```

## SetAvMute

It is used to control Video-mute and Audio-mute based on the input value. Returns False in case of error, True otherwise.

**input **parameter:

- 11 – video mute ON
- 10 – video mute OFF
- 21 – audio mute ON
- 20 – audio mute OFF
- 31 – video and audio mute ON
- 30 – video and audio mute OFF

#### Syntax

```visualbasic
Function SetAvMute(input As Byte) As Boolean
```

## GetAvMute

Returns the value of the current Video-mute and Audio-mute state.

- -1 – error
- 11 – video mute ON
- 10 – video mute OFF
- 21 – audio mute ON
- 20 – audio mute OFF
- 31 – video and audio mute ON
- 30 – video and audio mute OFF

#### Syntax

```visualbasic
Function GetAvMute() As Long
```

## GetErrorStatus

Fills the **status **parameter with 6 device error conditions. Returns False in case of error, otherwise True.

Order of errors:

- Fan
- Lamp
- Temperature
- Cover
- Filter
- Other

Values:

- 0 – No error
- 1 – Warning
- 2 - Error

#### Syntax

```visualbasic
Function GetErrorStatus(ByRef status As ByteString) As Boolean
```

## GetLampStatus

Fills **hour **parameter with usage time of lamp and **status **with lamp status. Returns False in case of error, otherwise True.

- Hour: 0..9999999 hours
- Status: on = 1, off = 0

#### Syntax

```visualbasic
Function GetLampStatus(ByRef hour As Long, ByRef status As Long) As Boolean
```

## GetName

Fills the **status **parameter with the device name. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function GetName(ByRef status As ByteString) As Boolean
```

## GetManufacturer

Fills the **status **parameter with the name of the manufacturer of the device. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function GetManufacturer(ByRef status As ByteString) As Boolean
```

## GetModel

Fills the **status **parameter with the product name. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function GetModel(ByRef status As ByteString) As Boolean
```

## GetInfo

Fills in status with other information. Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function GetInfo(ByRef status As ByteString) As Boolean
```

## SetInputRGB1

Short for SetInput(11). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputRGB1() As Boolean
```

## SetInputRGB2

Short for SetInput(12). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputRGB2() As Boolean
```

## SetInputRGB3

Short for SetInput(13). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputRGB3() As Boolean
```

## SetInputVideo1

Short for SetInput(21). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputVideo1() As Boolean
```

## SetInputVideo2

Short for SetInput(22). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputVideo2() As Boolean
```

## SetInputVideo3

Short for SetInput(23). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputVideo3() As Boolean
```

## SetInputDigital1

Short for SetInput(31). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputDigital1() As Boolean
```

## SetInputDigital2

Short for SetInput(32). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputDigital2() As Boolean
```

## SetInputDigital3

Short for SetInput(33). Returns False in case of error, otherwise True.

#### Syntax

```visualbasic
Function SetInputDigital3() As Boolean
```