Class: Google::Apis::YoutubeV3::LiveBroadcastStatus

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

Live broadcast state.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LiveBroadcastStatus

Returns a new instance of LiveBroadcastStatus.



3987
3988
3989
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3987

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

Instance Attribute Details

#life_cycle_status ⇒ String

The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method. Corresponds to the JSON property lifeCycleStatus

Returns:

  • (String) 


3952
3953
3954
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3952

def life_cycle_status
  @life_cycle_status
end

#live_broadcast_priority ⇒ String

Priority of the live broadcast event (internal state). Corresponds to the JSON property liveBroadcastPriority

Returns:

  • (String) 


3957
3958
3959
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3957

def live_broadcast_priority
  @live_broadcast_priority
end

#made_for_kids ⇒ Boolean Also known as: made_for_kids?

Whether the broadcast is made for kids or not, decided by YouTube instead of the creator. This field is read only. Corresponds to the JSON property madeForKids

Returns:

  • (Boolean) 


3963
3964
3965
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3963

def made_for_kids
  @made_for_kids
end

#privacy_status ⇒ String

The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource. Corresponds to the JSON property privacyStatus

Returns:

  • (String) 


3973
3974
3975
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3973

def privacy_status
  @privacy_status
end

#recording_status ⇒ String

The broadcast's recording status. Corresponds to the JSON property recordingStatus

Returns:

  • (String) 


3978
3979
3980
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3978

def recording_status
  @recording_status
end

#self_declared_made_for_kids ⇒ Boolean Also known as: self_declared_made_for_kids?

This field will be set to True if the creator declares the broadcast to be kids only: go/live-cw-work. Corresponds to the JSON property selfDeclaredMadeForKids

Returns:

  • (Boolean) 


3984
3985
3986
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3984

def self_declared_made_for_kids
  @self_declared_made_for_kids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3992
3993
3994
3995
3996
3997
3998
3999
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3992

def update!(**args)
  @life_cycle_status = args[:life_cycle_status] if args.key?(:life_cycle_status)
  @live_broadcast_priority = args[:live_broadcast_priority] if args.key?(:live_broadcast_priority)
  @made_for_kids = args[:made_for_kids] if args.key?(:made_for_kids)
  @privacy_status = args[:privacy_status] if args.key?(:privacy_status)
  @recording_status = args[:recording_status] if args.key?(:recording_status)
  @self_declared_made_for_kids = args[:self_declared_made_for_kids] if args.key?(:self_declared_made_for_kids)
end