Package video.api.client.api.models

Class Video

    • Constructor Detail

      • Video

        public Video()

    • Method Detail

      • getVideoId

        public String getVideoId()
        The unique identifier of the video object.
        Returns:
        videoId

      • setVideoId

        public void setVideoId​(String videoId)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        When a video was created, presented in ATOM UTC format.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getTitle

        @Nullable
public String getTitle()
        The title of the video content.
        Returns:
        title

      • setTitle

        public void setTitle​(String title)

      • description

        public Video description​(String description)

      • getDescription

        @Nullable
public String getDescription()
        A description for the video content.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getPublishedAt

        @Nullable
public OffsetDateTime getPublishedAt()
        The date and time the API created the video. Date and time are provided using ATOM UTC format.
        Returns:
        publishedAt

      • setPublishedAt

        public void setPublishedAt​(OffsetDateTime publishedAt)

      • getUpdatedAt

        @Nullable
public OffsetDateTime getUpdatedAt()
        The date and time the video was updated. Date and time are provided using ATOM UTC format.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getDiscardedAt

        @Nullable
public OffsetDateTime getDiscardedAt()
        The date and time the video was discarded. The API populates this field only if you have the Video Restore feature enabled and discard a video. Date and time are provided using ATOM UTC format.
        Returns:
        discardedAt

      • setDiscardedAt

        public void setDiscardedAt​(OffsetDateTime discardedAt)

      • getDeletesAt

        @Nullable
public OffsetDateTime getDeletesAt()
        The date and time the video will be permanently deleted. The API populates this field only if you have the Video Restore feature enabled and discard a video. Discarded videos are pemanently deleted after 90 days. Date and time are provided using ATOM UTC format.
        Returns:
        deletesAt

      • setDeletesAt

        public void setDeletesAt​(OffsetDateTime deletesAt)

      • getDiscarded

        @Nullable
public Boolean getDiscarded()
        Returns `true` for videos you discarded when you have the Video Restore feature enabled. Returns `false` for every other video.
        Returns:
        discarded

      • setDiscarded

        public void setDiscarded​(Boolean discarded)

      • language

        public Video language​(String language)

      • getLanguage

        @Nullable
public String getLanguage()
        Returns the language of a video in [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. You can set the language during video creation via the API, otherwise it is detected automatically.
        Returns:
        language

      • setLanguage

        public void setLanguage​(String language)

      • getLanguageOrigin

        @Nullable
public Video.LanguageOriginEnum getLanguageOrigin()
        Returns the origin of the last update on the video's `language` attribute. - `api` means that the last update was requested from the API. - `auto` means that the last update was done automatically by the API.
        Returns:
        languageOrigin

      • addTagsItem

        public Video addTagsItem​(String tagsItem)

      • getTags

        @Nullable
public List<String> getTags()
        One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces.
        Returns:
        tags

      • setTags

        public void setTags​(List<String> tags)

      • addMetadataItem

        public Video addMetadataItem​(Metadata metadataItem)

      • getMetadata

        @Nullable
public List<Metadata> getMetadata()
        Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(List<Metadata> metadata)

      • getSource

        @Nullable
public VideoSource getSource()
        Get source
        Returns:
        source

      • setSource

        public void setSource​(VideoSource source)

      • getAssets

        @Nullable
public VideoAssets getAssets()
        Get assets
        Returns:
        assets

      • setAssets

        public void setAssets​(VideoAssets assets)

      • playerId

        public Video playerId​(String playerId)

      • getPlayerId

        @Nullable
public String getPlayerId()
        The id of the player that will be applied on the video.
        Returns:
        playerId

      • setPlayerId

        public void setPlayerId​(String playerId)

      • getPublic

        @Nullable
public Boolean getPublic()
        Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/).
        Returns:
        _public

      • setPublic

        public void setPublic​(Boolean _public)

      • getPanoramic

        @Nullable
public Boolean getPanoramic()
        Defines if video is panoramic.
        Returns:
        panoramic

      • setPanoramic

        public void setPanoramic​(Boolean panoramic)

      • mp4Support

        public Video mp4Support​(Boolean mp4Support)

      • getMp4Support

        @Nullable
public Boolean getMp4Support()
        This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.
        Returns:
        mp4Support

      • setMp4Support

        public void setMp4Support​(Boolean mp4Support)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object