stream-chat-android-ui-common/io.getstream.chat.android.ui.common.images.resizing

Package-level declarations

Types

Strategy for resizing Stream CDN hosted image URLs before they are loaded, to avoid downloading full-resolution originals. It is applied to image attachment URLs by the Compose and XML UI kits and configured via ChatTheme(streamCdnImageResizer = …) / ChatUI.streamCdnImageResizer.

StreamCdnImageResizing

data class ~~StreamCdnImageResizing~~(val imageResizingEnabled: Boolean, @FloatRange(from = 0.0, to = 1.0, fromInclusive = false) val resizedWidthPercentage: Float, @FloatRange(from = 0.0, to = 1.0, fromInclusive = false) val resizedHeightPercentage: Float, val resizeMode: StreamCdnResizeImageMode?, val cropMode: StreamCdnCropImageMode?)

Used to adjust the request to resize images hosted on Stream's CDN.

StreamCdnMaxPixelsImageResizer

class StreamCdnMaxPixelsImageResizer(maxImagePixels: Long = StreamCdnImageResizer.DEFAULT_MAX_IMAGE_PIXELS, resizeMode: StreamCdnResizeImageMode? = null, cropMode: StreamCdnCropImageMode? = null, cdnHost: String? = null) : StreamCdnImageResizer

Caps images to maxImagePixels total pixels (default 2MP), preserving aspect ratio and never upscaling.

Properties

NoOpStreamCdnImageResizer

val NoOpStreamCdnImageResizer: StreamCdnImageResizer

Disables resizing — full-resolution originals. Explicit opt-out.

Functions

applyStreamCdnImageResizing

fun String.applyStreamCdnImageResizing(streamCdnImageResizing: StreamCdnImageResizing, streamCdnImageResizer: StreamCdnImageResizer): String

Applies image resizing following the resolver precedence: if the legacy streamCdnImageResizing is explicitly enabled its exact percentage behavior is honored, otherwise the active streamCdnImageResizer is applied (defaulting to a 2MP cap). Disabling resizing is done by setting the resizer to NoOpStreamCdnImageResizer.

applyStreamCdnImageResizingIfEnabled

fun String.applyStreamCdnImageResizingIfEnabled(streamCdnImageResizing: StreamCdnImageResizing): String

A convenience method which applies Stream CDN image resizing if it's enabled and applicable. It doesn't hold any special value other than minimizing repetition.