Class: Aws::IVS::Types::StreamEvent

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

Overview

Object specifying a stream’s events. For a list of events, see [Using Amazon EventBridge with Amazon IVS].

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#code ⇒ String

Provides additional details about the stream event. There are several values; note that the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge:

  • ‘StreamTakeoverMediaMismatch` — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.

  • ‘StreamTakeoverInvalidPriority` — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream’s value or a value outside the allowed range of 1 to 2,147,483,647.

  • ‘StreamTakeoverLimitBreached` — The broadcast client reached the maximum allowed takeover attempts for this stream.

Returns:

  • (String) 


1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/aws-sdk-ivs/types.rb', line 1918

class StreamEvent < Struct.new(
  :code,
  :event_time,
  :name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#event_time ⇒ Time

Time when the event occurred. This is an ISO 8601 timestamp; *note that this is returned as a string*.

Returns:

  • (Time) 


1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/aws-sdk-ivs/types.rb', line 1918

class StreamEvent < Struct.new(
  :code,
  :event_time,
  :name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name that identifies the stream event within a ‘type`.

Returns:

  • (String) 


1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/aws-sdk-ivs/types.rb', line 1918

class StreamEvent < Struct.new(
  :code,
  :event_time,
  :name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Logical group for certain events.

Returns:

  • (String) 


1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/aws-sdk-ivs/types.rb', line 1918

class StreamEvent < Struct.new(
  :code,
  :event_time,
  :name,
  :type)
  SENSITIVE = []
  include Aws::Structure
end