-
public interface ImageWireframeHelperA Helper to handle capturing images in Session replay wireframes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classImageWireframeHelper.Companion
-
Method Summary
Modifier and Type Method Description abstract MobileSegment.WireframecreateImageWireframeByPath(Long id, GlobalBounds globalBounds, Path path, Integer strokeColor, Integer strokeWidth, Integer targetWidth, Integer targetHeight, Float density, Boolean isContextualImage, ImagePrivacy imagePrivacy, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String customResourceIdCacheKey)Creates an image wireframe based on a given path. abstract MobileSegment.WireframecreateImageWireframeByBitmap(Long id, GlobalBounds globalBounds, Bitmap bitmap, Float density, Boolean isContextualImage, ImagePrivacy imagePrivacy, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border)Creates an image wireframe based on a given bitmap. abstract MobileSegment.WireframecreateImageWireframeByDrawable(View view, ImagePrivacy imagePrivacy, Integer currentWireframeIndex, Long x, Long y, Integer width, Integer height, Boolean usePIIPlaceholder, Drawable drawable, DrawableCopier drawableCopier, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String prefix, String customResourceIdCacheKey)Creates an image wireframe, and process the provided drawable in the background. abstract List<MobileSegment.Wireframe>createCompoundDrawableWireframes(TextView textView, MappingContext mappingContext, Integer prevWireframeIndex, String customResourceIdCacheKey, AsyncJobStatusCallback asyncJobStatusCallback)Creates the wireframes for the compound drawables in a TextView. -
-
Method Detail
-
createImageWireframeByPath
abstract MobileSegment.Wireframe createImageWireframeByPath(Long id, GlobalBounds globalBounds, Path path, Integer strokeColor, Integer strokeWidth, Integer targetWidth, Integer targetHeight, Float density, Boolean isContextualImage, ImagePrivacy imagePrivacy, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String customResourceIdCacheKey)
Creates an image wireframe based on a given path.
- Parameters:
id- the unique id for the wireframe.globalBounds- the global bounds of the bitmap.path- the path to use to create the wireframe.strokeColor- the color of the stroke.strokeWidth- the width of the stroke.targetWidth- the target width of the image.targetHeight- the target height of the image.density- the density of the screen.isContextualImage- if the image is contextual.imagePrivacy- defines which images should be hidden.asyncJobStatusCallback- the callback for the async capture process.clipping- the bounds of the image that are actually visible.shapeStyle- provides a custom shape (e.g.border- provides a custom border to the image wireframe.customResourceIdCacheKey- an optional custom key with which to cache or retrieve from the resource cache.
-
createImageWireframeByBitmap
abstract MobileSegment.Wireframe createImageWireframeByBitmap(Long id, GlobalBounds globalBounds, Bitmap bitmap, Float density, Boolean isContextualImage, ImagePrivacy imagePrivacy, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border)
Creates an image wireframe based on a given bitmap.
- Parameters:
id- the unique id for the wireframe.globalBounds- the global bounds of the bitmap.bitmap- the bitmap to capture.density- the density of the screen.isContextualImage- if the image is contextual.imagePrivacy- defines which images should be hidden.asyncJobStatusCallback- the callback for the async capture process.clipping- the bounds of the image that are actually visible.shapeStyle- provides a custom shape (e.g.border- provides a custom border to the image wireframe.
-
createImageWireframeByDrawable
abstract MobileSegment.Wireframe createImageWireframeByDrawable(View view, ImagePrivacy imagePrivacy, Integer currentWireframeIndex, Long x, Long y, Integer width, Integer height, Boolean usePIIPlaceholder, Drawable drawable, DrawableCopier drawableCopier, AsyncJobStatusCallback asyncJobStatusCallback, MobileSegment.WireframeClip clipping, MobileSegment.ShapeStyle shapeStyle, MobileSegment.ShapeBorder border, String prefix, String customResourceIdCacheKey)
Creates an image wireframe, and process the provided drawable in the background.
- Parameters:
view- the view owning the drawableimagePrivacy- defines which images should be hiddencurrentWireframeIndex- the index of the wireframe in the list of wireframes for the viewx- the x position of the imagey- the y position of the imagewidth- the width of the imageheight- the width of the imageusePIIPlaceholder- whether to replace the image content with a placeholder when we suspect it contains PIIdrawable- the drawable to capturedrawableCopier- the callback to copy the original drawable to a new one.asyncJobStatusCallback- the callback for the async capture processclipping- the bounds of the image that are actually visibleshapeStyle- provides a custom shape (e.g.border- provides a custom border to the image wireframeprefix- a prefix identifying the drawable in the parent view's contextcustomResourceIdCacheKey- an optional custom key with which to cache or retrieve from the resource cache.
-
createCompoundDrawableWireframes
@UiThread() abstract List<MobileSegment.Wireframe> createCompoundDrawableWireframes(TextView textView, MappingContext mappingContext, Integer prevWireframeIndex, String customResourceIdCacheKey, AsyncJobStatusCallback asyncJobStatusCallback)
Creates the wireframes for the compound drawables in a TextView.
- Parameters:
textView- the TextView to capture the compound drawables from.mappingContext- the MappingContext for the TextView.prevWireframeIndex- the index of the previous wireframe in the list of wireframes for the TextView.customResourceIdCacheKey- an optional custom key with which to cache or retrieve from the resource cache.asyncJobStatusCallback- the callback for the async capture process.
-
-
-
-