---
title: "Maevex Series 6100 Encoder"
canonical: "https://docs.cuesystem.com/space/CVCDD/793673742/Maevex%20Series%206100%20Encoder"
format: markdown
---
> Macro (toc)

---

# Description

The driver functions are based on Maevex Series 6100 Web API.  The usage of this driver expects full knowledge of the “Matrox PowerStream Plus” software used for setting and configuring the Encoder device. 

(Tested on the Maevex 6152 Encoder - Firmware  3.02.00.380)

# Resources

The Maevex Series 6100 Web API is not public (protected by Matrox NDA) and  thus the source code of this driver is password protected.

# Properties

|  |  |  |  |
| --- | --- | --- | --- |
| Property name | Data type | Default value | Description |
| Login |
| User name | Text | - user name - | device User |
| Password | Text | - password - | User password |
| IP parameters |
| IP address | Text | 192.168.1.100 | IP |
| Port | Long | 443 | Https port number |
| Preset File Prefix |
| Prefix | Text | “” | Prefix of Preset file names valid for this particular device instance |
| Debug |
| Enable | Boolean | No | Yes/No - Enable/Disable debug prints |

# Functions

## Save/RecallPreset

These functions allow to store and recall the device configuration settings including all layout, input params, encoders and streamers settings.

#### Syntax

```visualbasic
Function SavePreset(presetNumber As Byte ) As Boolean
```

```visualbasic
Function RecallPreset(presetNumber As Byte ) As Boolean
```


#### Parameters

preserNumber**     Byte**           preset number


#### Return value **           Boolean               True ** -Preset Save/Recall OK, **False**  -Preset Save/Recall Failed (Possible reasons:  Encoder unit not responding or User Login data are not valid  or read/write file operation failed.)

#### Example

```visualbasic
SavePreset (1)
```


 

The SavePreset()/RecallPreset()  functions are providing similar functions as “Manage Configurations” when using “Matrox PowerStream Plus” software:

