it.auties.whatsapp.model.message.standard.VideoMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of whatsappweb4j Show documentation
Show all versions of whatsappweb4j Show documentation
Standalone fully-featured Whatsapp Web API for Java and Kotlin
package it.auties.whatsapp.model.message.standard;
import com.fasterxml.jackson.annotation.JsonCreator;
import it.auties.protobuf.base.ProtobufMessage;
import it.auties.protobuf.base.ProtobufName;
import it.auties.protobuf.base.ProtobufProperty;
import it.auties.whatsapp.api.Whatsapp;
import it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplateTitle;
import it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplateTitleType;
import it.auties.whatsapp.model.button.template.hydrated.HydratedFourRowTemplateTitle;
import it.auties.whatsapp.model.button.template.hydrated.HydratedFourRowTemplateTitleType;
import it.auties.whatsapp.model.info.ContextInfo;
import it.auties.whatsapp.model.info.MessageInfo;
import it.auties.whatsapp.model.interactive.InteractiveHeaderAttachment;
import it.auties.whatsapp.model.location.InteractiveLocationAnnotation;
import it.auties.whatsapp.model.message.button.ButtonsMessageHeader;
import it.auties.whatsapp.model.message.model.MediaMessage;
import it.auties.whatsapp.model.message.model.MediaMessageType;
import it.auties.whatsapp.util.Clock;
import it.auties.whatsapp.util.Medias;
import it.auties.whatsapp.util.Validate;
import lombok.*;
import lombok.experimental.Accessors;
import lombok.experimental.SuperBuilder;
import lombok.extern.jackson.Jacksonized;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import static it.auties.protobuf.base.ProtobufType.*;
import static it.auties.whatsapp.model.message.model.MediaMessageType.VIDEO;
import static java.util.Objects.requireNonNullElse;
/**
* A model class that represents a message holding a video inside
*/
@AllArgsConstructor
@NoArgsConstructor
@Data
@EqualsAndHashCode(callSuper = true)
@SuperBuilder
@Jacksonized
@Accessors(fluent = true)
public final class VideoMessage extends MediaMessage implements InteractiveHeaderAttachment, ButtonsMessageHeader, HighlyStructuredFourRowTemplateTitle, HydratedFourRowTemplateTitle {
/**
* The upload url of the encoded video that this object wraps
*/
@ProtobufProperty(index = 1, type = STRING)
private String mediaUrl;
/**
* The mime type of the video that this object wraps. Most of the seconds this is
* {@link MediaMessageType#defaultMimeType()}
*/
@ProtobufProperty(index = 2, type = STRING)
private String mimetype;
/**
* The sha256 of the decoded video that this object wraps
*/
@ProtobufProperty(index = 3, type = BYTES)
private byte[] mediaSha256;
/**
* The unsigned size of the decoded video that this object wraps
*/
@ProtobufProperty(index = 4, type = UINT64)
private long mediaSize;
/**
* The codeLength in seconds of the video that this message wraps
*/
@ProtobufProperty(index = 5, type = UINT32)
private Integer duration;
/**
* The media key of the video that this object wraps.
*/
@ProtobufProperty(index = 6, type = BYTES)
private byte[] mediaKey;
/**
* The caption, that is the text below the video, of this video message
*/
@ProtobufProperty(index = 7, type = STRING)
private String caption;
/**
* Determines whether this object wraps a video that must be played as a gif
*/
@ProtobufProperty(index = 8, type = BOOL)
private boolean gifPlayback;
/**
* The unsigned height of the decoded video that this object wraps
*/
@ProtobufProperty(index = 9, type = UINT32)
private Integer height;
/**
* The unsigned width of the decoded video that this object wraps
*/
@ProtobufProperty(index = 10, type = UINT32)
private Integer width;
/**
* The sha256 of the encoded video that this object wraps
*/
@ProtobufProperty(index = 11, type = BYTES)
private byte[] mediaEncryptedSha256;
/**
* Interactive annotations
*/
@ProtobufProperty(index = 12, type = MESSAGE, implementation = InteractiveLocationAnnotation.class, repeated = true)
private List interactiveAnnotations;
/**
* The direct path to the encoded image that this object wraps
*/
@ProtobufProperty(index = 13, type = STRING)
private String mediaDirectPath;
/**
* The timestamp, that is the seconds elapsed since {@link java.time.Instant#EPOCH}, for
* {@link VideoMessage#mediaKey()}
*/
@ProtobufProperty(index = 14, type = INT64)
private long mediaKeyTimestamp;
/**
* The thumbnail for this video message encoded as jpeg in an array of bytes
*/
@ProtobufProperty(index = 16, type = BYTES)
private byte[] thumbnail;
/**
* The sidecar for the decoded video that this message wraps
*/
@ProtobufProperty(index = 18, type = BYTES)
private byte[] streamingSidecar;
/**
* The source from where the gif that this message wraps comes from. This property is defined only
* if {@link VideoMessage#gifPlayback}.
*/
@ProtobufProperty(index = 19, type = MESSAGE, implementation = VideoMessageAttribution.class)
private VideoMessageAttribution gifAttribution;
@ProtobufProperty(index = 20, name = "viewOnce", type = BOOL)
private boolean viewOnce;
/**
* The direct path to the encrypted thumbnail
*/
@ProtobufProperty(index = 21, name = "thumbnailDirectPath", type = STRING)
private String thumbnailDirectPath;
@ProtobufProperty(index = 22, name = "thumbnailSha256", type = BYTES)
private byte[] thumbnailSha256;
@ProtobufProperty(index = 23, name = "thumbnailEncSha256", type = BYTES)
private byte[] thumbnailEncSha256;
@ProtobufProperty(index = 24, name = "staticUrl", type = STRING)
private String staticUrl;
/**
* Constructs a new builder to create a VideoMessage that wraps a video
* The result can be later sent using {@link Whatsapp#sendMessage(MessageInfo)}
* {@link VideoMessage#thumbnail} is computed automatically if ffmpeg is installed on the host machine
* {@link VideoMessage#duration} is computed automatically if ffprobe is installed on the host machine
*
* @param media the non-null video that the new message wraps
* @param mimeType the mime type of the new message, by default
* {@link MediaMessageType#defaultMimeType()}
* @param caption the caption of the new message
* @param thumbnail the thumbnail of the sticker that the new message wraps as a jpg
* @param contextInfo the context info that the new message wraps
* @return a non-null new message
*/
@Builder(builderClassName = "SimpleVideoMessageBuilder", builderMethodName = "simpleVideoBuilder")
private static VideoMessage videoBuilder(byte[] media, String mimeType, String caption, byte[] thumbnail, ContextInfo contextInfo) {
var dimensions = Medias.getDimensions(media, true);
var duration = Medias.getDuration(media);
return VideoMessage.builder()
.decodedMedia(media)
.mediaKeyTimestamp(Clock.nowSeconds())
.mimetype(requireNonNullElse(mimeType, VIDEO.defaultMimeType()))
.thumbnail(thumbnail != null ? thumbnail : Medias.getThumbnail(media, Medias.Format.VIDEO).orElse(null))
.caption(caption)
.width(dimensions.width())
.height(dimensions.height())
.duration(duration)
.contextInfo(Objects.requireNonNullElseGet(contextInfo, ContextInfo::new))
.build();
}
/**
* Constructs a new builder to create a VideoMessage that wraps a video that will be played as a gif
* Wrapping a gif file instead of a video will result in an exception if detected or in an unplayable message
* This is because Whatsapp doesn't support standard gifs
* The result can be later sent using {@link Whatsapp#sendMessage(MessageInfo)}
* {@link VideoMessage#thumbnail} is computed automatically if ffmpeg is installed on the host machine
* {@link VideoMessage#duration} is computed automatically if ffprobe is installed on the host machine
*
* @param media the non-null video that the new message wraps
* @param mimeType the mime type of the new message, by default
* {@link MediaMessageType#defaultMimeType()}
* @param caption the caption of the new message
* @param gifAttribution the codeLength in seconds of the video that the new message wraps
* @param thumbnail the thumbnail of the sticker that the new message wraps as a jpg
* @param contextInfo the context info that the new message wraps
* @return a non-null new message
*/
@Builder(builderClassName = "SimpleGifBuilder", builderMethodName = "simpleGifBuilder")
private static VideoMessage gifBuilder(byte[] media, String mimeType, String caption, VideoMessageAttribution gifAttribution, byte[] thumbnail, ContextInfo contextInfo) {
Validate.isTrue(isNotGif(media, mimeType), "Cannot create a VideoMessage with mime type image/gif: gif messages on whatsapp are videos played as gifs");
var dimensions = Medias.getDimensions(media, true);
var duration = Medias.getDuration(media);
return VideoMessage.builder()
.decodedMedia(media)
.mediaKeyTimestamp(Clock.nowSeconds())
.mimetype(requireNonNullElse(mimeType, VIDEO.defaultMimeType()))
.thumbnail(thumbnail != null ? thumbnail : Medias.getThumbnail(media, Medias.Format.VIDEO).orElse(null))
.caption(caption)
.width(dimensions.width())
.height(dimensions.height())
.duration(duration)
.gifPlayback(true)
.gifAttribution(requireNonNullElse(gifAttribution, VideoMessageAttribution.NONE))
.contextInfo(Objects.requireNonNullElseGet(contextInfo, ContextInfo::new))
.build();
}
private static boolean isNotGif(byte[] media, String mimeType) {
return Medias.getMimeType(media)
.filter("image/gif"::equals)
.isEmpty() && (!Objects.equals(mimeType, "image/gif"));
}
/**
* Returns the media type of the video that this object wraps
*
* @return {@link MediaMessageType#VIDEO}
*/
@Override
public MediaMessageType mediaType() {
return MediaMessageType.VIDEO;
}
@Override
public HighlyStructuredFourRowTemplateTitleType titleType() {
return HighlyStructuredFourRowTemplateTitleType.VIDEO;
}
@Override
public HydratedFourRowTemplateTitleType hydratedTitleType() {
return HydratedFourRowTemplateTitleType.VIDEO;
}
/**
* The constants of this enumerated type describe the various sources from where a gif can come
* from
*/
@AllArgsConstructor
@Accessors(fluent = true)
@ProtobufName("Attribution")
public enum VideoMessageAttribution implements ProtobufMessage {
/**
* No source was specified
*/
NONE(0),
/**
* Giphy
*/
GIPHY(1),
/**
* Tenor
*/
TENOR(2);
@Getter
private final int index;
@JsonCreator
public static VideoMessageAttribution of(int index) {
return Arrays.stream(values()).filter(entry -> entry.index() == index).findFirst().orElse(null);
}
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy