Class: Aws::IVS::Types::StreamSummary

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#channel_arnString

Channel ARN for the stream.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end

#healthString

The stream’s health.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

  • (Time)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The stream’s state.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end

#stream_idString

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

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end

#viewer_countInteger

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.

Returns:

  • (Integer)


1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1806

class StreamSummary < Struct.new(
  :channel_arn,
  :health,
  :start_time,
  :state,
  :stream_id,
  :viewer_count)
  SENSITIVE = []
  include Aws::Structure
end