HslAdjustment


@UnstableApi
class HslAdjustment : GlEffect


Adjusts the HSL (Hue, Saturation, and Lightness) of a frame.

Summary

Nested types

A builder for HslAdjustment instances.

Public functions

Boolean
isNoOp(inputWidth: Int, inputHeight: Int)

Returns whether a GlEffect applies no change at every timestamp.

BaseGlShaderProgram!
toGlShaderProgram(context: Context!, useHdr: Boolean)

Returns a GlShaderProgram that applies the effect.

Public properties

Float

Indicates the hue adjustment in degrees.

Float

Indicates the lightness adjustment.

Float

Indicates the saturation adjustment.

Inherited functions

From androidx.media3.common.Effect
Long

Returns the expected duration of the output stream when the effect is applied given a input durationUs.

Public functions

isNoOp

fun isNoOp(inputWidth: Int, inputHeight: Int): Boolean

Returns whether a GlEffect applies no change at every timestamp.

This can be used as a hint to skip this instance.

Parameters
inputWidth: Int

The input frame width, in pixels.

inputHeight: Int

The input frame height, in pixels.

toGlShaderProgram

fun toGlShaderProgram(context: Context!, useHdr: Boolean): BaseGlShaderProgram!

Returns a GlShaderProgram that applies the effect.

Parameters
context: Context!

A Context.

useHdr: Boolean

Whether input textures come from an HDR source. If true, colors will be in linear RGB BT.2020. If false, colors will be in linear RGB BT.709.

Throws
androidx.media3.common.VideoFrameProcessingException

If an error occurs while creating the .

Public properties

hueAdjustmentDegrees

val hueAdjustmentDegreesFloat

Indicates the hue adjustment in degrees.

lightnessAdjustment

val lightnessAdjustmentFloat

Indicates the lightness adjustment.

saturationAdjustment

val saturationAdjustmentFloat

Indicates the saturation adjustment.