Class: MediaInterface

Constructor

new MediaInterface(mediaInterfaceService)

Parameters:
Name Type Description
mediaInterfaceService AvayaClientServices.Base.MediaInterfaceService

Methods

getAvailableDevices() → {Array.<AvayaClientServices.Base.VideoDevice>|Array.<AvayaClientServices.Base.AudioDevice>}

Returns:

getMediaAccessCapability() → {AvayaClientServices.Base.Capability}

The function returns capability to perform media access.

Returns:

getSelectDeviceCapability() → {AvayaClientServices.Base.Capability}

The function returns capability to select device.

Returns:

getSelectedDevice() → {AvayaClientServices.Base.VideoDevice}

The function gets the selected capture device for video.

Returns:

hasAvailableDevices() → {boolean}

Returns a boolean indicating if devices of this type exists. This method
will work prior to the user granting access to the mic/camera media stream.

Returns:
{ boolean }

setSelectedDevice(device)

The function sets the capture device for video. This will not affect any active video sessions.

Parameters:
Name Type Description
device AvayaClientServices.Base.VideoDevice | AvayaClientServices.Base.AudioDevice

start() → {AvayaClientServices.Base.Promise}

Starts media interface

Returns:

stop() → {AvayaClientServices.Base.Promise}

Stop media interface

Returns:

Managing callbacks

addOnDevicesAddedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesAddedCallback

Function to be called

Returns:
{ void }

addOnDevicesRemovedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesRemovedCallback

Function to be called

Returns:
{ void }

addOnDevicesUnavailableCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesUnavailableCallback

Function to be called

Returns:
{ void }

addOnDevicesUpdatedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#addOnDevicesUpdatedCallback

Function to be called

Returns:
{ void }

addOnSelectedDeviceChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onSelectedDeviceChanged

Function to be called

Returns:
{ void }

addOnSelectedDeviceRemovedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onSelectedDeviceRemovedCallback

Function to be called

Returns:
{ void }

cleanUpOnDevicesAddedCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

cleanUpOnDevicesRemovedCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

cleanUpOnDevicesUnavailableCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

cleanUpOnDevicesUpdatedCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

cleanUpOnSelectedDeviceChangedCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

cleanUpOnSelectedDeviceRemovedCallbacks() → {void}

Removes all previously added callbacks

Returns:
{ void }

removeOnDevicesAddedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesAddedCallback

Function to be removed

Returns:
{ void }

removeOnDevicesRemovedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesRemovedCallback

Function to be removed

Returns:
{ void }

removeOnDevicesUnavailableCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onDevicesUnavailableCallback

Function to be removed

Returns:
{ void }

removeOnDevicesUpdatedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#addOnDevicesUpdatedCallback

Function to be removed

Returns:
{ void }

removeOnSelectedDeviceChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onSelectedDeviceChanged

Function to be removed

Returns:
{ void }

removeOnSelectedDeviceRemovedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Base.MediaInterface#onSelectedDeviceRemovedCallback

Function to be removed

Returns:
{ void }

Type Definitions

addOnDevicesUpdatedCallback(mediaInterface, devices) → {void}

Called to report that audio or video devices label were updated

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
devices Array.<AvayaClientServices.Base.VideoDevice> | Array.<AvayaClientServices.Base.AudioDevice>
Returns:
{ void }

onDevicesAddedCallback(mediaInterface, devices) → {void}

Called to report that audio or video devices were added

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
devices Array.<AvayaClientServices.Base.VideoDevice> | Array.<AvayaClientServices.Base.AudioDevice>
Returns:
{ void }

onDevicesRemovedCallback(mediaInterface, devices) → {void}

Called to report that audio or video devices were removed

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
devices Array.<AvayaClientServices.Base.VideoDevice> | Array.<AvayaClientServices.Base.AudioDevice>
Returns:
{ void }

onDevicesUnavailableCallback(mediaInterface) → {void}

Called to report that no device is available

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
Returns:
{ void }

onSelectedDeviceChanged(mediaInterface, device) → {void}

Called to report that device was changed

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
device AvayaClientServices.Base.AudioDevice | AvayaClientServices.Base.VideoDevice
Returns:
{ void }

onSelectedDeviceRemovedCallback(mediaInterface, device) → {void}

Called to report that selected device was removed

Parameters:
Name Type Description
mediaInterface AvayaClientServices.Base.MediaInterface
device AvayaClientServices.Base.VideoDevice | AvayaClientServices.Base.AudioDevice
Returns:
{ void }
©2016 Avaya Inc. All Rights Reserved.