Package software.amazon.awssdk.services.mediaconvert.model

Class VideoOverlayInput

    • Method Detail

      • fileInput

        public final String fileInput()
        Specify the input file S3, HTTP, or HTTPS URI for your video overlay. For consistency in color and formatting in your output video image, we recommend that you specify a video with similar characteristics as the underlying input video.
        Returns:
        Specify the input file S3, HTTP, or HTTPS URI for your video overlay. For consistency in color and formatting in your output video image, we recommend that you specify a video with similar characteristics as the underlying input video.

      • hasInputClippings

        public final boolean hasInputClippings()
        For responses, this returns true if the service returned a value for the InputClippings 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.

      • inputClippings

        public final List<VideoOverlayInputClipping> inputClippings()
        Specify one or more clips to use from your video overlay. When you include an input clip, you must also specify its start timecode, end timecode, or both start and end timecode.

        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 hasInputClippings() method.

        Returns:
        Specify one or more clips to use from your video overlay. When you include an input clip, you must also specify its start timecode, end timecode, or both start and end timecode.

      • timecodeSource

        public final InputTimecodeSource timecodeSource()
        Specify the timecode source for your video overlay input clips. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

        If the service returns an enum value that is not available in the current SDK version, timecodeSource will return InputTimecodeSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeSourceAsString().

        Returns:
        Specify the timecode source for your video overlay input clips. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.
        See Also:
        InputTimecodeSource

      • timecodeSourceAsString

        public final String timecodeSourceAsString()
        Specify the timecode source for your video overlay input clips. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.

        If the service returns an enum value that is not available in the current SDK version, timecodeSource will return InputTimecodeSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timecodeSourceAsString().

        Returns:
        Specify the timecode source for your video overlay input clips. To use the timecode present in your video overlay: Choose Embedded. To use a zerobased timecode: Choose Start at 0. To choose a timecode: Choose Specified start. When you do, enter the starting timecode in Start timecode. If you don't specify a value for Timecode source, MediaConvert uses Embedded by default.
        See Also:
        InputTimecodeSource

      • timecodeStart

        public final String timecodeStart()
        Specify the starting timecode for this video overlay. To use this setting, you must set Timecode source to Specified start.
        Returns:
        Specify the starting timecode for this video overlay. To use this setting, you must set Timecode source to Specified start.

      • 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)