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



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

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

Instance Attribute Details

#actual_end_timeDateTime

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)


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

def actual_end_time
  @actual_end_time
end

#actual_start_timeDateTime

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)


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

def actual_start_time
  @actual_start_time
end

#broadcast_typeString

Corresponds to the JSON property broadcastType

Returns:

  • (String)


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

def broadcast_type
  @broadcast_type
end

#channel_idString

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

Returns:

  • (String)


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

def channel_id
  @channel_id
end

#descriptionString

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)


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

def description
  @description
end

#is_default_broadcastBoolean Also known as: is_default_broadcast?

Corresponds to the JSON property isDefaultBroadcast

Returns:

  • (Boolean)


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

def is_default_broadcast
  @is_default_broadcast
end

#live_chat_idString

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

Returns:

  • (String)


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

def live_chat_id
  @live_chat_id
end

#published_atDateTime

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)


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

def published_at
  @published_at
end

#scheduled_end_timeDateTime

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)


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

def scheduled_end_time
  @scheduled_end_time
end

#scheduled_start_timeDateTime

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)


3853
3854
3855
# File 'generated/google/apis/youtube_v3/classes.rb', line 3853

def scheduled_start_time
  @scheduled_start_time
end

#thumbnailsGoogle::Apis::YoutubeV3::ThumbnailDetails

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



3858
3859
3860
# File 'generated/google/apis/youtube_v3/classes.rb', line 3858

def thumbnails
  @thumbnails
end

#titleString

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)


3865
3866
3867
# File 'generated/google/apis/youtube_v3/classes.rb', line 3865

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'generated/google/apis/youtube_v3/classes.rb', line 3872

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