Package video.api.client.api.models

Class VideoUpdatePayload

java.lang.Object

video.api.client.api.models.VideoUpdatePayload

All Implemented Interfaces:

Serializable

public class VideoUpdatePayload
extends Object
implements Serializable

VideoUpdatePayload

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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_TAGS
static String	SERIALIZED_NAME_TITLE

Constructor Summary

Constructors

Constructor	Description
VideoUpdatePayload()

Method Summary

Modifier and Type	Method	Description
VideoUpdatePayload	_public(Boolean _public)
VideoUpdatePayload	addMetadataItem(Metadata metadataItem)
VideoUpdatePayload	addTagsItem(String tagsItem)
VideoUpdatePayload	description(String description)
boolean	equals(Object o)
String	getDescription()	A brief description of the video.
List<Metadata>	getMetadata()	A list (array) of dictionaries where each dictionary contains a key value pair that describes the video.
Boolean	getMp4Support()	Whether the player supports the mp4 format.
Boolean	getPanoramic()	Whether the video is a 360 degree or immersive video.
String	getPlayerId()	The unique ID for the player you want to associate with your video.
Boolean	getPublic()	Whether the video is publicly available or not.
List<String>	getTags()	A list of terms or words you want to tag the video with.
String	getTitle()	The title you want to use for your video.
int	hashCode()
VideoUpdatePayload	metadata(List<Metadata> metadata)
VideoUpdatePayload	mp4Support(Boolean mp4Support)
VideoUpdatePayload	panoramic(Boolean panoramic)
VideoUpdatePayload	playerId(String playerId)
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	setTags(List<String> tags)
void	setTitle(String title)
VideoUpdatePayload	tags(List<String> tags)
VideoUpdatePayload	title(String title)
String	toString()
VideoUpdatePayload	unsetPlayerId()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_PLAYER_ID

public static final String SERIALIZED_NAME_PLAYER_ID

See Also:

Constant Field Values

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_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_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

Constructor Detail

VideoUpdatePayload

public VideoUpdatePayload()

Method Detail

playerId

public VideoUpdatePayload playerId(String playerId)

unsetPlayerId

public VideoUpdatePayload unsetPlayerId()

getPlayerId

@Nullable
public String getPlayerId()

The unique ID for the player you want to associate with your video.

Returns:

playerId

setPlayerId

public void setPlayerId(String playerId)

title

public VideoUpdatePayload title(String title)

getTitle

@Nullable
public String getTitle()

The title you want to use for your video.

Returns:

title

setTitle

public void setTitle(String title)

description

public VideoUpdatePayload description(String description)

getDescription

@Nullable
public String getDescription()

A brief description of the video.

Returns:

description

setDescription

public void setDescription(String description)

_public

public VideoUpdatePayload _public(Boolean _public)

getPublic

@Nullable
public Boolean getPublic()

Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos).

Returns:

_public

setPublic

public void setPublic(Boolean _public)

panoramic

public VideoUpdatePayload panoramic(Boolean panoramic)

getPanoramic

@Nullable
public Boolean getPanoramic()

Whether the video is a 360 degree or immersive video.

Returns:

panoramic

setPanoramic

public void setPanoramic(Boolean panoramic)

mp4Support

public VideoUpdatePayload mp4Support(Boolean mp4Support)

getMp4Support

@Nullable
public Boolean getMp4Support()

Whether the player supports the mp4 format.

Returns:

mp4Support

setMp4Support

public void setMp4Support(Boolean mp4Support)

tags

public VideoUpdatePayload tags(List<String> tags)

addTagsItem

public VideoUpdatePayload addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

A list of terms or words you want to tag the video with. Make sure the list includes all the tags you want as whatever you send in this list will overwrite the existing list for the video.

Returns:

tags

setTags

public void setTags(List<String> tags)

metadata

public VideoUpdatePayload metadata(List<Metadata> metadata)

addMetadataItem

public VideoUpdatePayload addMetadataItem(Metadata metadataItem)

getMetadata

@Nullable
public List<Metadata> getMetadata()

A list (array) of dictionaries where each dictionary contains a key value pair that describes the video. As with tags, you must send the complete list of metadata you want as whatever you send here will overwrite the existing metadata for the video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair.

Returns:

metadata

setMetadata

public void setMetadata(List<Metadata> metadata)

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