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

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

Basic broadcast information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LiveBroadcastSnippet

Returns a new instance of LiveBroadcastSnippet.



3905
3906
3907
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3905

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

Instance Attribute Details

#actual_end_time ⇒ DateTime

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

Returns:

  • (DateTime) 


3845
3846
3847
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3845

def actual_end_time
  @actual_end_time
end

#actual_start_time ⇒ DateTime

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

Returns:

  • (DateTime) 


3851
3852
3853
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3851

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) 


3857
3858
3859
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3857

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) 


3864
3865
3866
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3864

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) 


3869
3870
3871
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3869

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) 


3875
3876
3877
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3875

def live_chat_id
  @live_chat_id
end

#published_at ⇒ DateTime

The date and time that the broadcast was added to YouTube's live broadcast schedule. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


3881
3882
3883
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3881

def published_at
  @published_at
end

#scheduled_end_time ⇒ DateTime

The date and time that the broadcast is scheduled to end. Corresponds to the JSON property scheduledEndTime

Returns:

  • (DateTime) 


3886
3887
3888
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3886

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_time ⇒ DateTime

The date and time that the broadcast is scheduled to start. Corresponds to the JSON property scheduledStartTime

Returns:

  • (DateTime) 


3891
3892
3893
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3891

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:



3896
3897
3898
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3896

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) 


3903
3904
3905
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3903

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 3910

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