---
title: "Bosh Dicentis (DCNM)"
canonical: "https://docs.cuesystem.com/space/CVCDD/1964769303/Bosh%20Dicentis%20(DCNM)"
format: markdown
---
> Macro (toc)

---

# Description

Driver for Bosh Dicentis Conference system (DCNM)  connected via LAN and using JSON return value.

# Resources

# Properties

|  |  |  |  |
| --- | --- | --- | --- |
| Property name | Data type | Default value | Description |
| Connection |
| Address | Text | "127.0.0.1" |  |
| Port | Long | 31416 |  |
| Timeout | Time | :10 |  |
| Login |
| user | Text | "" |  |
| password | Text | "" |  |
| Debug |
| Debug print | Enum | None | None | Command | Communication |

# Functions

## AbortVoting

Abort the open or activated voting.

#### Syntax

```visualbasic
AbortVoting() 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

```

## AcceptVoting

Accept the closed voting.

#### Syntax

```visualbasic
AcceptVoting() 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

```

## ActivateAdHocVoting

Activate an ad-hoc voting.

#### Syntax

```visualbasic
ActivateAdHocVoting(ByVal txtDscr As Text, lNo As Long, ByVal txtSubj As Text) As Boolean
```

#### Parameters

txtDscr

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

lNo

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

txtSubj

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

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

```

## ActivateMeeting

Activate a meeting.

#### Syntax

```visualbasic
ActivateMeeting(ByVal txtId As Text) As Boolean
```

#### Parameters

txtId

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

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

```

## ActivateMicrophone

Un-mutes the microphone for the specified seat.

#### Syntax

```visualbasic
ActivateMicrophone(ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtSeatId

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

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

```

## ActivatePresentation

Activate the presentation screen of the device.

#### Syntax

```visualbasic
ActivatePresentation() 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

```

## ActivateVoting

Activate a voting.

#### Syntax

```visualbasic
ActivateVoting(ByVal txtVotingId As Text) As Boolean
```

#### Parameters

txtVotingId

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

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

