Class CreateDashManifestConfiguration

java.lang.Object
software.amazon.awssdk.services.mediapackagev2.model.CreateDashManifestConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CreateDashManifestConfiguration.Builder,CreateDashManifestConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CreateDashManifestConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreateDashManifestConfiguration.Builder,CreateDashManifestConfiguration>

Create a DASH manifest configuration.

See Also:

  • Method Details

    • manifestName

      public final String manifestName()

      A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.

      Returns:
      A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.

    • manifestWindowSeconds

      public final Integer manifestWindowSeconds()

      The total duration (in seconds) of the manifest's content.

      Returns:
      The total duration (in seconds) of the manifest's content.

    • filterConfiguration

      public final FilterConfiguration filterConfiguration()
      Returns the value of the FilterConfiguration property for this object.
      Returns:
      The value of the FilterConfiguration property for this object.

    • minUpdatePeriodSeconds

      public final Integer minUpdatePeriodSeconds()

      Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

      Returns:
      Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

    • minBufferTimeSeconds

      public final Integer minBufferTimeSeconds()

      Minimum amount of content (in seconds) that a player must keep available in the buffer.

      Returns:
      Minimum amount of content (in seconds) that a player must keep available in the buffer.

    • suggestedPresentationDelaySeconds

      public final Integer suggestedPresentationDelaySeconds()

      The amount of time (in seconds) that the player should be from the end of the manifest.

      Returns:
      The amount of time (in seconds) that the player should be from the end of the manifest.

    • segmentTemplateFormat

      public final DashSegmentTemplateFormat segmentTemplateFormat()

      Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

      Value description:

      • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

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

      Returns:
      Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

      Value description:

      • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

      See Also:

    • segmentTemplateFormatAsString

      public final String segmentTemplateFormatAsString()

      Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

      Value description:

      • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

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

      Returns:
      Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

      Value description:

      • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

      See Also:

    • periodTriggers

      public final List<DashPeriodTrigger> periodTriggers()

      A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

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

      Returns:
      A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

    • hasPeriodTriggers

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

    • periodTriggersAsStrings

      public final List<String> periodTriggersAsStrings()

      A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

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

      Returns:
      A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

    • scteDash

      public final ScteDash scteDash()

      The SCTE configuration.

      Returns:
      The SCTE configuration.

    • drmSignaling

      public final DashDrmSignaling drmSignaling()

      Determines how the DASH manifest signals the DRM content.

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

      Returns:
      Determines how the DASH manifest signals the DRM content.
      See Also:

    • drmSignalingAsString

      public final String drmSignalingAsString()

      Determines how the DASH manifest signals the DRM content.

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

      Returns:
      Determines how the DASH manifest signals the DRM content.
      See Also:

    • utcTiming

      public final DashUtcTiming utcTiming()

      Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

      Returns:
      Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

    • profiles

      public final List<DashProfile> profiles()

      The profile that the output is compliant with.

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

      Returns:
      The profile that the output is compliant with.

    • hasProfiles

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

    • profilesAsStrings

      public final List<String> profilesAsStrings()

      The profile that the output is compliant with.

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

      Returns:
      The profile that the output is compliant with.

    • hasBaseUrls

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

    • baseUrls

      public final List<DashBaseUrl> baseUrls()

      The base URLs to use for retrieving segments.

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

      Returns:
      The base URLs to use for retrieving segments.

    • programInformation

      public final DashProgramInformation programInformation()

      Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

      Returns:
      Details about the content that you want MediaPackage to pass through in the manifest to the playback device.

    • dvbSettings

      public final DashDvbSettings dvbSettings()

      For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.

      Returns:
      For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.

    • compactness

      public final DashCompactness compactness()

      The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

      For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

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

      Returns:
      The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

      For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

      See Also:

    • compactnessAsString

      public final String compactnessAsString()

      The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

      For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

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

      Returns:
      The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

      For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

      See Also:

    • subtitleConfiguration

      public final DashSubtitleConfiguration subtitleConfiguration()

      The configuration for DASH subtitles.

      Returns:
      The configuration for DASH subtitles.

    • toBuilder

      public CreateDashManifestConfiguration.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<CreateDashManifestConfiguration.Builder,CreateDashManifestConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CreateDashManifestConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDashManifestConfiguration.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.