Overlay configuration

The SDK provides a full range of possible Configuration items for the Overlay when it's displayed to the user.

Overview

The Configurations are available through the following classes :

• configuration holds every instances of the following classes to make them directly usable
• overlay holds every related field->value to cutomize the Overlay
• users holds every related field->value to customize the Users in the Overlay
• speaker holds every related field->value to customize the Speaker in the Overlay
• actionBar holds every related field->value to customize the ActionBar in the Overlay

Access

Each of the various configurations available in the UXKit have an accessible configuration field describing and holding every modification the developers can do.

Any modification must be done prior to the Overlay being displayed.

let configuration = VoxeetUXKit.shared.conferenceController?.configuration

let overlay = configuration?.overlay
let users = configuration?.users
let speaker = configuration?.speaker
let actionbar = configuration?.actionBar

Overlay customisation

The various parameters can be changed by developers:

• backgroundMaximizedColor
• backgroundMinimizedColor
• displayAction

let configuration = VoxeetUXKit.shared.conferenceController?.configuration
let overlay = configuration?.overlay

overlay?.backgroundMinimizedColor = .blue
overlay?.backgroundMaximizedColor = .orange
overlay?.displayAction = false

Users customisation

The various parameters can be changed by developers:

• speakingUserColor
• selectedUserColor
• displayLeftUsers

let configuration = VoxeetUXKit.shared.conferenceController?.configuration
let users = configuration?.users

users?.speakingUserColor = .green
users?.selectedUserColor = .yellow
users?.displayLeftUsers = false

Speaker customisation

The various parameters can be changed by developers:

• speakingUserColor

let configuration = VoxeetUXKit.shared.conferenceController?.configuration
let speaker = configuration?.speaker

speaker?.speakingUserColor = .green

ActionBar customisation

The ActionBar can be edit to:

• display buttons
• override buttons images

Modify the buttons visibility

The following fields can be set:

• displayMute *boolean display the (-)/unmute local mic default true
• displayCamera *boolean display the de/-activate the local Camera default true
• displaySpeaker *boolean display the internal/external speaker default true
• displayScreenShare *boolean display the de/-activate the local screenshare feature default true
• displayLeave *boolean display the hangup button default true

Modify the buttons images

• overrideMuteOn UIImage
• overrideMuteOff UIImage
• overrideCameraOn UIImage
• overrideCameraOff UIImage
• overrideSpeakerOn UIImage
• overrideSpeakerOff UIImage
• overrideScreenShareOn UIImage
• overrideScreenShareOff UIImage
• overrideLeave UIImage