Interface StreamSession.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StreamSession.Builder,
,StreamSession> SdkBuilder<StreamSession.Builder,
,StreamSession> SdkPojo
- Enclosing class:
StreamSession
-
Method Summary
Modifier and TypeMethodDescriptiondefault StreamSession.Builder
channel
(Consumer<Channel.Builder> channel) The properties of the channel at the time of going live.The properties of the channel at the time of going live.Time when the channel went offline.default StreamSession.Builder
ingestConfiguration
(Consumer<IngestConfiguration.Builder> ingestConfiguration) The properties of the incoming RTMP stream for the stream.ingestConfiguration
(IngestConfiguration ingestConfiguration) The properties of the incoming RTMP stream for the stream.default StreamSession.Builder
recordingConfiguration
(Consumer<RecordingConfiguration.Builder> recordingConfiguration) The properties of recording the live stream.recordingConfiguration
(RecordingConfiguration recordingConfiguration) The properties of recording the live stream.Time when the channel went live.Unique identifier for a live or previously live stream in the specified channel.truncatedEvents
(Collection<StreamEvent> truncatedEvents) List of Amazon IVS events that the stream encountered.truncatedEvents
(Consumer<StreamEvent.Builder>... truncatedEvents) List of Amazon IVS events that the stream encountered.truncatedEvents
(StreamEvent... truncatedEvents) List of Amazon IVS events that the stream encountered.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The properties of the channel at the time of going live.
This is a convenience method that creates an instance of theChannel.Builder
avoiding the need to create one manually viaChannel.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochannel(Channel)
.- Parameters:
channel
- a consumer that will call methods onChannel.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isNULL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ingestConfiguration
The properties of the incoming RTMP stream for the stream.
- Parameters:
ingestConfiguration
- The properties of the incoming RTMP stream for the stream.- 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 for the stream.
This is a convenience method that creates an instance of theIngestConfiguration.Builder
avoiding the need to create one manually viaIngestConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toingestConfiguration(IngestConfiguration)
.- Parameters:
ingestConfiguration
- a consumer that will call methods onIngestConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theRecordingConfiguration.Builder
avoiding the need to create one manually viaRecordingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecordingConfiguration(RecordingConfiguration)
.- Parameters:
recordingConfiguration
- a consumer that will call methods onRecordingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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 theStreamEvent.Builder
avoiding the need to create one manually viaStreamEvent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totruncatedEvents(List<StreamEvent>)
.- Parameters:
truncatedEvents
- a consumer that will call methods onStreamEvent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-