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

---

# Description

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

# Resources

PJLink Specification Version 2.10, 2024.2.9

# 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 | ByteString | &S"" | Password, if authentication is used |

# Functions

## GetAvMute

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

#### Syntax

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

#### Return value

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> … audio and video mute state, where:

- -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

#### Example

```visualbasic

```

## GetClass

Function return supported class level of controlled device.

#### Syntax

```visualbasic
GetClass() As Byte
```

#### Return value

<u>[Byte](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Byte)</u> ... supported class level, 1 or 2

#### Example

```visualbasic

```

## GetErrorStatus

Fills the **status **parameter with 6 device error conditions. 

#### Syntax

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

#### Parameters

status

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... 6 ByteString with value:

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

Position in return value:

1. Fan
2. Lamp
3. Temperature
4. Cover
5. Filter
6. Other

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetFreeze

Fills the **fStatus** with value of Freeze.

#### Syntax

```visualbasic
GetFreeze(ByRef fStatus As Boolean) As Boolean
```

#### Parameters

fStatus

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> ... with value:

- True – Freeze ON
- False – Freeze OFF

Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetInfo

Fills in status with other information. 

#### Syntax

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

#### Parameters

status

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... other information string

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetInput

Fills in bsInput the current signal input (see device documentation for value).

#### Syntax

```visualbasic
GetInput(ByRef bsInput As ByteString) As Boolean
```

#### Parameters

bsInput

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... characters pair, where:

- first character:

1. RGB
2. Video
3. Digital
4. Storage
5. Network
6. Internal - only Class 2 device

- second character 1-9 for Class 1 device, 1-9 and A-Z for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetInputList

Fills the **bslist **parameter with a list of available input signals (see device documentation for values).

#### Syntax

```visualbasic
GetInputList(ByRef bsList As ByteString) As Boolean
```

#### Parameters

bsList

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... string of characters pair, where:

- first character:

1. RGB
2. Video
3. Digital
4. Storage
5. Network
6. Internal - only Class 2 device

- second character 1-9 for Class 1 device, 1-9 and A-Z for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetInputResolution

Fills the **lHorizont **and **lVertical **parameters with current signal resolution.

#### Syntax

```visualbasic
GetInputResolution(ByRef lHorizont As Long, ByRef lVertical As Long) As Boolean
```

#### Parameters

lHorizont

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... current horizontal signal resolution

lVertical

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... current verticalsignal resolution

Special value of return parameters:

- Projector error - lHorizontal is -1 and lVertival is -1
- No signal - lHorizontal is -1 and lVertival is 0
- Unknow signal - lHorizontal is 0 and lVertival is -1

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetLampStatus

Fills **hour **parameter with usage time of lamp and **status **with lamp status for lamp number **lampNo**.

#### Syntax

```visualbasic
GetLampStatus(ByRef hour As Long, ByRef status As Long, Optional ByVal lampNo As Byte := 1) As Boolean
```

#### Parameters

hour

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... hour 0..9999999

status

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... 1 = on, 0 = off

lampNo

<u>[Byte](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Byte)</u> … lamp number; default is 1 

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetManufacturer

Fills the **status **parameter with the name of the manufacturer of the device.

#### Syntax

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

#### Parameters

status

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... manufacturer name

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetModel

Fills the **status **parameter with the product name.

#### Syntax

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

#### Parameters

status

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... product name

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetName

Fills the **status **parameter with the device name.

#### Syntax

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

#### Parameters

status

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... projector display name

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## GetPower

Returns the power status.

#### Syntax

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

#### Return value

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ...

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

#### Example

```visualbasic

```

## GetRecommendedResolution

Fills the **lHorizont **and **lVertical **parameters with recommended signal resolution

#### Syntax

```visualbasic
GetRecommendedResolution(ByRef lHorizont As Long, ByRef lVertical As Long) As Boolean
```

#### Parameters

lHorizont

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... recommended horizontal signal resolution

lVertical

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... recommended verticalsignal resolution

Special value of return parameters:

