class MuxRuby::LiveStream
Attributes
The Asset
that is currently being created if there is an active broadcast.
The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.
Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).
Unique identifier for the Live Stream. Max 255 characters.
Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds.
Arbitrary metadata set for the asset. Max 255 characters.
An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](docs.mux.com/guides/video/play-your-videos) for more details.
An array of strings with the most recent Assets that were created from this live stream.
When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Min: 0.1s. Max: 300s (5 minutes).
Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs.
Each Simulcast Target contains configuration details to broadcast (or "restream") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](docs.mux.com/guides/video/stream-live-to-3rd-party-platforms).
`idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published.
Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.
True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/mux_ruby/models/live_stream.rb, line 106 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mux_ruby/models/live_stream.rb, line 85 def self.attribute_map { :'id' => :'id', :'created_at' => :'created_at', :'stream_key' => :'stream_key', :'active_asset_id' => :'active_asset_id', :'recent_asset_ids' => :'recent_asset_ids', :'status' => :'status', :'playback_ids' => :'playback_ids', :'new_asset_settings' => :'new_asset_settings', :'passthrough' => :'passthrough', :'audio_only' => :'audio_only', :'reconnect_window' => :'reconnect_window', :'reduced_latency' => :'reduced_latency', :'low_latency' => :'low_latency', :'simulcast_targets' => :'simulcast_targets', :'test' => :'test' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mux_ruby/models/live_stream.rb, line 283 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mux_ruby/models/live_stream.rb, line 139 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::LiveStream` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::LiveStream`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'stream_key') self.stream_key = attributes[:'stream_key'] end if attributes.key?(:'active_asset_id') self.active_asset_id = attributes[:'active_asset_id'] end if attributes.key?(:'recent_asset_ids') if (value = attributes[:'recent_asset_ids']).is_a?(Array) self.recent_asset_ids = value end end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'playback_ids') if (value = attributes[:'playback_ids']).is_a?(Array) self.playback_ids = value end end if attributes.key?(:'new_asset_settings') self.new_asset_settings = attributes[:'new_asset_settings'] end if attributes.key?(:'passthrough') self.passthrough = attributes[:'passthrough'] end if attributes.key?(:'audio_only') self.audio_only = attributes[:'audio_only'] end if attributes.key?(:'reconnect_window') self.reconnect_window = attributes[:'reconnect_window'] else self.reconnect_window = 60 end if attributes.key?(:'reduced_latency') self.reduced_latency = attributes[:'reduced_latency'] end if attributes.key?(:'low_latency') self.low_latency = attributes[:'low_latency'] end if attributes.key?(:'simulcast_targets') if (value = attributes[:'simulcast_targets']).is_a?(Array) self.simulcast_targets = value end end if attributes.key?(:'test') self.test = attributes[:'test'] end end
List of attributes with nullable: true
# File lib/mux_ruby/models/live_stream.rb, line 132 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/mux_ruby/models/live_stream.rb, line 111 def self.openapi_types { :'id' => :'String', :'created_at' => :'String', :'stream_key' => :'String', :'active_asset_id' => :'String', :'recent_asset_ids' => :'Array<String>', :'status' => :'String', :'playback_ids' => :'Array<PlaybackID>', :'new_asset_settings' => :'CreateAssetRequest', :'passthrough' => :'String', :'audio_only' => :'Boolean', :'reconnect_window' => :'Float', :'reduced_latency' => :'Boolean', :'low_latency' => :'Boolean', :'simulcast_targets' => :'Array<SimulcastTarget>', :'test' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mux_ruby/models/live_stream.rb, line 248 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created_at == o.created_at && stream_key == o.stream_key && active_asset_id == o.active_asset_id && recent_asset_ids == o.recent_asset_ids && status == o.status && playback_ids == o.playback_ids && new_asset_settings == o.new_asset_settings && passthrough == o.passthrough && audio_only == o.audio_only && reconnect_window == o.reconnect_window && reduced_latency == o.reduced_latency && low_latency == o.low_latency && simulcast_targets == o.simulcast_targets && test == o.test end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/mux_ruby/models/live_stream.rb, line 313 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = MuxRuby.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/mux_ruby/models/live_stream.rb, line 384 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mux_ruby/models/live_stream.rb, line 290 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/mux_ruby/models/live_stream.rb, line 270 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/mux_ruby/models/live_stream.rb, line 276 def hash [id, created_at, stream_key, active_asset_id, recent_asset_ids, status, playback_ids, new_asset_settings, passthrough, audio_only, reconnect_window, reduced_latency, low_latency, simulcast_targets, test].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mux_ruby/models/live_stream.rb, line 223 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/mux_ruby/models/live_stream.rb, line 238 def status=(status) validator = EnumAttributeValidator.new('String', ["active", "idle", "disabled"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mux_ruby/models/live_stream.rb, line 366 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mux_ruby/models/live_stream.rb, line 354 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/mux_ruby/models/live_stream.rb, line 230 def valid? status_validator = EnumAttributeValidator.new('String', ["active", "idle", "disabled"]) return false unless status_validator.valid?(@status) true end