Class: Google::Apis::YoutubeV3::Caption

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

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

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) ⇒ Caption

Returns a new instance of Caption.



670
671
672
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 670

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

Instance Attribute Details

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


652
653
654
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 652

def etag
  @etag
end

#id ⇒ String

The ID that YouTube uses to uniquely identify the caption track. Corresponds to the JSON property id

Returns:

  • (String) 


657
658
659
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 657

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "youtube# caption". Corresponds to the JSON property kind

Returns:

  • (String) 


663
664
665
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 663

def kind
  @kind
end

#snippet ⇒ Google::Apis::YoutubeV3::CaptionSnippet

Basic details about a caption track, such as its language and name. Corresponds to the JSON property snippet

Returns:



668
669
670
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 668

def snippet
  @snippet
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



675
676
677
678
679
680
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 675

def update!(**args)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @snippet = args[:snippet] if args.key?(:snippet)
end