Constructor
new MultimediaController()
This class cannot be instantiated.
- Since:
- 11.7.0
Members
(static) cameraList :Array.<Camera>
List of available cameras.
Type:
- Array.<Camera>
- Since:
- 11.7.0
(static) microphoneList :Array.<Microphone>
List of available microphones.
Type:
- Array.<Microphone>
- Since:
- 11.7.0
(static) ringerList :Array.<Ringer>
List of available ringers.
Type:
- Array.<Ringer>
- Since:
- 11.7.0
(static) ringtoneList :Array
List of available ringtones.
Type:
- Array
- Since:
- 11.7.0
(static) speakerList :Array.<Speaker>
List of available speakers.
Type:
- Array.<Speaker>
- Since:
- 11.7.0
Methods
(static) addEventHandler(eventName, eventHandler)
Add handler function for multimedia controller's events.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
String | Name of the event. |
eventHandler |
function | Function that will be called when event is fired. |
- Since:
- 11.7.0
(static) highlightMonitor(monitor, errorHandleropt)
Highlights monitor by displaying border around its edges.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
monitor |
Monitor | Monitor that will be highlighted. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) playRingtoneOnAllRingers(errorHandleropt)
On incoming call, ringtone will be played on all ringer devices. Calling this method will ignore any ringer device
previously set as active. Once a new ringer device is set as active ringtone will then only play on active ringer
device.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
(static) refreshMediaDeviceList(errorHandleropt)
Refresh the list of available media devices:
- Speakers
- Microphones
- Ringers
- Cameras
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) refreshMonitorList(errorHandleropt)
Refresh the list of connected monitors.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) refreshRingtoneList(errorHandleropt)
Refresh the list of available ringtones.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) removeEventHandler(eventName)
Remove handler function for multimedia controller's event.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
String | Name of the event. |
- Since:
- 11.7.0
(static) selectCamera(camera, errorHandleropt)
Select new active camera.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
camera |
Camera | Camera that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) selectMicrophone(microphone, errorHandleropt)
Select new active microphone.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
microphone |
Microphone | Microphone that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) selectMonitor(monitor, errorHandleropt)
Select new active monitor that will be used for screen sharing.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
monitor |
Monitor | Monitor that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) selectRinger(ringer, errorHandleropt)
Select new active camera.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ringer |
Ringer | Ringer that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) selectRingtone(ringtone, errorHandleropt)
Select new active ringtone for incoming calls.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ringtone |
Ringtone | Ringtone that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) selectSpeaker(speaker, errorHandleropt)
Select new active speaker.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
speaker |
Speaker | Speaker that will be set as active. | |
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) setMonitorHighlightColor(red, green, blue, errorHandleropt)
Set new monitor highlight color.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
red |
Red color value. | ||
green |
Green color value. | ||
blue |
blue color value. | ||
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
(static) unHighlightMonitor(errorHandleropt)
UnHighlights current highlighted monitor by hiding border around its edges.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
errorHandler |
function |
<optional> |
Called if error has occurred in add-on. |
- Since:
- 11.7.0
Events
onMediaDeviceListChanged
This event is fired when:
- MediaDevice has been added or remove from the list.
- MediaDevice has been set as an active device.
- refreshMediaDeviceList() method has been called.
- Since:
- 11.7.0
onMonitorListChanged
This event is fired whenever refreshMonitorList() method is called.
Parameters:
| Name | Type | Description |
|---|---|---|
monitorList |
Array.<Monitor> | List of monitors. |
- Since:
- 11.7.0
onRingtoneListChanged
This event is fired whenever refreshRingtoneList() method is called.
- Since:
- 11.7.0