```

## AddSeatToSpeakers

Adds the seat to active speakers list.

#### Syntax

```visualbasic
AddSeatToSpeakers(ByVal participantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

participantId

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

txtSeatId

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

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

```

## CheckForPermission

Check the permissions of the logged-in user.

#### Syntax

```visualbasic
CheckForPermission(ByVal bsToFind As ByteString) As Boolean
```

#### Parameters

bsToFind

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

- "canManageMeeting"
- "canEditSynoptic"
- "canSelect"
- "canAddDevicesToSeats"
- "canViewSynoptic"
- "canViewVoting"
- "canEnableSeatIllumination"
- "canSwitchSystemPowerOn"
- "canSwitchSystemPowerOff"
- "canViewRequestItems"
- "canViewFirstRequestOnSeat"
- "canDeactivateMicrophone"
- "hasSpecialPermission"
- "canControlInterpretation"
- "canViewInterpretation"
- "canControlMasterVolume"
- "canPrepareMeetingAndAgenda"
- "canViewMeetingNotes"
- "canViewVotingNotes"
- "canViewRemoteParticipants"
- "canControlVoting"
- "hasParticipantBasedLicense"
- "canControlMicrophoneSensitivity”

#### Return value

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> True if user has permission otherwise False.

#### Example

```visualbasic
Bosh.CheckForPermission( &S"canAddDevicesToSeats")
```

## CloseAgenda

Close Agenda for current meeting.

#### Syntax

```visualbasic
CloseAgenda() 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

```

## CloseMeeting

To close active meeting.

#### Syntax

```visualbasic
CloseMeeting() 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

```

## CloseVoting

Close the open voting.

#### Syntax

```visualbasic
CloseVoting() 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

```

## Connect

This function open communication with unit and log in user.

#### Syntax

```visualbasic
Connect() 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

```

## DeactivateMeeting

To deactivate active meeting.

#### Syntax

```visualbasic
DeactivateMeeting() 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

```

## DeactivateMicrophone

Mute the microphone for the specified seat.

#### Syntax

```visualbasic
DeactivateMicrophone(ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtSeatId

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

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

```

## DeactivatePresentation

De-Activate the presentation screen of the device.

#### Syntax

```visualbasic
DeactivatePresentation() 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

```

## DecreaseSpeechTime

Decrease speech time for participant.

#### Syntax

```visualbasic
DecreaseSpeechTime(ByVal txtParticipantId As Text, ByVal txtSeatId As Text, ByRef fStatus As Boolean) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

fStatus

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> ... returns True if success operation.

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

```

## Disconnect

Log off user and close communication with unit.

#### Syntax

```visualbasic
Disconnect() 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

```

## EnableSeatIllumination

Enables or disables seat illumination mode.

#### Syntax

```visualbasic
EnableSeatIllumination(fEnable As Boolean) As Boolean
```

#### Parameters

fEnable

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

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

```

## GetAgendaTopics

Gets the list of agenda topics information for the active meeting.

#### Syntax

```visualbasic
GetAgendaTopics(ByVal txtMeetingId As Text, ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

txtMeetingId

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

bsJSON

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

{  
	"agendaTopics":  
	[  
		{  
			"agendaTopicId": <string>,  
			"description": <string>,  
			"discussionId": <string>,  
			"meetingId": <string>,  
			"state": "opened"|"closed",  
			"subject": <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

```

## GetDiscussionList

Gets the list of speakers, requests, request responders, important and priority speakers of the active discussion.

#### Syntax

```visualbasic
GetDiscussionList(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"discussionList":  
	[  
		{  
			"activeImage": <bool>,  
			"activeVideo": <bool>,  
			"adjustSpeechTime": <bool>,  
			"adjustSpeechTimeDuration": <int>,  
			"isFirst": <bool>,  
			"isLastMinuteActivated": <bool>,  
			"microphoneState": "off"|"on"|"mute",  
			"participantId": <string>,  
			"personInfoId": <string>,  
			"remainingSpeechDuration": <int>,  
			"screenLine": <string>,  
			"seatId": <string>,  
			"showSpeechTimer": <bool>,  
			"speakerType": "isSpeaker"|"isPrioritySpeaker"|"isResponder"|"isImportant"|"isRequest"|"isResponseRequest",  
			"speechStartTime": <int>,  
			"totalSpeechTime": <int>  
		}  
	],  
	"referenceTime": <int>  
}

#### 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
Var lCount As Long
	Var bs As ByteString[6000]
	Var x As Long
	Var t As Text[64]
	Var s As Text[64]
	
	If Bosh.GetDiscussionList(bs) And Parser.Parse(bs) And Parser.GetRootItem( RootItem) Then
		If RootItem.GetSubItemByName( SubItem, "discussionList", True) Then
			lCount := SubItem.GetSubItemCount()
			If lCount > 0 Then
				For x := 1 To lCount
					If RootItem.GetSubItemByPathCaseInsensitive( SubItem, "discussionList", x, "seatId") Then SubItem.GetStringValueAsText( s) End If
					If RootItem.GetSubItemByPathCaseInsensitive( SubItem, "discussionList", x, "microphoneState") Then SubItem.GetStringValueAsText( t) End If
					DebugPrintFormat("DiscussionList [{N}]: seatId-{T}, microphoneState-{T}", x, s, t)
				End For
			End If
		End If
	End If

```

## GetEnableSeatIllumination

Gets state whether system is in installation mode or not.

#### Syntax

```visualbasic
GetEnableSeatIllumination(ByRef fEnable As Boolean) As Boolean
```

#### Parameters

fEnable

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

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

```

## GetIlluminatedSeat

Gets identifier of the illuminated seat.

#### Syntax

```visualbasic
GetIlluminatedSeat(ByRef bsSeatId As ByteString) As Boolean
```

#### Parameters

bsSeatId

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

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

```

## GetIndividualVotingResults

Gets individual voting results.

#### Syntax

```visualbasic
GetIndividualVotingResults(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"votingResults":  
	[  
		{  
			"participantId": <string>,  
			"votingAnswer": "notVoted"|"yes"|"no"|"abstain"|"dnpv"|"for"|"against"|"present"|"voteCasted"|"A"|"B"|"C"|"D"  
		}  
	]  
}

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

```

## GetMajorityResult

Gets the majority result of the active voting.

#### Syntax

```visualbasic
GetMajorityResult(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"majorityResult":  
	{  
		"comparisonOperator": "greaterThan"|"greaterThanOrEqualTo"|"equals"|"lessThan"|"lessThanOrEqualTo",  
		"denominatorValue": <int>,  
		"isEnabled": <bool>,  
		"numeratorValue": <int>,  
		"status": "true"|"false"|"error",  
		"thresholdValue": <int>  
	}  
}

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

```

## GetMasterVolume

Gets the master volume of the DICENTIS System.

#### Syntax

```visualbasic
GetMasterVolume(ByRef dValue As Double) As Boolean
```

#### Parameters

dValue

<u>[Double](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double)</u> ... returns current volume level

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

```

## GetMasterVolumeRange

Gets the master volume range (minimum and maximum) of the DICENTIS System.

#### Syntax

```visualbasic
GetMasterVolumeRange(ByRef dMin As Double, ByRef dMax As Double) As Boolean
```

#### Parameters

dMin

<u>[Double](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double)</u> ... returns minimal volume level

dMax

<u>[Double](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Double)</u> ... returns maximal volume level

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

```

## GetMeetingInfo

Gets the information related to the active meeting.

#### Syntax

```visualbasic
GetMeetingInfo(ByVal txtMeetingId As Text, ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

txtMeetingId

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

bsJSON

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

{  
	"meetingInfo":  
	{  
		"agendaList":  
		[  
			{  
				"agendaTopicId": <string>,  
				"description": <string>,  
				"discussionId": <string>,  
				"meetingId": <string>,  
				"state": "opened"|"closed",  
				"subject": <string>  
			}  
		],  
		"autoOpenOnActivate": <bool>,  
		"autoStartAgendaOnOpen": <bool>,  
		"defaultDiscussionId": <string>,  
		"description": <string>,  
		"documentationRef": <string>,  
		"identificationMethod": "fixed"|"userName"|"selectFromList"|"qRCode"|"externalSystem"|"nFC"|"nFCKeptAtDevice",  
		"isDefault": <bool>,  
		"meetingEndDate": <dateTime>,  
		"meetingId": <string>,  
		"meetingStartDate": <dateTime>,  
		"state": "activated"|"deactivated"|"opened"|"closed",  
		"title": <string>,  
		"verificationMethod": "none"|"confirmation"|"password"|"pINCode"|"externalSystem"  
	}  
}

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

```

## GetMeetings

Gets the list of meetings.

#### Syntax

```visualbasic
GetMeetings(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"meetings":  
	[  
		{  
			"agendaList":  
			[  
				{  
					"agendaTopicId": <string>,  
					"description": <string>,  
					"discussionId": <string>,  
					"meetingId": <string>,  
					"state": "opened"|"closed",  
					"subject": <string>  
				}  
			],  
			"autoOpenOnActivate": <bool>,  
			"autoStartAgendaOnOpen": <bool>,  
			"defaultDiscussionId": <string>,  
			"description": <string>,  
			"documentationRef": <string>,  
			"identificationMethod": "fixed"|"userName"|"selectFromList"|"qRCode"|"externalSystem"|"nFC"|"nFCKeptAtDevice",  
			"isDefault": <bool>,  
			"meetingEndDate": <dateTime>,  
			"meetingId": <string>,  
			"meetingStartDate": <dateTime>,  
			"state": "activated"|"deactivated"|"opened"|"closed",  
			"title": <string>,  
			"verificationMethod": "none"|"confirmation"|"password"|"pINCode"|"externalSystem"  
		}  
	]  
}

#### 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
Var txt As Text[2048]
Var bs As ByteString[6000]
Var Parser As _JSONParser
Var RootItem As _JSONItem
Var SubItem As _JSONItem
Var lCount As Long
Var x As Long
Var t As Text[64]
If Bosh.GetMeetings(bs) And Parser.Parse(bs) And Parser.GetRootItem( RootItem) Then
	If RootItem.GetSubItemByName( SubItem, "meetings", True) Then
		lCount := SubItem.GetSubItemCount()
		If lCount > 0 then
			For x := 1 To lCount
				If RootItem.GetSubItemByPathCaseInsensitive( SubItem, "meetings", x, "title") Then SubItem.GetStringValueAsText( txt) End If
				If RootItem.GetSubItemByPathCaseInsensitive( SubItem, "meetings", x, "state") Then SubItem.GetStringValueAsText( t) End If
				DebugPrintFormat("Seat [{N}]: {T} {T}", x, txt, t)
			End For
		End If
	End If
End If

```

## GetMicrophoneSensitivity

Gets microphone sensitivity for seat ids.

#### Syntax

```visualbasic
GetMicrophoneSensitivity(ByVal txtSeatId As Text, ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

txtSeatId

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

bsJSON

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

{  
	"seatMicrophoneSensitivities":  
	[  
		{  
			"seatId": <string>,  
			"seatName": <string>,  
			"sensitivityValue": <int>  
		}  
	]  
}

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

```

## GetMicrophoneSensitivityDescription

Gets microphone sensitivity description from system.

#### Syntax

```visualbasic
GetMicrophoneSensitivityDescription(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"micSensitivityDescription":  
	{  
		"maximumMicrophoneSensitivity": <int>,  
		"microphoneSensitivityStepSize": <int>,  
		"minimumMicrophoneSensitivity": <int>  
	}  
}

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

Gets the power state of the system.

#### Syntax

```visualbasic
GetPower(ByRef bsMode As ByteString) As Boolean
```

#### Parameters

bsMode

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... returns current power mode of unit, one of:

- "poweredOn"
- "poweredOff"
- "poweringOn"
- "poweringOff"

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

```

## GetPresentationState

Gets the current presentation state whether the presentation is enabled / disabled.

#### Syntax

```visualbasic
GetPresentationState(ByRef fEnabled As Boolean) As Boolean
```

#### Parameters

fEnabled

<u>[Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#Boolean)</u> ... returns current state of presentation

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

```

## GetQuorumResult

Gets the quorum result of the active meeting.

#### Syntax

```visualbasic
GetQuorumResult(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"quorumResult":  
	{  
		"comparisonOperator": "greaterThan"|"greaterThanOrEqualTo"|"equals"|"lessThan"|"lessThanOrEqualTo",  
		"denominatorValue": <int>,  
		"isEnabled": <bool>,  
		"numeratorValue": <int>,  
		"status": "true"|"false"|"error",  
		"thresholdValue": <int>  
	}  
}

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

```

## GetRemainingVoteTime

Gets remaining vote time.

#### Syntax

```visualbasic
GetRemainingVoteTime(ByRef lTime As Long) As Boolean
```

#### Parameters

lTime

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

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

```

## GetRoomContactEmail

Gets room contact email.

#### Syntax

```visualbasic
GetRoomContactEmail(ByRef bsEmail As ByteString) As Boolean
```

#### Parameters

bsEmail

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... returns contact e-mail

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

```

## GetRoomName

Gets room name.

#### Syntax

```visualbasic
GetRoomName(ByRef bsName As ByteString) As Boolean
```

#### Parameters

bsName

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... returns room 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

```

## GetSeats

Gets list of participant seats.

#### Syntax

```visualbasic
GetSeats(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"seats":  
	[  
		{  
			"assignedParticipantId": <string>,  
			"attributes": [<string>],  
			"canPrio": <bool>,  
			"canVote": <bool>,  
			"devices":  
			[  
				{  
					"capabilities":  
					[  
						"hasNone"|"hasPowerOn"|"hasPowerOff"|"hasVolumeControl"|"hasDualUse"  
					],  
					"deviceState": "versionMismatch"|"error"|"operational",  
					"id": <string>,  
					"isFoundAtSeat": <bool>,  
					"isSelected": <bool>,  
					"name": <string>,  
					"serialNumber": <string>,  
					"subDeviceInstance": <int>,  
					"typeOf": "unknown"|"standardConferenceDevice"|"interpretationDevice"|"onvifCamera"|"audioPoweringSwitch"|  
						"meetingApplication"|"pTZOnvifCamera"|"videoSwitch"|"externalVideoSwitch"|"presentationDevice"|  
						"poweringSwitch"|"multimediaDevice"|"multimediaDeviceSimulator"|"videoStream"|"oMI"|"discussionDeviceBasic"|  
						"discussionDevice"|"discussionDeviceVoting"|"discussionDeviceLanguageSelection"|"discussionDeviceExtended"|  
						"sonyCameraDevice"|"panasonicCameraDevice"|"interpretationDeviceWithVideo"|"flushDeviceSelectLanguage"|,  
					"version": <string>  
				}  
			],  
			"foundDevices": [<string>],  
			"hasVotingLicense": <bool>,  
			"hideSeat": <bool>,  
			"screenLine": <string>,  
			"seatedParticipantId": <string>,  
			"seatId": <string>,  
			"seatName": <string>,  
			"seatType": "local"|"remote",  
			"status": "disconnected"|"connected"|"selected",  
			"supportsSpeaking": <bool>,  
			"visType": "none"|"buttonOperated"|"pttOperated"  
		}  
	]  
}

#### 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
	Var lCount As Long
	Var x As Long
	Var bs As ByteString[6000]
	Var s As Text[64]
	
	If Bosh.GetSeats(bs) And Parser.Parse(bs) And Parser.GetRootItem( RootItem) Then
		If RootItem.GetSubItemByName( SubItem, "seats", True) Then
			lCount := SubItem.GetSubItemCount()
			If lCount > 0 Then
				For x := 1 To lCount
					If RootItem.GetSubItemByPathCaseInsensitive( SubItem, "seats", x, "seatName") Then SubItem.GetStringValueAsText( s) End If
					DebugPrintFormat("Seat [{N}]: {T}", x, s)
				End For
			End If
		End If
	End If

```

## GetSeatVotingResults

Gets seat voting results.

#### Syntax

```visualbasic
GetSeatVotingResults(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"votingResults":  
	[  
		{  
			"seatId": <string>,  
			"votingAnswer": "notVoted"|"yes"|"no"|"abstain"|"dnpv"|"for"|"against"|"present"|"voteCasted"|"A"|"B"|"C"|"D"  
		}  
	]  
}

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

```

## GetSpeechTimerOptions

Gets the speech timer options of the active discussion.

#### Syntax

```visualbasic
GetSpeechTimerOptions(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"speechTimerOptions":  
	{  
		"canAdjustSpeechTimer": <bool>,  
		"showSpeechTimer": <bool>,  
		"speechTimerDurationInSeconds": <int>  
	}  
}

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

```

## GetVotingInfo

Gets the active voting.

#### Syntax

```visualbasic
GetVotingInfo(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{

               "votingInfo":

               {

                              "description": <string>,

                              "documentationLink": <string>,

                              "majorityVariables": [<string>],

                              "meetingId": <string>,

                              "referenceNumber": <string>,

                              "state": "closed"|"ready"|"opened"|"onHold"|"done"|"canceled"|"accepted"|"rejected",

                              "subject": <string>,

                              "usePresentButton": <bool>,

                              "useVoteWeight": <bool>,

                              "voteMajorityInfo":

                              {

                                             "isEnabled": <bool>,

                                             "majorityCondition": "greaterThan"|"greaterThanOrEqualTo"|"equals"|"lessThan"|"lessThanOrEqualTo",

                                             "majorityDenominatorExpression": <string>,

                                             "majorityNumeratorExpression": <string>,

                                             "majorityThresholdExpression": <string>

                              },

                              "votingAnswers":

                              [

                              "notVoted"|"yes"|"no"|"abstain"|"dnpv"|"for"|"against"|"present"|"voteCasted"|"A"|"B"|"C"|"D"

                              ],

                              "votingId": <string>,

                              "votingTimeDuration": <int>,

                              "votingTimerType": "noVotingTimer"|"keepVotingOpen"|"holdVotingRound"|"closeVotingRound"

               }

}

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

```

## GetVotingResults

Gets the voting results of the active voting.

#### Syntax

```visualbasic
GetVotingResults(ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

bsJSON

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

{  
	"votingResults":  
	[  
		{  
			"answer": "notVoted"|"yes"|"no"|"abstain"|"dnpv"|"for"|"against"|"present"|"voteCasted"|"A"|"B"|"C"|"D",  
			"count": <int>  
		}  
	]  
}

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

```

## GetVotings

Gets the list of prepared voting's of the active meeting.

#### Syntax

```visualbasic
GetVotings(ByVal txtMeetingId As Text, ByRef bsJSON As ByteString) As Boolean
```

#### Parameters

txtMeetingId

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

bsJSON

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

{  
	"votingList":  
	[  
		{  
			"description": <string>,  
			"documentationLink": <string>,  
			"majorityVariables": [<string>],  
			"meetingId": <string>,  
			"referenceNumber": <string>,  
			"state": "closed"|"ready"|"opened"|"onHold"|"done"|"canceled"|"accepted"|"rejected",  
			"subject": <string>,  
			"usePresentButton": <bool>,  
			"useVoteWeight": <bool>,  
			"voteMajorityInfo":  
			{  
				"isEnabled": <bool>,  
				"majorityCondition": "greaterThan"|"greaterThanOrEqualTo"|"equals"|"lessThan"|"lessThanOrEqualTo",  
				"majorityDenominatorExpression": <string>,  
				"majorityNumeratorExpression": <string>,  
				"majorityThresholdExpression": <string>  
			},  
			"votingAnswers":  
			[  
				"notVoted"|"yes"|"no"|"abstain"|"dnpv"|"for"|"against"|"present"|"voteCasted"|"A"|"B"|"C"|"D"  
			],  
			"votingId": <string>,  
			"votingTimeDuration": <int>,  
			"votingTimerType": "noVotingTimer"|"keepVotingOpen"|"holdVotingRound"|"closeVotingRound"  
		}  
	]  
}

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

```

## GetVotingState

Gets the state of active voting.

#### Syntax

```visualbasic
GetVotingState(ByRef bsState As ByteString) As Boolean
```

#### Parameters

bsState

<u>[ByteString](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString)</u> ... returns current voting state, one of:

- "closed"
- "ready"
- "opened"
- "onHold"
- "done"
- "canceled"
- "accepted"
- "rejected"

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

```

## GrantResponse

Shifts the given seat participant to the responders list and removes the oldest speaker in the responders list.

#### Syntax

```visualbasic
GrantResponse(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## GrantSpeech

Adds the seat or participant to active speakers list.

#### Syntax

```visualbasic
GrantSpeech(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## HoldVoting

Hold the open voting.

#### Syntax

```visualbasic
HoldVoting() 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

```

## IncreaseSpeechTime

Increase speech time for participant.

#### Syntax

```visualbasic
IncreaseSpeechTime(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## OpenAgenda

Open Agenda for current meeting.

#### Syntax

```visualbasic
OpenAgenda(ByVal txtAgenda As Text) As Boolean
```

#### Parameters

txtAgenda

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

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

```

## OpenMeeting

Open active meeting.

#### Syntax

```visualbasic
OpenMeeting() 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

```

## OpenVoting

Open the active voting.

#### Syntax

```visualbasic
OpenVoting() 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

```

## PowerOff

Sets the power mode of the system to OFF.

#### Syntax

```visualbasic
PowerOff() 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

```

## PowerOn

Sets the power mode of the system to ON.

#### Syntax

```visualbasic
PowerOn() 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

```

## RejectVoting

Reject the closed voting.

#### Syntax

```visualbasic
RejectVoting() 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

```

## RemoveResponse

Cancels a request to respond of a participant or seat.

#### Syntax

```visualbasic
RemoveResponse(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## RemoveSeatFromDiscussionList

Removes the seat from active speakers list.

#### Syntax

```visualbasic
RemoveSeatFromDiscussionList(ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtSeatId

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

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

```

## RemoveSpeech

Removes the seat or participant from active speakers list.

#### Syntax

```visualbasic
RemoveSpeech(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## RequestResponse

Adds the seat or participant to response request waiting list.

#### Syntax

```visualbasic
RequestResponse(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## RequestSpeech

Adds the seat or participant to waiting list.

#### Syntax

```visualbasic
RequestSpeech(ByVal txtParticipantId As Text, ByVal txtSeatId As Text) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

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

```

## ResetMicrophoneSensitivity

Resets microphone sensitivity for all seats.

#### Syntax

```visualbasic
ResetMicrophoneSensitivity(ByVal txtSeatId As Text, ByRef fStatus As Boolean) As Boolean
```

#### Parameters

txtSeatId

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

fStatus

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

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

```

## ResetSpeechTime

Resets speech timer for participant.

#### Syntax

```visualbasic
ResetSpeechTime(ByVal txtParticipantId As Text, ByVal txtSeatId As Text, ByVal fStatus As Boolean) As Boolean
```

#### Parameters

txtParticipantId

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

txtSeatId

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

fStatus

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

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

```

## ResumeVoting

Resume the on hold voting.

#### Syntax

```visualbasic
ResumeVoting() 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

```

## SetIlluminateSeat

Illuminates specified seat.

#### Syntax

```visualbasic
SetIlluminateSeat(ByVal txtSeatId As Text, ByVal fIlluminate As Boolean) As Boolean
```

#### Parameters

txtSeatId

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

fIlluminate

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

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

```

## SetMasterVolume

Sets the master volume of the system with the specified value(dB).

#### Syntax

```visualbasic
SetMasterVolume(ByVal dVolume As Double) As Boolean
```

#### Parameters

dVolume

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

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

```

## UpdateMicrophoneSensitivity

Update microphone sensitivity for seat ids.

#### Syntax

```visualbasic
UpdateMicrophoneSensitivity(ByVal txtSeatId As Text, ByVal txtName As Text, lValue As Long, ByRef fStatus As Boolean) As Boolean
```

#### Parameters

txtSeatId

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

txtName

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

lValue

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

fStatus

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

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

```