java.lang.Object
- video.api.client.api.models.VideoUpdatePayload

All Implemented Interfaces:

Serializable, DeepObject
```
public class VideoUpdatePayload
extends Object
implements Serializable, DeepObject
```
VideoUpdatePayload

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VideoUpdatePayload.LanguageEnum
Use this parameter to set the language of the video.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_LANGUAGE`
`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`
`static String`	`SERIALIZED_NAME_TRANSCRIPT`
`static String`	`SERIALIZED_NAME_TRANSCRIPT_SUMMARY`

Constructor Summary

Constructors
Constructor Description

VideoUpdatePayload()

Method Summary

All Methods Instance Methods Concrete Methods
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.
`VideoUpdatePayload.LanguageEnum`	`getLanguage()`	Use this parameter to set the language 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.
`Boolean`	`getTranscript()`	Use this parameter to enable transcription.
`Boolean`	`getTranscriptSummary()`	Use this parameter to enable summarization.
`int`	`hashCode()`
`VideoUpdatePayload`	`language(VideoUpdatePayload.LanguageEnum language)`
`VideoUpdatePayload`	`metadata(List<Metadata> metadata)`
`VideoUpdatePayload`	`mp4Support(Boolean mp4Support)`
`VideoUpdatePayload`	`panoramic(Boolean panoramic)`
`VideoUpdatePayload`	`playerId(String playerId)`
`void`	`setDescription(String description)`
`void`	`setLanguage(VideoUpdatePayload.LanguageEnum language)`
`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)`
`void`	`setTranscript(Boolean transcript)`
`void`	`setTranscriptSummary(Boolean transcriptSummary)`
`VideoUpdatePayload`	`tags(List<String> tags)`
`VideoUpdatePayload`	`title(String title)`
`String`	`toString()`
`VideoUpdatePayload`	`transcript(Boolean transcript)`
`VideoUpdatePayload`	`transcriptSummary(Boolean transcriptSummary)`
`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
  - SERIALIZED_NAME_LANGUAGE
```
public static final String SERIALIZED_NAME_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSCRIPT
```
public static final String SERIALIZED_NAME_TRANSCRIPT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSCRIPT_SUMMARY
```
public static final String SERIALIZED_NAME_TRANSCRIPT_SUMMARY
```
    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.
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(List<Metadata> metadata)
```
  - language
```
public VideoUpdatePayload language(VideoUpdatePayload.LanguageEnum language)
```
  - getLanguage
```
@Nullable
public VideoUpdatePayload.LanguageEnum getLanguage()
```
    Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language.
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(VideoUpdatePayload.LanguageEnum language)
```
  - transcript
```
public VideoUpdatePayload transcript(Boolean transcript)
```
  - getTranscript
```
@Nullable
public Boolean getTranscript()
```
    Use this parameter to enable transcription. - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video. - When the API generates a transcript, it will be available as a caption for the video.
    
    Returns:
    
    transcript
  - setTranscript
```
public void setTranscript(Boolean transcript)
```
  - transcriptSummary
```
public VideoUpdatePayload transcriptSummary(Boolean transcriptSummary)
```
  - getTranscriptSummary
```
@Nullable
public Boolean getTranscriptSummary()
```
    Use this parameter to enable summarization. - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video.
    
    Returns:
    
    transcriptSummary
  - setTranscriptSummary
```
public void setTranscriptSummary(Boolean transcriptSummary)
```
  - 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

Class VideoUpdatePayload

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_PLAYER_ID

SERIALIZED_NAME_TITLE

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_PUBLIC

SERIALIZED_NAME_PANORAMIC

SERIALIZED_NAME_MP4_SUPPORT

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_LANGUAGE

SERIALIZED_NAME_TRANSCRIPT

SERIALIZED_NAME_TRANSCRIPT_SUMMARY

Constructor Detail

VideoUpdatePayload

Method Detail

playerId

unsetPlayerId

getPlayerId

setPlayerId

title

getTitle

setTitle

description

getDescription

setDescription

_public

getPublic

setPublic

panoramic

getPanoramic

setPanoramic

mp4Support

getMp4Support

setMp4Support

tags

addTagsItem

getTags

setTags

metadata

addMetadataItem

getMetadata

setMetadata

language

getLanguage

setLanguage

transcript

getTranscript

setTranscript

transcriptSummary

getTranscriptSummary

setTranscriptSummary

equals

hashCode

toString