All Implemented Interfaces:
```
public final class Overlay

                    
```
Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See Overlay using layers.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`Overlay.Visitor`	An interface that defines how to map each variant of Overlay to a value of type T.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<TextOverlay>`	`text()`
`final Optional<ImageOverlay>`	`image()`
`final Optional<VideoOverlay>`	`video()`
`final Optional<SubtitleOverlay>`	`subtitle()`
`final Optional<SolidColorOverlay>`	`solidColor()`
`final Boolean`	`isText()`
`final Boolean`	`isImage()`
`final Boolean`	`isVideo()`
`final Boolean`	`isSubtitle()`
`final Boolean`	`isSolidColor()`
`final TextOverlay`	`asText()`
`final ImageOverlay`	`asImage()`
`final VideoOverlay`	`asVideo()`
`final SubtitleOverlay`	`asSubtitle()`
`final SolidColorOverlay`	`asSolidColor()`
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(Overlay.Visitor<T> visitor)`
`final Overlay`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Overlay`	`ofText(TextOverlay text)`
`final static Overlay`	`ofImage(ImageOverlay image)`
`final static Overlay`	`ofVideo(VideoOverlay video)`
`final static Overlay`	`ofSubtitle(SubtitleOverlay subtitle)`
`final static Overlay`	`ofSolidColor(SolidColorOverlay solidColor)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

text
```
 final Optional<TextOverlay> text()
```

image
```
 final Optional<ImageOverlay> image()
```

video
```
 final Optional<VideoOverlay> video()
```

subtitle

 final Optional<SubtitleOverlay> subtitle()

solidColor

 final Optional<SolidColorOverlay> solidColor()

isText
```
 final Boolean isText()
```

isImage
```
 final Boolean isImage()
```

isVideo
```
 final Boolean isVideo()
```

isSubtitle
```
 final Boolean isSubtitle()
```

isSolidColor
```
 final Boolean isSolidColor()
```

asText
```
 final TextOverlay asText()
```

asImage
```
 final ImageOverlay asImage()
```

asVideo
```
 final VideoOverlay asVideo()
```

asSubtitle
```
 final SubtitleOverlay asSubtitle()
```

asSolidColor
```
 final SolidColorOverlay asSolidColor()
```

_json
```
 final Optional<JsonValue> _json()
```

accept

 final <T extends Any> T accept(Overlay.Visitor<T> visitor)

validate
```
 final Overlay validate()
```

isValid
```
 final Boolean isValid()
```

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

ofText

 final static Overlay ofText(TextOverlay text)

ofImage

 final static Overlay ofImage(ImageOverlay image)

ofVideo

 final static Overlay ofVideo(VideoOverlay video)

ofSubtitle

 final static Overlay ofSubtitle(SubtitleOverlay subtitle)

ofSolidColor

 final static Overlay ofSolidColor(SolidColorOverlay solidColor)

Class Overlay

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

text

image

video

subtitle

solidColor

isText

isImage

isVideo

isSubtitle

isSolidColor

asText

asImage

asVideo

asSubtitle

asSolidColor

_json

accept

validate

isValid

equals

hashCode

toString

ofText

ofImage

ofVideo

ofSubtitle

ofSolidColor