Class: Google::Apis::YoutubeV3::VideoLiveStreamingDetails

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/youtube_v3/classes.rb,
lib/google/apis/youtube_v3/representations.rb,
lib/google/apis/youtube_v3/representations.rb

Overview

Details about the live streaming metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VideoLiveStreamingDetails

Returns a new instance of VideoLiveStreamingDetails.



8565
8566
8567
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8565

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_live_chat_id ⇒ String

The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. Corresponds to the JSON property activeLiveChatId

Returns:

  • (String) 


8529
8530
8531
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8529

def active_live_chat_id
  @active_live_chat_id
end

#actual_end_time ⇒ DateTime

The time that the broadcast actually ended. This value will not be available until the broadcast is over. Corresponds to the JSON property actualEndTime

Returns:

  • (DateTime) 


8535
8536
8537
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8535

def actual_end_time
  @actual_end_time
end

#actual_start_time ⇒ DateTime

The time that the broadcast actually started. This value will not be available until the broadcast begins. Corresponds to the JSON property actualStartTime

Returns:

  • (DateTime) 


8541
8542
8543
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8541

def actual_start_time
  @actual_start_time
end

#concurrent_viewers ⇒ Fixnum

The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. Corresponds to the JSON property concurrentViewers

Returns:

  • (Fixnum) 


8551
8552
8553
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8551

def concurrent_viewers
  @concurrent_viewers
end

#scheduled_end_time ⇒ DateTime

The time that the broadcast is scheduled to end. If the value is empty or the property is not present, then the broadcast is scheduled to contiue indefinitely. Corresponds to the JSON property scheduledEndTime

Returns:

  • (DateTime) 


8558
8559
8560
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8558

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_time ⇒ DateTime

The time that the broadcast is scheduled to begin. Corresponds to the JSON property scheduledStartTime

Returns:

  • (DateTime) 


8563
8564
8565
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8563

def scheduled_start_time
  @scheduled_start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8570
8571
8572
8573
8574
8575
8576
8577
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 8570

def update!(**args)
  @active_live_chat_id = args[:active_live_chat_id] if args.key?(:active_live_chat_id)
  @actual_end_time = args[:actual_end_time] if args.key?(:actual_end_time)
  @actual_start_time = args[:actual_start_time] if args.key?(:actual_start_time)
  @concurrent_viewers = args[:concurrent_viewers] if args.key?(:concurrent_viewers)
  @scheduled_end_time = args[:scheduled_end_time] if args.key?(:scheduled_end_time)
  @scheduled_start_time = args[:scheduled_start_time] if args.key?(:scheduled_start_time)
end