Package video.api.client.api.models

Class VideoCreationPayload

java.lang.Object

video.api.client.api.models.VideoCreationPayload

All Implemented Interfaces:

Serializable

public class VideoCreationPayload
extends Object
implements Serializable

VideoCreationPayload

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_CLIP
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_METADATA
static String	SERIALIZED_NAME_MP4_SUPPORT
static String	SERIALIZED_NAME_PANORAMIC
static String	SERIALIZED_NAME_PLAYER_ID
static String	SERIALIZED_NAME_PUBLIC
static String	SERIALIZED_NAME_SOURCE
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_TITLE
static String	SERIALIZED_NAME_WATERMARK

Constructor Summary

Constructors

Constructor	Description
VideoCreationPayload()

Method Summary

Modifier and Type	Method	Description
VideoCreationPayload	_public(Boolean _public)
VideoCreationPayload	addMetadataItem(Metadata metadataItem)
VideoCreationPayload	addTagsItem(String tagsItem)
VideoCreationPayload	clip(VideoClip clip)
VideoCreationPayload	description(String description)
boolean	equals(Object o)
VideoClip	getClip()	Get clip
String	getDescription()	A brief description of your video.
List<Metadata>	getMetadata()	A list of key value pairs that you use to provide metadata for your video.
Boolean	getMp4Support()	Enables mp4 version in addition to streamed version.
Boolean	getPanoramic()	Indicates if your video is a 360/immersive video.
String	getPlayerId()	The unique identification number for your video player.
Boolean	getPublic()	Default: True.
String	getSource()	You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` of one of the videos you already have on your api.video acccount, and this will generate a copy of your video.
List<String>	getTags()	A list of tags you want to use to describe your video.
String	getTitle()	The title of your new video.
VideoWatermark	getWatermark()	Get watermark
int	hashCode()
VideoCreationPayload	metadata(List<Metadata> metadata)
VideoCreationPayload	mp4Support(Boolean mp4Support)
VideoCreationPayload	panoramic(Boolean panoramic)
VideoCreationPayload	playerId(String playerId)
void	setClip(VideoClip clip)
void	setDescription(String description)
void	setMetadata(List<Metadata> metadata)
void	setMp4Support(Boolean mp4Support)
void	setPanoramic(Boolean panoramic)
void	setPlayerId(String playerId)
void	setPublic(Boolean _public)
void	setSource(String source)
void	setTags(List<String> tags)
void	setTitle(String title)
void	setWatermark(VideoWatermark watermark)
VideoCreationPayload	source(String source)
VideoCreationPayload	tags(List<String> tags)
VideoCreationPayload	title(String title)
String	toString()
VideoCreationPayload	watermark(VideoWatermark watermark)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_TITLE

public static final String SERIALIZED_NAME_TITLE

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

Constant Field Values

SERIALIZED_NAME_PUBLIC

public static final String SERIALIZED_NAME_PUBLIC

See Also:

Constant Field Values

SERIALIZED_NAME_PANORAMIC

public static final String SERIALIZED_NAME_PANORAMIC

See Also:

Constant Field Values

SERIALIZED_NAME_MP4_SUPPORT

public static final String SERIALIZED_NAME_MP4_SUPPORT

See Also:

Constant Field Values

SERIALIZED_NAME_PLAYER_ID

public static final String SERIALIZED_NAME_PLAYER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_CLIP

public static final String SERIALIZED_NAME_CLIP

See Also:

Constant Field Values

SERIALIZED_NAME_WATERMARK

public static final String SERIALIZED_NAME_WATERMARK

See Also:

Constant Field Values

Constructor Detail

VideoCreationPayload

public VideoCreationPayload()

Method Detail

title

public VideoCreationPayload title(String title)

getTitle

public String getTitle()

The title of your new video.

Returns:

title

setTitle

public void setTitle(String title)

description

public VideoCreationPayload description(String description)

getDescription

@Nullable
public String getDescription()

A brief description of your video.

Returns:

description

setDescription

public void setDescription(String description)

source

public VideoCreationPayload source(String source)

getSource

@Nullable
public String getSource()

You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` of one of the videos you already have on your api.video acccount, and this will generate a copy of your video. Creating a copy of a video can be especially useful if you want to keep your original video and trim or apply a watermark onto the copy you would create.

Returns:

source

setSource

public void setSource(String source)

_public

public VideoCreationPayload _public(Boolean _public)

getPublic

@Nullable
public Boolean getPublic()

Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos)

Returns:

_public

setPublic

public void setPublic(Boolean _public)

panoramic

public VideoCreationPayload panoramic(Boolean panoramic)

getPanoramic

@Nullable
public Boolean getPanoramic()

Indicates if your video is a 360/immersive video.

Returns:

panoramic

setPanoramic

public void setPanoramic(Boolean panoramic)

mp4Support

public VideoCreationPayload mp4Support(Boolean mp4Support)

getMp4Support

@Nullable
public Boolean getMp4Support()

Enables mp4 version in addition to streamed version.

Returns:

mp4Support

setMp4Support

public void setMp4Support(Boolean mp4Support)

playerId

public VideoCreationPayload playerId(String playerId)

getPlayerId

@Nullable
public String getPlayerId()

The unique identification number for your video player.

Returns:

playerId

setPlayerId

public void setPlayerId(String playerId)

tags

public VideoCreationPayload tags(List<String> tags)

addTagsItem

public VideoCreationPayload addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

A list of tags you want to use to describe your video.

Returns:

tags

setTags

public void setTags(List<String> tags)

metadata

public VideoCreationPayload metadata(List<Metadata> metadata)

addMetadataItem

public VideoCreationPayload addMetadataItem(Metadata metadataItem)

getMetadata

@Nullable
public List<Metadata> getMetadata()

A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata).

Returns:

metadata

setMetadata

public void setMetadata(List<Metadata> metadata)

clip

public VideoCreationPayload clip(VideoClip clip)

getClip

@Nullable
public VideoClip getClip()

Get clip

Returns:

clip

setClip

public void setClip(VideoClip clip)

watermark

public VideoCreationPayload watermark(VideoWatermark watermark)

getWatermark

@Nullable
public VideoWatermark getWatermark()

Get watermark

Returns:

watermark

setWatermark

public void setWatermark(VideoWatermark watermark)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object