Interface StreamSession.Builder

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

  • Method Details

    • channel

      StreamSession.Builder channel(Channel channel)

      The properties of the channel at the time of going live.

      Parameters:
      channel - The properties of the channel at the time of going live.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channel

      default StreamSession.Builder channel(Consumer<Channel.Builder> channel)

      The properties of the channel at the time of going live.

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

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

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

    • endTime

      StreamSession.Builder endTime(Instant endTime)

      Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

      Parameters:
      endTime - Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestConfiguration

      StreamSession.Builder ingestConfiguration(IngestConfiguration ingestConfiguration)

      The properties of the incoming RTMP stream.

      Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

      Parameters:
      ingestConfiguration - The properties of the incoming RTMP stream.

      Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

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

    • ingestConfiguration

      default StreamSession.Builder ingestConfiguration(Consumer<IngestConfiguration.Builder> ingestConfiguration)

      The properties of the incoming RTMP stream.

      Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

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

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

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

    • ingestConfigurations

      StreamSession.Builder ingestConfigurations(IngestConfigurations ingestConfigurations)

      The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

      Parameters:
      ingestConfigurations - The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestConfigurations

      default StreamSession.Builder ingestConfigurations(Consumer<IngestConfigurations.Builder> ingestConfigurations)

      The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

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

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

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

    • recordingConfiguration

      StreamSession.Builder recordingConfiguration(RecordingConfiguration recordingConfiguration)

      The properties of recording the live stream.

      Parameters:
      recordingConfiguration - The properties of recording the live stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordingConfiguration

      default StreamSession.Builder recordingConfiguration(Consumer<RecordingConfiguration.Builder> recordingConfiguration)

      The properties of recording the live stream.

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

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

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

    • startTime

      StreamSession.Builder startTime(Instant startTime)

      Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

      Parameters:
      startTime - Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamId

      StreamSession.Builder streamId(String streamId)

      Unique identifier for a live or previously live stream in the specified channel.

      Parameters:
      streamId - Unique identifier for a live or previously live stream in the specified channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • truncatedEvents

      StreamSession.Builder truncatedEvents(Collection<StreamEvent> truncatedEvents)

      List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

      Parameters:
      truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • truncatedEvents

      StreamSession.Builder truncatedEvents(StreamEvent... truncatedEvents)

      List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

      Parameters:
      truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • truncatedEvents

      StreamSession.Builder truncatedEvents(Consumer<StreamEvent.Builder>... truncatedEvents)

      List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to truncatedEvents(List<StreamEvent>).

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