![image](media://add19e91-63c6-4513-93d9-42d66853b67e)

 

Both Preset functions are working with files stored in **Filestorage** in subfolder **MaevexEncoderFiles**

 It means path: **/filestorage/MaevexEncoderFiles/**

This subfolder serves for all instances of this driver installed on the same CUEunit!

The file names for particular presets are created by using property “Preset File Prefix” and the number of requested preset like this:

 Prest file name:  **              {Prefix}.preset{n}**

Where

{Prefix} - is the text stored in property “Preset File Prefix”

{n}   is the number specified in parameter (presetNumber As Byte) of Save/RecallPreset function

 

Note that Prefix property must be used only if there are more instances of this diver installed on the same CUEunit. Otherwise it can be left as empty text - then the preset file name will be like this:

.preset1

.preset22

etc

If the property “Preset File Prefix” would be set for example to value “C1”

- then the preset file name will be like this:

C1.preset1

C1.preset22

etc

To prepare the requested Encoder device setting configurations use the “Matrox PowerStream Plus” software. Then after successfully finishing with Apply in PowerStream Plus - you can use the functions  **SavePreset() **in your project and store the current configuration of the Encoder.

 

### Storing Presets as part of the project data

If the project needs the Maevex Device preset data to be kept as part of the project data, then it is necessary to copy these files to CVC project into Filestorage of appropriate CUEunit which is owner of this instance of the driver.

In CVC select cue unit instance File storage like this:

If the subfolder **MaevexEncoderFiles **is not existing then create such subfolder

![image](media://1cad17b9-f0f4-4b9f-96ce-6daa0b114901)


Open the subfolder and copy there the preset files.

![image](media://66e5f68f-aaa1-47d6-a0ed-f684c227e7d5)


In the example above there were used two instances of this driver one instance using prefix: “” (empty text) and the second the prefix: “c1”  - so the files for both encoders are to be stored there.

 

When storing the preset files in the CVC project in Filestorage - then by every Project “Final” all the files will be uploaded into Filestorage of the CUE unit (– rewriting content of already existing files there in CUE unit Filestorage..)

 

Note that the Filestorage folder here in the CVC project is not affected when using the unit in Simulation. During the Simulation all runtime file changes are done in the “Temporary Filestorage of Simulated Unit” – these temporary data are accessible when “Right-clicking” the Filestorage folder in

the project..)

 

## Enable/Disable Streamer 

These functions allow to Enable/Disable Streamer 

#### Syntax

```visualbasic
Function EnableStreamerByName( streamerName As Text) As Boolean
```

```visualbasic
Function DisableStreamerByName( streamerName As Text) As Boolean
```


#### Return value    **Boolean True **      -success, **False**      -Not success.

#### Parameters

**streamerName  **as Text

streamer name - see bellow

#### Example

```visualbasic
Encoder1.EnableStreamerByName(“RTSP, on port 15000”)
```

 

Parameter **streamerName  **as Text** -** means the Name (or Friendly name ) which is to be set in “Matrox PowerStream Plus” software in section for setting the output Streamer

like here the Streamer Name was set to value “RTSP, on port 15000”

![image](media://322a53f0-0d7e-42ce-bddf-cc8e932e60be)

Then command for enable this stream:

**   Encoder1. EnableStreamerByName(“**RTSP, on port 15000”)

 

## Audio Inputs/Output 

The Encoder is equipped with analog audio inputs and audio outputs. These can be controlled by following commands:

## MuteAudioInputPort 

#### Syntax

```visualbasic
Function MuteAudioInputPort( portIndex As Long, mute As Boolean) As Boolean
```

#### Parameters

portIndex           **Long**                      port index number     0,1,2... (for 6152 Encoder:  5..8)

mute                  **Boolean               True**: Mute On, **False**: MuteOff

#### Return value **           Boolean               True **– success, False** **- not success


#### Example

```visualbasic
Encoder1.MuteAudioInputPort( 5, True )  // port 5 : Mute On
```


## SetGainOfAudioInputPort 

Syntax

```visualbasic
Function SetGainOfAudioInputPort( portIndex As Long, gain As Byte) As Boolean
```

#### Parameters

portIndex           **Long**                      port index number     0,1,2... (for 6152 Encoder:  5..8)

gain                    **Byte**                       for 6152 Encoder portIndex 5-7 value  0…66 (means -60dB…+6dB) ** **

**                                                                **for 6152 Encoder portIndex 8: value  0…115 (means -74dB…+41dB)

#### Return value **           Boolean               True **– success, False** **- not success


#### Example

```visualbasic
Encoder1.SetGainOfAudioInputPort( 5, 23 )  // port 5 : gain 23
```

## MuteAudioOutputPort 

#### Syntax

```visualbasic
Function MuteAudioOutputPort( portIndex As Long, mute As Boolean) As Boolean
```

#### Parameters

portIndex           **Long**                      port index number     0,1,2... (for 6152 Encoder:  0)

mute                  **Boolean               True**: Mute On, **False**: MuteOff

#### Return value **           Boolean               True **– success, False** **- not success


#### Example

```visualbasic
Encoder1.MuteAudioOutputPort( 0, True )  // port 0 : Mute On
```


## SetVolumeOfAudioOutputPort 

Syntax

```visualbasic
Function SetVolumeOfAudioOutputPort( portIndex As Long, volume As Byte) As Boolean
```

#### Parameters

portIndex           **Long**                      port index number     0,1,2... (for 6152 Encoder: 0)

volume                    **Byte**                       for 6152 Encoder value  0…74 (means -74dB…0dB) ** ** ** **

#### Return value **           Boolean               True **– success, False** **- not success


#### Example

```visualbasic
Encoder1.SetVolumeOfAudioOutputPort( 0, 23 )  // port 0 : volume 23
```