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

All Implemented Interfaces:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_CLIP`
`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_SOURCE`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_TITLE`
`static String`	`SERIALIZED_NAME_TRANSCRIPT`
`static String`	`SERIALIZED_NAME_TRANSCRIPT_SUMMARY`
`static String`	`SERIALIZED_NAME_WATERMARK`

Constructor Summary

Constructors
Constructor Description

VideoCreationPayload()

Method Summary

All Methods Instance Methods Concrete Methods
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.
`VideoCreationPayload.LanguageEnum`	`getLanguage()`	Use this parameter to set the language of the 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.
`Boolean`	`getTranscript()`	Use this parameter to enable transcription.
`Boolean`	`getTranscriptSummary()`	Use this parameter to enable summarization.
`VideoWatermark`	`getWatermark()`	Get watermark
`int`	`hashCode()`
`VideoCreationPayload`	`language(VideoCreationPayload.LanguageEnum language)`
`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`	`setLanguage(VideoCreationPayload.LanguageEnum language)`
`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`	`setTranscript(Boolean transcript)`
`void`	`setTranscriptSummary(Boolean transcriptSummary)`
`void`	`setWatermark(VideoWatermark watermark)`
`VideoCreationPayload`	`source(String source)`
`VideoCreationPayload`	`tags(List<String> tags)`
`VideoCreationPayload`	`title(String title)`
`String`	`toString()`
`VideoCreationPayload`	`transcript(Boolean transcript)`
`VideoCreationPayload`	`transcriptSummary(Boolean transcriptSummary)`
`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
  - 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
  - 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/delivery/video-privacy-access-management)
    
    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.
    
    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)
```
  - language
```
public VideoCreationPayload language(VideoCreationPayload.LanguageEnum language)
```
  - getLanguage
```
@Nullable
public VideoCreationPayload.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(VideoCreationPayload.LanguageEnum language)
```
  - transcript
```
public VideoCreationPayload 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 VideoCreationPayload transcriptSummary(Boolean transcriptSummary)
```
  - getTranscriptSummary
```
@Nullable
public Boolean getTranscriptSummary()
```
    Use this parameter to enable summarization. We recommend using this parameter together with `transcript: true`. - 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 VideoCreationPayload

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TITLE

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_SOURCE

SERIALIZED_NAME_PUBLIC

SERIALIZED_NAME_PANORAMIC

SERIALIZED_NAME_MP4_SUPPORT

SERIALIZED_NAME_PLAYER_ID

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_CLIP

SERIALIZED_NAME_WATERMARK

SERIALIZED_NAME_LANGUAGE

SERIALIZED_NAME_TRANSCRIPT

SERIALIZED_NAME_TRANSCRIPT_SUMMARY

Constructor Detail

VideoCreationPayload

Method Detail

title

getTitle

setTitle

description

getDescription

setDescription

source

getSource

setSource

_public

getPublic

setPublic

panoramic

getPanoramic

setPanoramic

mp4Support

getMp4Support

setMp4Support

playerId

getPlayerId

setPlayerId

tags

addTagsItem

getTags

setTags

metadata

addMetadataItem

getMetadata

setMetadata

clip

getClip

setClip

watermark

getWatermark

setWatermark

language

getLanguage

setLanguage

transcript

getTranscript

setTranscript

transcriptSummary

getTranscriptSummary

setTranscriptSummary

equals

hashCode

toString