Class: KonvaContentSharingRenderer

Constructor

new KonvaContentSharingRenderer()

KonvaContentSharingRenderer extends Collaboration module ContentSharingRenderer.
It allows to render the images received from the server.

Members

<protected> _contentSharing :AvayaClientServices.Services.Collaboration.ContentSharing

Type:
  • AvayaClientServices.Services.Collaboration.ContentSharing
Inherited From:

_performanceMonitor

A performance monitor timer

Methods

autoFit(width, height) → {number}

Scales the sharing content to the maximum width or height of the parent container.

Parameters:
Name Type Description
width number

Width of the content sharing parent container in pixels.

height number

Height of the content sharing parent container in pixels.

Returns:
{ number }

scale

drawFrame(frame) → {void}

Draws on a screen frames received from the server.

Parameters:
Name Type Description
frame AvayaClientServices.Services.Collaboration.Frame

Frame that is going to be drawn.

Returns:
{ void }

getHeight() → {Number}

Returns height of the stage

Returns:
{ Number }

getWidth() → {Number}

Returns width of the stage

Returns:
{ Number }

init(contentSharing, containerId) → {void}

Initializes the content sharing renderer.

Parameters:
Name Type Description
contentSharing AvayaClientServices.Services.Collaboration.ContentSharing

Content sharing instance.

containerId string

ID of DOM element where content sharing will be append to.

Inherited From:
Returns:
{ void }

isRemoteController() → {Boolean}

Returns true if remote control participant is a controller

Inherited From:
Returns:
{ Boolean }

isRemoteControlParticipant() → {Boolean}

Returns true if remote control participant is a controller

Inherited From:
Returns:
{ Boolean }

onOverloaded(reason)

Parameters:
Name Type Description
reason String
Inherited From:

pause() → {void}

Pauses screen sharing.
Screen sharing can be paused only by the user who started the screen sharing.

Returns:
{ void }

performanceMonitorStart() → {void}

Performance monitor, monitor the load of the frames processing, and reduce the image quality if needed.

Returns:
{ void }

performanceMonitorStop() → {void}

stops the performance monitor, and clear the interval

Returns:
{ void }

setCursorImagePath(cursorImagePath)

Overrides default cursor with an cursor image. It is recommended to be a PNG with an alpha background.

Parameters:
Name Type Description
cursorImagePath String | undefined
Inherited From:

showCursor(point) → {void}

Indicates the cursor position on a screen as a red dot.
To be able to invoke this function, the user who shares his screen has to send information about cursor coordinates.

Parameters:
Name Type Description
point AvayaClientServices.Services.Collaboration.Point

Current position of the cursor.

Returns:
{ void }

start(containerId) → {void}

Starts screen sharing.
Function creates DOM element with the given ID where the screen sharing will be displayed in.

Parameters:
Name Type Description
containerId string

ID of DOM element where the content sharing will be append to.

Returns:
{ void }

startMonitorRemoteControlEvents(controller, controllee)

Starts monitoring remote control mouse, keyboard, and copy and paste events

Parameters:
Name Type Description
controller String
controllee String

stop() → {void}

Stops screen sharing.
Function removes the DOM element where the screen sharing was displayed in.

Returns:
{ void }

stopMonitorRemoteControlEvents()

Stops monitoring remote control mouse, keyboard, and copy and paste events

unpause() → {void}

Un-pauses the screen sharing and removes the pause layer from the canvas.

Returns:
{ void }

zoom(scale) → {void}

Scales sharing content and makes it smaller or bigger, depending on the scale parameter.

Parameters:
Name Type Description
scale number

Minimal value is 0. Default value is 1.
Value between 0 and 1 makes content smaller. Value higher than 1 makes content bigger.

Returns:
{ void }
©2016 Avaya Inc. All Rights Reserved.