Class EncoderSettings

    • Method Detail

      • hasAudioDescriptions

        public final boolean hasAudioDescriptions()
        For responses, this returns true if the service returned a value for the AudioDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • audioDescriptions

        public final List<AudioDescription> audioDescriptions()
        Returns the value of the AudioDescriptions property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudioDescriptions() method.

        Returns:
        The value of the AudioDescriptions property for this object.
      • availBlanking

        public final AvailBlanking availBlanking()
        Settings for ad avail blanking.
        Returns:
        Settings for ad avail blanking.
      • availConfiguration

        public final AvailConfiguration availConfiguration()
        Event-wide configuration settings for ad avail insertion.
        Returns:
        Event-wide configuration settings for ad avail insertion.
      • blackoutSlate

        public final BlackoutSlate blackoutSlate()
        Settings for blackout slate.
        Returns:
        Settings for blackout slate.
      • hasCaptionDescriptions

        public final boolean hasCaptionDescriptions()
        For responses, this returns true if the service returned a value for the CaptionDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • captionDescriptions

        public final List<CaptionDescription> captionDescriptions()
        Settings for caption decriptions

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaptionDescriptions() method.

        Returns:
        Settings for caption decriptions
      • featureActivations

        public final FeatureActivations featureActivations()
        Feature Activations
        Returns:
        Feature Activations
      • globalConfiguration

        public final GlobalConfiguration globalConfiguration()
        Configuration settings that apply to the event as a whole.
        Returns:
        Configuration settings that apply to the event as a whole.
      • motionGraphicsConfiguration

        public final MotionGraphicsConfiguration motionGraphicsConfiguration()
        Settings for motion graphics.
        Returns:
        Settings for motion graphics.
      • nielsenConfiguration

        public final NielsenConfiguration nielsenConfiguration()
        Nielsen configuration settings.
        Returns:
        Nielsen configuration settings.
      • hasOutputGroups

        public final boolean hasOutputGroups()
        For responses, this returns true if the service returned a value for the OutputGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • outputGroups

        public final List<OutputGroup> outputGroups()
        Returns the value of the OutputGroups property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputGroups() method.

        Returns:
        The value of the OutputGroups property for this object.
      • timecodeConfig

        public final TimecodeConfig timecodeConfig()
        Contains settings used to acquire and adjust timecode information from inputs.
        Returns:
        Contains settings used to acquire and adjust timecode information from inputs.
      • hasVideoDescriptions

        public final boolean hasVideoDescriptions()
        For responses, this returns true if the service returned a value for the VideoDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • videoDescriptions

        public final List<VideoDescription> videoDescriptions()
        Returns the value of the VideoDescriptions property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVideoDescriptions() method.

        Returns:
        The value of the VideoDescriptions property for this object.
      • thumbnailConfiguration

        public final ThumbnailConfiguration thumbnailConfiguration()
        Thumbnail configuration settings.
        Returns:
        Thumbnail configuration settings.
      • colorCorrectionSettings

        public final ColorCorrectionSettings colorCorrectionSettings()
        Color Correction Settings
        Returns:
        Color Correction Settings
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)