Class VideoPublishingOptions


  • public final class VideoPublishingOptions
    extends Object
    Optional flags used to change how video is published. These are only allowed for topologies where "kind" is set to "live".
    • Constructor Detail

      • VideoPublishingOptions

        public VideoPublishingOptions()
    • Method Detail

      • disableArchive

        public String disableArchive()
        Get the disableArchive property: When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only for low latency video streaming. Default is 'false'. If set to 'true', then "disableRtspPublishing" must be set to 'false'.
        Returns:
        the disableArchive value.
      • withDisableArchive

        public VideoPublishingOptions withDisableArchive​(String disableArchive)
        Set the disableArchive property: When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only for low latency video streaming. Default is 'false'. If set to 'true', then "disableRtspPublishing" must be set to 'false'.
        Parameters:
        disableArchive - the disableArchive value to set.
        Returns:
        the VideoPublishingOptions object itself.
      • disableRtspPublishing

        public String disableRtspPublishing()
        Get the disableRtspPublishing property: When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example, when the topology is used only for archiving content. Default is 'false'. If set to 'true', then "disableArchive" must be set to 'false'.
        Returns:
        the disableRtspPublishing value.
      • withDisableRtspPublishing

        public VideoPublishingOptions withDisableRtspPublishing​(String disableRtspPublishing)
        Set the disableRtspPublishing property: When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example, when the topology is used only for archiving content. Default is 'false'. If set to 'true', then "disableArchive" must be set to 'false'.
        Parameters:
        disableRtspPublishing - the disableRtspPublishing value to set.
        Returns:
        the VideoPublishingOptions object itself.
      • validate

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