Class CmafIngestGroupSettings

java.lang.Object
software.amazon.awssdk.services.medialive.model.CmafIngestGroupSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CmafIngestGroupSettings.Builder,CmafIngestGroupSettings>
@Generated("software.amazon.awssdk:codegen") public final class CmafIngestGroupSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CmafIngestGroupSettings.Builder,CmafIngestGroupSettings>
Cmaf Ingest Group Settings
See Also:

  • Method Details

    • destination

      public final OutputLocationRef destination()
      A HTTP destination for the tracks
      Returns:
      A HTTP destination for the tracks

    • nielsenId3Behavior

      public final CmafNielsenId3Behavior nielsenId3Behavior()
      If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

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

      Returns:
      If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
      See Also:

    • nielsenId3BehaviorAsString

      public final String nielsenId3BehaviorAsString()
      If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

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

      Returns:
      If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
      See Also:

    • scte35Type

      public final Scte35Type scte35Type()
      Type of scte35 track to add. none or scte35WithoutSegmentation

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

      Returns:
      Type of scte35 track to add. none or scte35WithoutSegmentation
      See Also:

    • scte35TypeAsString

      public final String scte35TypeAsString()
      Type of scte35 track to add. none or scte35WithoutSegmentation

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

      Returns:
      Type of scte35 track to add. none or scte35WithoutSegmentation
      See Also:

    • segmentLength

      public final Integer segmentLength()
      The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units.
      Returns:
      The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units.

    • segmentLengthUnits

      public final CmafIngestSegmentLengthUnits segmentLengthUnits()
      Time unit for segment length parameter.

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

      Returns:
      Time unit for segment length parameter.
      See Also:

    • segmentLengthUnitsAsString

      public final String segmentLengthUnitsAsString()
      Time unit for segment length parameter.

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

      Returns:
      Time unit for segment length parameter.
      See Also:

    • sendDelayMs

      public final Integer sendDelayMs()
      Number of milliseconds to delay the output from the second pipeline.
      Returns:
      Number of milliseconds to delay the output from the second pipeline.

    • klvBehavior

      public final CmafKLVBehavior klvBehavior()
      If set to passthrough, passes any KLV data from the input source to this output.

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

      Returns:
      If set to passthrough, passes any KLV data from the input source to this output.
      See Also:

    • klvBehaviorAsString

      public final String klvBehaviorAsString()
      If set to passthrough, passes any KLV data from the input source to this output.

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

      Returns:
      If set to passthrough, passes any KLV data from the input source to this output.
      See Also:

    • klvNameModifier

      public final String klvNameModifier()
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies a KLV track. The default is "klv", which means the default name will be Streams(klv.cmfm). Any string you enter here will replace the "klv" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.
      Returns:
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies a KLV track. The default is "klv", which means the default name will be Streams(klv.cmfm). Any string you enter here will replace the "klv" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

    • nielsenId3NameModifier

      public final String nielsenId3NameModifier()
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies a Nielsen ID3 track. The default is "nid3", which means the default name will be Streams(nid3.cmfm). Any string you enter here will replace the "nid3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.
      Returns:
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies a Nielsen ID3 track. The default is "nid3", which means the default name will be Streams(nid3.cmfm). Any string you enter here will replace the "nid3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

    • scte35NameModifier

      public final String scte35NameModifier()
      Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is "scte", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the "scte" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.
      Returns:
      Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is "scte", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the "scte" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

    • id3Behavior

      public final CmafId3Behavior id3Behavior()
      Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule.

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

      Returns:
      Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule.
      See Also:

    • id3BehaviorAsString

      public final String id3BehaviorAsString()
      Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule.

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

      Returns:
      Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule.
      See Also:

    • id3NameModifier

      public final String id3NameModifier()
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is "id3", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the "id3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.
      Returns:
      Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is "id3", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the "id3" string.\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters.

    • hasCaptionLanguageMappings

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

    • captionLanguageMappings

      public final List<CmafIngestCaptionLanguageMapping> captionLanguageMappings()
      An array that identifies the languages in the four caption channels in the embedded captions.

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

      Returns:
      An array that identifies the languages in the four caption channels in the embedded captions.

    • timedMetadataId3Frame

      public final CmafTimedMetadataId3Frame timedMetadataId3Frame()
      Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.

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

      Returns:
      Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.
      See Also:

    • timedMetadataId3FrameAsString

      public final String timedMetadataId3FrameAsString()
      Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.

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

      Returns:
      Set to none if you don't want to insert a timecode in the output. Otherwise choose the frame type for the timecode.
      See Also:

    • timedMetadataId3Period

      public final Integer timedMetadataId3Period()
      If you set up to insert a timecode in the output, specify the frequency for the frame, in seconds.
      Returns:
      If you set up to insert a timecode in the output, specify the frequency for the frame, in seconds.

    • timedMetadataPassthrough

      public final CmafTimedMetadataPassthrough timedMetadataPassthrough()
      Set to enabled to pass through ID3 metadata from the input sources.

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

      Returns:
      Set to enabled to pass through ID3 metadata from the input sources.
      See Also:

    • timedMetadataPassthroughAsString

      public final String timedMetadataPassthroughAsString()
      Set to enabled to pass through ID3 metadata from the input sources.

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

      Returns:
      Set to enabled to pass through ID3 metadata from the input sources.
      See Also:

    • toBuilder

      public CmafIngestGroupSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CmafIngestGroupSettings.Builder,CmafIngestGroupSettings>
      Returns:
      a builder for type T

    • builder

      public static CmafIngestGroupSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CmafIngestGroupSettings.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.