Class MessageEmbed.VideoInfo

java.lang.Object

net.dv8tion.jda.api.entities.MessageEmbed.VideoInfo

Enclosing class:

MessageEmbed

public static class MessageEmbed.VideoInfo
extends Object

Represents the information provided to embed a video.
The videos represented are expected to be played using an HTML5 player from the site which the url belongs to.

Constructor Summary

Constructors

Constructor	Description
VideoInfo(String url, String proxyUrl, int width, int height, String description, String contentType, ThumbHashPlaceholder placeholder, int flags)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getContentType()	The media type, if available, or null.
String	getDescription()	The description of the video (alt text), or null if none is set.
@Unmodifiable Set<MessageEmbed.MessageEmbedMediaFlag>	getFlags()	Returns an unmodifiable set of all MessageEmbedMediaFlags present for this video.
long	getFlagsRaw()	Returns the raw media embed flags of this video.
int	getHeight()	The height of the video.
ThumbHashPlaceholder	getPlaceholder()	The placeholder of the video, or null.
FileProxy	getProxy()	Returns a FileProxy for this embed video.
String	getProxyUrl()	The url of the video, proxied by Discord This url is used to access the video through Discord instead of directly to prevent ip scraping.
String	getUrl()	The url of the video.
int	getWidth()	The width of the video.
int	hashCode()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VideoInfo

public VideoInfo(String url,
 String proxyUrl,
 int width,
 int height,
 String description,
 String contentType,
 ThumbHashPlaceholder placeholder,
 int flags)

Method Details

getUrl

@Nullable
public String getUrl()

The url of the video.

Returns:

Possibly-null String containing the video url.

getProxyUrl

@Nullable
public String getProxyUrl()

The url of the video, proxied by Discord
This url is used to access the video through Discord instead of directly to prevent ip scraping.

Returns:

Possibly-null String containing the proxied video url.

getProxy

@Nullable
public FileProxy getProxy()

Returns a FileProxy for this embed video.

Returns:

Possibly-null FileProxy of this embed video

See Also:

• getProxyUrl()

getWidth

public int getWidth()

The width of the video.
This usually isn't the actual video width, but instead the starting embed window size.

Basically: Don't rely on this to represent the actual video's quality or size.

Returns:

Non-negative, Non-zero int containing the width of the embedded video.

getHeight

public int getHeight()

The height of the video.
This usually isn't the actual video height, but instead the starting embed window size.

Basically: Don't rely on this to represent the actual video's quality or size.

Returns:

Non-negative, Non-zero int containing the height of the embedded video.

getDescription

@Nullable
public String getDescription()

The description of the video (alt text), or null if none is set.

Returns:

Description of the video, or null

getContentType

@Nullable
public String getContentType()

The media type, if available, or null.

This may be absent if the media failed to load.

Returns:

The media type, or null

getPlaceholder

@Nullable
public ThumbHashPlaceholder getPlaceholder()

The placeholder of the video, or null.

Returns:

The placeholder or null

See Also:

• ThumbHashPlaceholder

getFlagsRaw

public long getFlagsRaw()

Returns the raw media embed flags of this video.

Returns:

The raw media flags

See Also:

• getFlags()

getFlags

@Nonnull
public @Unmodifiable Set<MessageEmbed.MessageEmbedMediaFlag> getFlags()

Returns an unmodifiable set of all MessageEmbedMediaFlags present for this video.

Returns:

Unmodifiable set of present MessageEmbedMediaFlags

See Also:

• MessageEmbed.MessageEmbedMediaFlag

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object