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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LiveBroadcastSnippet

Returns a new instance of LiveBroadcastSnippet.



3887
3888
3889
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3887

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. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property actualEndTime

Returns:

  • (DateTime) 


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

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. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property actualStartTime

Returns:

  • (DateTime) 


3826
3827
3828
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3826

def actual_start_time
  @actual_start_time
end

#broadcast_type ⇒ String

Corresponds to the JSON property broadcastType

Returns:

  • (String) 


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

def broadcast_type
  @broadcast_type
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) 


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

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) 


3844
3845
3846
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3844

def description
  @description
end

#is_default_broadcast ⇒ Boolean Also known as: is_default_broadcast?

Corresponds to the JSON property isDefaultBroadcast

Returns:

  • (Boolean) 


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

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) 


3855
3856
3857
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3855

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. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


3861
3862
3863
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3861

def published_at
  @published_at
end

#scheduled_end_time ⇒ DateTime

The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property scheduledEndTime

Returns:

  • (DateTime) 


3867
3868
3869
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3867

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_time ⇒ DateTime

The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property scheduledStartTime

Returns:

  • (DateTime) 


3873
3874
3875
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3873

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:



3878
3879
3880
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3878

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) 


3885
3886
3887
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3885

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3892

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)
  @broadcast_type = args[:broadcast_type] if args.key?(:broadcast_type)
  @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