- Projector error - lHorizontal is -1 and lVertival is -1
- No signal - lHorizontal is -1 and lVertival is 0
- Unknow signal - lHorizontal is 0 and lVertival is -1

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetAvMute

It is used to control Video-mute and Audio-mute based on the input value.

#### Syntax

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

#### Parameters

input

<u>[Byte](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Byte)</u> ... audio and video mute state, where:

- 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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetConnectionProperties

This function change current communication parameters to new ones.

#### Syntax

```visualbasic
SetConnectionProperties(txtURL As Text, Optional lPort As Long := 4352, Optional bsPassword As ByteString := &S"")
```

#### Parameters

txtURL

<u>[Text](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Text)</u> ... new URL of device

lPort

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> … new communication port; Optional, defaults is 4352

bsPassword

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> … new communication password; Optional, defaults is blank

#### Example

```visualbasic

```

## SetFreeze

It is used to control Freeze.

#### Syntax

```visualbasic
SetFreeze(ByVal fON As Boolean) As Boolean
```

#### Parameters

fON

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> ... True means Freeze ON, False means Freeze OFF

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInput

Switches the device input signal to the desired **input **(see device documentation for value).

#### Syntax

```visualbasic
SetInput(ByVal cGroup As Char, ByVal cInput As Char) As Boolean
```

#### Parameters

cGroup

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... group number of new input, where:

1. RGB
2. Video
3. Digital
4. Storage
5. Network
6. Internal - only Class 2 device

cInput

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... input inside group: ‘1'-’9' for Class 1 device, ‘1'-’9' and ‘A'-’Z' for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputDigital

Short for SetInput('3', Input).

#### Syntax

```visualbasic
SetInputDigital(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... digital input number: 1-9 for Class 1 device, 1-9 and A-Z for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputDigital1

Short for SetInput('3', '1').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputDigital2

Short for SetInput('3', '2').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputDigital3

Short for SetInput('3', '3').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputInternal

Short for SetInput('6', Input).

#### Syntax

```visualbasic
SetInputInternal(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... Internal input number: ‘1'-’9' for Class 1 device, ‘1'-’9' and ‘A'-’Z' for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputNetwork

Short for SetInput('5', Input).

#### Syntax

```visualbasic
SetInputNetwork(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... Network input number: ‘1'-’9' for Class 1 device, ‘1'-’9' and ‘A'-’Z' for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputRGB

Short for SetInput('1', Input).

#### Syntax

```visualbasic
SetInputRGB(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... RGB input number: 1-9 for Class 1 device, 1-9 and A-Z for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputRGB1

Short for SetInput('1', '1').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputRGB2

Short for SetInput('1', '2').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputRGB3

Short for SetInput('1', '3').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputStorage

Short for SetInput('4', Input).

#### Syntax

```visualbasic
SetInputStorage(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... Storage input number: ‘1'-’9' for Class 1 device, ‘1'-’9' and ‘A'-’Z' for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputVideo

Short for SetInput('2', Input).

#### Syntax

```visualbasic
SetInputVideo(Input As Char) As Boolean
```

#### Parameters

Input

<u>[Char](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Char)</u> ... Video input number: 1-9 for Class 1 device, 1-9 and A-Z for Class 2 device

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputVideo1

Short for SetInput('2', '1').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputVideo2

Short for SetInput('2', '2').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetInputVideo3

Short for SetInput('2', '3').

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetMicrophoneVolume

It is used to change microphone volume.

#### Syntax

```visualbasic
SetMicrophoneVolume(ByVal lSteps As Long) As Boolean
```

#### Parameters

lSteps

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... increase (positive number) or decrease (negative number) volume

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetPowerOFF

Shuts down the device.

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetPowerON

Switches on the device.

#### Syntax

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

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```

## SetSpeakerVolume

It is used to change speaker volume.

#### Syntax

```visualbasic
SetSpeakerVolume(ByVal lSteps As Long) As Boolean
```

#### Parameters

lSteps

<u>[Long](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Long)</u> ... increase (positive number) or decrease (negative number) volume

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True on success or False if an error occurs.

#### Example

```visualbasic

```