Back to Exoplayer

HslAdjustment.Builder (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/effect/HslAdjustment.Builder.html

latest4.1 KB
Original Source

Package com.google.android.exoplayer2.effect

Class HslAdjustment.Builder


public static final classHslAdjustment.Builderextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")

A builder for HslAdjustment instances.

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | Builder() | Creates a new instance with the default values. |

Method Summary

All Methods Instance Methods Concrete Methods | Modifier and Type | Method | Description | | --- | --- | --- | | HslAdjustment.Builder | adjustHue​(float hueAdjustmentDegrees) | Rotates the hue of the frame by hueAdjustmentDegrees. | | HslAdjustment.Builder | adjustLightness​(float lightnessAdjustment) | Adjusts the lightness of the frame by lightnessAdjustment. | | HslAdjustment.Builder | adjustSaturation​(float saturationAdjustment) | Adjusts the saturation of the frame by saturationAdjustment. | | HslAdjustment | build() | Creates a new HslAdjustment instance. |

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

- 

Builder

public Builder()

Creates a new instance with the default values.

Method Detail

- 

adjustHue

@CanIgnoreReturnValue
public[HslAdjustment.Builder](HslAdjustment.Builder.html "class in com.google.android.exoplayer2.effect")adjustHue​(float hueAdjustmentDegrees)

Rotates the hue of the frame by hueAdjustmentDegrees.

The Hue of the frame is defined in the interval of [0, 360] degrees. The actual degrees of hue adjustment applied is hueAdjustmentDegrees % 360.

Parameters:hueAdjustmentDegrees - The hue adjustment in rotation degrees. The default value is 0, which means no change is applied.

- 

adjustSaturation

@CanIgnoreReturnValue
public[HslAdjustment.Builder](HslAdjustment.Builder.html "class in com.google.android.exoplayer2.effect")adjustSaturation​(@FloatRange(from=-100.0,to=100.0)
                                              float saturationAdjustment)

Adjusts the saturation of the frame by saturationAdjustment.

Saturation is defined in the interval of [0, 100] where a saturation of 0 will generate a grayscale frame and a saturation of 100 has a maximum separation between the colors.

Parameters:saturationAdjustment - The difference of how much the saturation will be adjusted in either direction. Needs to be in the interval of [-100, 100] and the default value is 0, which means no change is applied.

- 

adjustLightness

@CanIgnoreReturnValue
public[HslAdjustment.Builder](HslAdjustment.Builder.html "class in com.google.android.exoplayer2.effect")adjustLightness​(@FloatRange(from=-100.0,to=100.0)
                                             float lightnessAdjustment)

Adjusts the lightness of the frame by lightnessAdjustment.

Lightness is defined in the interval of [0, 100] where a lightness of 0 is a black frame and a lightness of 100 is a white frame.

Parameters:lightnessAdjustment - The difference by how much the lightness will be adjusted in either direction. Needs to be in the interval of [-100, 100] and the default value is 0, which means no change is applied.

- 

build

public[HslAdjustment](HslAdjustment.html "class in com.google.android.exoplayer2.effect")build()

Creates a new HslAdjustment instance.