Package software.amazon.awscdk.services.mediapackagev2.alpha

Interface SegmentConfiguration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SegmentConfiguration.Jsii$Proxy
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T09:32:03.746Z") @Stability(Experimental) public interface SegmentConfiguration extends software.amazon.jsii.JsiiSerializable
(experimental) The segment configuration, including the segment name, duration, and other configuration values.

Example: 

 Channel channel;
 IRole spekeRole;
 OriginEndpoint.Builder.create(this, "TsEndpoint")
         .channel(channel)
         .segment(Segment.ts(TsSegmentProps.builder()
                 .encryption(TsEncryption.speke(TsSpekeEncryptionProps.builder()
                         .method(TsEncryptionMethod.SAMPLE_AES)
                         .resourceId("my-content-id")
                         .url("https://example.com/speke")
                         .role(spekeRole)
                         .build()))
                 .build()))
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build();

  • Method Details

    • getContainerType

      @Stability(Experimental) @NotNull ContainerType getContainerType()
      (experimental) The container type for this segment (TS or CMAF).

    • getEncryption

      @Stability(Experimental) @Nullable default EncryptionConfiguration getEncryption()
      (experimental) Encryption configuration for the segment.

      Default: - No encryption

    • getIncludeIframeOnlyStreams

      @Stability(Experimental) @Nullable default Boolean getIncludeIframeOnlyStreams()
      (experimental) Whether the segment includes I-frame-only streams.

      Default: undefined - Not specified.

    • getScteFilter

      @Stability(Experimental) @Nullable default List<ScteMessageType> getScteFilter()
      (experimental) The SCTE-35 configuration associated with the segment.

      The SCTE-35 message types that you want to be treated as ad markers in the output.

      Default: - No SCTE filtering

    • getScteInSegments

      @Stability(Experimental) @Nullable default ScteInSegments getScteInSegments()
      (experimental) Controls whether SCTE-35 messages are included in segment files.

      Default: - SCTE-35 messages are not included in segments

    • getSegmentDuration

      @Stability(Experimental) @Nullable default Duration getSegmentDuration()
      (experimental) The duration of the segments.

      Default: 6

    • getSegmentName

      @Stability(Experimental) @Nullable default String getSegmentName()
      (experimental) The name of the segment associated with the origin endpoint.

      Default: segment

    • getTsIncludeDvbSubtitles

      @Stability(Experimental) @Nullable default Boolean getTsIncludeDvbSubtitles()
      (experimental) Whether the segment includes DVB subtitles.

      Default: false

    • getTsUseAudioRenditionGroup

      @Stability(Experimental) @Nullable default Boolean getTsUseAudioRenditionGroup()
      (experimental) Whether the segment is an audio rendition group.

      Default: false

    • builder

      @Stability(Experimental) static SegmentConfiguration.Builder builder()
      Returns:
      a SegmentConfiguration.Builder of SegmentConfiguration