Class: Aws::IVS::Types::StreamSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::IVS::Types::StreamSummary
- Defined in:
- gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb
Overview
Summary information about a stream.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#channel_arn ⇒ String
Channel ARN for the stream.
-
#health ⇒ String
The stream’s health.
-
#start_time ⇒ Time
Time of the stream’s start.
-
#state ⇒ String
The stream’s state.
-
#stream_id ⇒ String
Unique identifier for a live or previously live stream in the specified channel.
-
#viewer_count ⇒ Integer
A count of concurrent views of the stream.
Instance Attribute Details
#channel_arn ⇒ String
Channel ARN for the stream.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |
#health ⇒ String
The stream’s health.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |
#start_time ⇒ Time
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
The stream’s state. Do not rely on the OFFLINE
state, as the API
may not return it; instead, a "NotBroadcasting" error will
indicate that the stream is not live.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |
#stream_id ⇒ String
Unique identifier for a live or previously live stream in the specified channel.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |
#viewer_count ⇒ Integer
A count of concurrent views of the stream. Typically, a new view
appears in viewerCount
within 15 seconds of when video playback
starts and a view is removed from viewerCount
within 1 minute of
when video playback ends. A value of -1 indicates that the request
timed out; in this case, retry.
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 |
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 2104 class StreamSummary < Struct.new( :channel_arn, :stream_id, :state, :health, :viewer_count, :start_time) SENSITIVE = [] include Aws::Structure end |