com.unblu.sdk.module.cobrowsing.screencapturer

Interface IScreenCapturer

public interface IScreenCapturer

Method Summary

Modifier and Type	Method and Description
void	addPrivateArea(PrivateArea privateArea) add private area instance for overlay
void	addPrivateViewId(int secretViewId) provide View Id View.getId() to add to secretview list (views that won't be shown in co-browsing sessions)
void	addUnbluUiToHide(android.view.View view)
void	continueCapturing() resume capturing screen for the cobrowsing session and update its run state
float	getHighestQualityRate()
float	getLowestQualityRate()
com.unblu.sdk.core.internal.utils.Size	getMaxCapturingResolution()
double	getMaxFpsRate()
int	getMaxPixelPerTileSide()
com.unblu.sdk.module.cobrowsing.internal.OverlayContainer	getOverlayContainer()
ERunState	getRunState()
float	getScaleFactor()
int	getSecureFieldBackgroundColor()
int	getSecureFieldBorderColor()
com.unblu.sdk.core.internal.model.DeviceTileStub[]	getTiles()
boolean	isDoCreateTiles()
void	pauseCapturing() pause capturing screen for the cobrowsing session and update its run state
void	removePrivateArea(PrivateArea privateArea) remove private area instance from overlaying
void	removePrivateViewId(int secretViewId) provide View Id View.getId() for the view that should be removed from the secretview list (views that won't be shown in co-browsing sessions)
void	setCobrowsingOverlayText(java.lang.String cobrowsingOverlayText) Configure the cobrowsing overlay text
void	setDoCreateTiles(boolean doCreateTiles)
void	setMaxCapturingResolution(com.unblu.sdk.core.internal.utils.Size size)
void	setMaxFpsRate(double maxFpsRate) Configure the maximum frames per second capture rate
void	setMaxPixelPerTileSide(int maxPixelPerTileSide)
void	setQualityRates(float minRate, float maxRate)
void	setSecureFieldColors(int backgroundColor, int borderColor) Configure custom colors for background and border for secure fields
void	startCapturing() Start capturing screen for the cobrowsing session and update its run state
void	stopCapturing() stop capturing screen for the cobrowsing session and update its run state

Method Detail

startCapturing

void startCapturing()

Start capturing screen for the cobrowsing session and update its run state

continueCapturing

void continueCapturing()

resume capturing screen for the cobrowsing session and update its run state

pauseCapturing

void pauseCapturing()

pause capturing screen for the cobrowsing session and update its run state

stopCapturing

void stopCapturing()

stop capturing screen for the cobrowsing session and update its run state

addPrivateViewId

void addPrivateViewId(int secretViewId)

provide View Id View.getId() to add to secretview list (views that won't be shown in co-browsing sessions)

removePrivateViewId

void removePrivateViewId(int secretViewId)

provide View Id View.getId() for the view that should be removed from the secretview list (views that won't be shown in co-browsing sessions)

Parameters:

secretViewId - the resource id for the specified view

addPrivateArea

void addPrivateArea(PrivateArea privateArea)

add private area instance for overlay

Parameters:

privateArea - the privateArea instance

removePrivateArea

void removePrivateArea(PrivateArea privateArea)

remove private area instance from overlaying

Parameters:

privateArea - the privateArea instance

addUnbluUiToHide

void addUnbluUiToHide(android.view.View view)

Parameters:

view - add UnbluUI Widget that is not to be displayed in co-browsing sessions

getScaleFactor

float getScaleFactor()

Returns:

scale factor for the generated images

getRunState

ERunState getRunState()

Returns:

the current run state of the co-browsing session

setMaxCapturingResolution

void setMaxCapturingResolution(com.unblu.sdk.core.internal.utils.Size size)

Parameters:

size - Object with the configured size for the max capturing resolution

setQualityRates

void setQualityRates(float minRate,
                     float maxRate)

Parameters:

minRate - minimum quality rate

maxRate - maximum quality rate

setDoCreateTiles

void setDoCreateTiles(boolean doCreateTiles)

Parameters:

doCreateTiles - toggles tile creation for the captured image

setMaxPixelPerTileSide

void setMaxPixelPerTileSide(int maxPixelPerTileSide)

Parameters:

maxPixelPerTileSide - max pixels per tile side

getMaxPixelPerTileSide

int getMaxPixelPerTileSide()

Returns:

maxPixelPerTileSide value

setMaxFpsRate

void setMaxFpsRate(double maxFpsRate)

Configure the maximum frames per second capture rate

Parameters:

maxFpsRate - the maximum fps capture rate

setSecureFieldColors

void setSecureFieldColors(int backgroundColor,
                          int borderColor)

Configure custom colors for background and border for secure fields

Parameters:

backgroundColor - the background color

borderColor - the maximum fps capture rate

getMaxFpsRate

double getMaxFpsRate()

Returns:

the maximum fps capture rate

getLowestQualityRate

float getLowestQualityRate()

Returns:

lowestQualityRate value

getHighestQualityRate

float getHighestQualityRate()

Returns:

highestQualityRate value

isDoCreateTiles

boolean isDoCreateTiles()

Returns:

isDoCreateTiles value

getMaxCapturingResolution

com.unblu.sdk.core.internal.utils.Size getMaxCapturingResolution()

Returns:

the maximum capture resolution

getSecureFieldBackgroundColor

int getSecureFieldBackgroundColor()

Returns:

current private FieldBackgroundColor

getSecureFieldBorderColor

int getSecureFieldBorderColor()

Returns:

the SecureFieldBorderColor

getOverlayContainer

com.unblu.sdk.module.cobrowsing.internal.OverlayContainer getOverlayContainer()

Returns:

the OverlayContainer

setCobrowsingOverlayText

void setCobrowsingOverlayText(java.lang.String cobrowsingOverlayText)

Configure the cobrowsing overlay text

Parameters:

cobrowsingOverlayText -

getTiles

com.unblu.sdk.core.internal.model.DeviceTileStub[] getTiles()

Returns:

the deviceTileStub