Interface ChannelListConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ChannelListConfiguration.Builder,ChannelListConfiguration>, SdkBuilder<ChannelListConfiguration.Builder,ChannelListConfiguration>, SdkPojo
Enclosing class:
ChannelListConfiguration
@Mutable @NotThreadSafe public static interface ChannelListConfiguration.Builder extends SdkPojo, CopyableBuilder<ChannelListConfiguration.Builder,ChannelListConfiguration>

  • Method Details

    • arn

      ChannelListConfiguration.Builder arn(String arn)

      The Amazon Resource Name (ARN) associated with the resource.

      Parameters:
      arn - The Amazon Resource Name (ARN) associated with the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelName

      ChannelListConfiguration.Builder channelName(String channelName)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      Parameters:
      channelName - The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelGroupName

      ChannelListConfiguration.Builder channelGroupName(String channelGroupName)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      Parameters:
      channelGroupName - The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      ChannelListConfiguration.Builder createdAt(Instant createdAt)

      The date and time the channel was created.

      Parameters:
      createdAt - The date and time the channel was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      ChannelListConfiguration.Builder modifiedAt(Instant modifiedAt)

      The date and time the channel was modified.

      Parameters:
      modifiedAt - The date and time the channel was modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ChannelListConfiguration.Builder description(String description)

      Any descriptive information that you want to add to the channel for future identification purposes.

      Parameters:
      description - Any descriptive information that you want to add to the channel for future identification purposes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputType

      ChannelListConfiguration.Builder inputType(String inputType)

      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      Parameters:
      inputType - The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputType

      ChannelListConfiguration.Builder inputType(InputType inputType)

      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      Parameters:
      inputType - The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputLockingMode

      ChannelListConfiguration.Builder outputLockingMode(String outputLockingMode)

      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      Parameters:
      outputLockingMode - The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputLockingMode

      ChannelListConfiguration.Builder outputLockingMode(OutputLockingMode outputLockingMode)

      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      Parameters:
      outputLockingMode - The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiviewConfiguration

      ChannelListConfiguration.Builder multiviewConfiguration(MultiviewConfiguration multiviewConfiguration)

      The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

      Parameters:
      multiviewConfiguration - The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiviewConfiguration

      default ChannelListConfiguration.Builder multiviewConfiguration(Consumer<MultiviewConfiguration.Builder> multiviewConfiguration)

      The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

      This is a convenience method that creates an instance of the MultiviewConfiguration.Builder avoiding the need to create one manually via MultiviewConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multiviewConfiguration(MultiviewConfiguration).

      Parameters:
      multiviewConfiguration - a consumer that will call methods on MultiviewConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attachedMultiviewChannels

      ChannelListConfiguration.Builder attachedMultiviewChannels(Collection<String> attachedMultiviewChannels)

      The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.

      Parameters:
      attachedMultiviewChannels - The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachedMultiviewChannels

      ChannelListConfiguration.Builder attachedMultiviewChannels(String... attachedMultiviewChannels)

      The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.

      Parameters:
      attachedMultiviewChannels - The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.