Class: Yt::Models::ContentDetail

Inherits:
Base
  • Object
show all
Defined in:
lib/yt/models/content_detail.rb

Overview

Encapsulates information about the video content, including the length of the video and an indication of whether captions are available.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Associations::HasReports

#has_report

Methods included from Associations::HasViewerPercentages

#has_viewer_percentages

Methods included from Associations::HasOne

#has_one

Methods included from Associations::HasMany

#has_many

Methods included from Associations::HasAuthentication

#has_authentication

Constructor Details

#initialize(options = {}) ⇒ ContentDetail

Returns a new instance of ContentDetail.



11
12
13
 
# File 'lib/yt/models/content_detail.rb', line 11

def initialize(options = {})
  @data = options[:data]
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



9
10
11
 
# File 'lib/yt/models/content_detail.rb', line 9

def data
  @data
end

Instance Method Details

#captioned? ⇒ Boolean

Returns whether captions are available for the video.

Returns:

  • (Boolean) —

    whether captions are available for the video.



31
32
33
 
# File 'lib/yt/models/content_detail.rb', line 31

has_attribute :captioned?, from: :caption do |caption|
  caption == 'true'
end

#duration ⇒ Integer

Returns the duration of the video (in seconds).

Returns:

  • (Integer) —

    the duration of the video (in seconds).



16
17
18
 
# File 'lib/yt/models/content_detail.rb', line 16

has_attribute :duration, default: 0 do |value|
  to_seconds value
end

#hd? ⇒ Boolean

Returns whether the video is available in high definition.

Returns:

  • (Boolean) —

    whether the video is available in high definition.



26
27
28
 
# File 'lib/yt/models/content_detail.rb', line 26

has_attribute :hd?, from: :definition do |definition|
  definition == 'hd'
end

#licensed? ⇒ Boolean

Returns whether the video represents licensed content, which means that the content has been claimed by a YouTube content partner.

Returns:

  • (Boolean) —

    whether the video represents licensed content, which means that the content has been claimed by a YouTube content partner.



37
 
# File 'lib/yt/models/content_detail.rb', line 37

has_attribute :licensed?, default: false, from: :licensed_content

#stereoscopic? ⇒ Boolean

Returns whether the video is available in 3D.

Returns:

  • (Boolean) —

    whether the video is available in 3D.



21
22
23
 
# File 'lib/yt/models/content_detail.rb', line 21

has_attribute :stereoscopic?, from: :dimension do |dimension|
  dimension == '3d'
end