Class: Aws::IVS::Types::StreamSession

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ivs/types.rb

Overview

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel ⇒ Types::Channel

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

Returns:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is `NULL`.

Returns:

  • (Time) 


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_configuration ⇒ Types::IngestConfiguration

The properties of the incoming RTMP stream for the stream.

Returns:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#recording_configuration ⇒ Types::RecordingConfiguration

The properties of recording the live stream.

Returns:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

UTC ISO-8601 formatted timestamp of when the channel went live.

Returns:

  • (Time) 


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

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

Returns:

  • (String) 


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end

#truncated_events ⇒ Array<Types::StreamEvent>

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].

[1]: docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html

Returns:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/aws-sdk-ivs/types.rb', line 1624

class StreamSession < Struct.new(
  :channel,
  :end_time,
  :ingest_configuration,
  :recording_configuration,
  :start_time,
  :stream_id,
  :truncated_events)
  SENSITIVE = []
  include Aws::Structure
end