Class VideoCreationProperties


  • public final class VideoCreationProperties
    extends Object
    Optional properties to be used in case a new video resource needs to be created on the service. These will not take effect if the video already exists.
    • Constructor Detail

      • VideoCreationProperties

        public VideoCreationProperties()
    • Method Detail

      • title

        public String title()
        Get the title property: Optional title provided by the user. Value can be up to 256 characters long.
        Returns:
        the title value.
      • withTitle

        public VideoCreationProperties withTitle​(String title)
        Set the title property: Optional title provided by the user. Value can be up to 256 characters long.
        Parameters:
        title - the title value to set.
        Returns:
        the VideoCreationProperties object itself.
      • description

        public String description()
        Get the description property: Optional description provided by the user. Value can be up to 2048 characters long.
        Returns:
        the description value.
      • withDescription

        public VideoCreationProperties withDescription​(String description)
        Set the description property: Optional description provided by the user. Value can be up to 2048 characters long.
        Parameters:
        description - the description value to set.
        Returns:
        the VideoCreationProperties object itself.
      • segmentLength

        public String segmentLength()
        Get the segmentLength property: Segment length indicates the length of individual content files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the initial call to create the video resource can lead to errors when uploading content to the archive. Default value is 30 seconds. This property is only allowed for topologies where "kind" is set to "live".
        Returns:
        the segmentLength value.
      • withSegmentLength

        public VideoCreationProperties withSegmentLength​(String segmentLength)
        Set the segmentLength property: Segment length indicates the length of individual content files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the initial call to create the video resource can lead to errors when uploading content to the archive. Default value is 30 seconds. This property is only allowed for topologies where "kind" is set to "live".
        Parameters:
        segmentLength - the segmentLength value to set.
        Returns:
        the VideoCreationProperties object itself.
      • retentionPeriod

        public String retentionPeriod()
        Get the retentionPeriod property: Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format (i.e. "P1D" equals 1 day) and can vary between 1 day to 10 years, in 1 day increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies where "kind" is set to "live".
        Returns:
        the retentionPeriod value.
      • withRetentionPeriod

        public VideoCreationProperties withRetentionPeriod​(String retentionPeriod)
        Set the retentionPeriod property: Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format (i.e. "P1D" equals 1 day) and can vary between 1 day to 10 years, in 1 day increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies where "kind" is set to "live".
        Parameters:
        retentionPeriod - the retentionPeriod value to set.
        Returns:
        the VideoCreationProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.