Class: Google::Apis::YoutubeV3::LiveBroadcastSnippet

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

Overview

Basic broadcast information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LiveBroadcastSnippet

Returns a new instance of LiveBroadcastSnippet.



3850
3851
3852
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3850

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

Instance Attribute Details

#actual_end_time ⇒ String

The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format. Corresponds to the JSON property actualEndTime

Returns:

  • (String) 


3787
3788
3789
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3787

def actual_end_time
  @actual_end_time
end

#actual_start_time ⇒ String

The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format. Corresponds to the JSON property actualStartTime

Returns:

  • (String) 


3794
3795
3796
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3794

def actual_start_time
  @actual_start_time
end

#channel_id ⇒ String

The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast. Corresponds to the JSON property channelId

Returns:

  • (String) 


3800
3801
3802
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3800

def channel_id
  @channel_id
end

#description ⇒ String

The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource. Corresponds to the JSON property description

Returns:

  • (String) 


3807
3808
3809
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3807

def description
  @description
end

#is_default_broadcast ⇒ Boolean Also known as: is_default_broadcast?

Indicates whether this broadcast is the default broadcast. Internal only. Corresponds to the JSON property isDefaultBroadcast

Returns:

  • (Boolean) 


3812
3813
3814
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3812

def is_default_broadcast
  @is_default_broadcast
end

#live_chat_id ⇒ String

The id of the live chat for this broadcast. Corresponds to the JSON property liveChatId

Returns:

  • (String) 


3818
3819
3820
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3818

def live_chat_id
  @live_chat_id
end

#published_at ⇒ String

The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format. Corresponds to the JSON property publishedAt

Returns:

  • (String) 


3824
3825
3826
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3824

def published_at
  @published_at
end

#scheduled_end_time ⇒ String

The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. Corresponds to the JSON property scheduledEndTime

Returns:

  • (String) 


3830
3831
3832
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3830

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_time ⇒ String

The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format. Corresponds to the JSON property scheduledStartTime

Returns:

  • (String) 


3836
3837
3838
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3836

def scheduled_start_time
  @scheduled_start_time
end

#thumbnails ⇒ Google::Apis::YoutubeV3::ThumbnailDetails

Internal representation of thumbnails for a YouTube resource. Corresponds to the JSON property thumbnails

Returns:



3841
3842
3843
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3841

def thumbnails
  @thumbnails
end

#title ⇒ String

The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource. Corresponds to the JSON property title

Returns:

  • (String) 


3848
3849
3850
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3848

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3855

def update!(**args)
  @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)
  @channel_id = args[:channel_id] if args.key?(:channel_id)
  @description = args[:description] if args.key?(:description)
  @is_default_broadcast = args[:is_default_broadcast] if args.key?(:is_default_broadcast)
  @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id)
  @published_at = args[:published_at] if args.key?(:published_at)
  @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)
  @thumbnails = args[:thumbnails] if args.key?(:thumbnails)
  @title = args[:title] if args.key?(:title)
end