Class: Yt::Models::Annotation

Inherits:

Base

• Object
• Base
• Yt::Models::Annotation

Defined in:

lib/yt/models/annotation.rb

Overview

Note:

YouTube API V3 does not provide access to video annotations, therefore a legacy XML endpoint is used to retrieve annotations.

Provides methods to interact with YouTube annotations.

See Also:

• https://www.youtube.com/yt/playbook/annotations.html

Instance Method Summary

• #above?(y) ⇒ Boolean

  Whether the text box surrounding the annotation is completely in the top y% of the video frame.

• #below?(y) ⇒ Boolean

  Whether the text box surrounding the annotation is completely in the bottom y% of the video frame.

• #has_invideo_programming? ⇒ Boolean

  Whether the annotation is an “InVideo Programming”.

• #has_link_to_playlist? ⇒ Boolean

  Whether the annotation includes a link to a playlist, or to a video embedded in a playlist.

• #has_link_to_same_window? ⇒ Boolean

  Whether the annotation includes a link that will open in the current browser window.

• #has_link_to_subscribe?(options = {}) ⇒ Boolean

  Whether the annotation includes a link to subscribe.

• #has_link_to_video?(options = {}) ⇒ Boolean

  Whether the annotation includes a link to a video, either directly in the text, or as an “Invideo featured video”.

• #initialize(options = {}) ⇒ Annotation constructor

  A new instance of Annotation.

• #starts_after?(seconds) ⇒ Boolean

  Whether the annotation starts after the number of seconds indicated.

• #starts_before?(seconds) ⇒ Boolean

  Whether the annotation starts before the number of seconds indicated.

• #text ⇒ String

  The textual content of the annotation.

Constructor Details

#initialize(options = {}) ⇒ Annotation

Returns a new instance of Annotation.

Options Hash (options):

• :data (String) —

  The XML representation of an annotation

# File 'lib/yt/models/annotation.rb', line 10

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

Instance Method Details

#above?(y) ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 17

def above?(y)
  top && top < y
end

#below?(y) ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 24

def below?(y)
  bottom && bottom > y
end

#has_invideo_programming? ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 52

def has_invideo_programming?
  type == 'promotion' || type == 'branding'
end

#has_link_to_playlist? ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 41

def has_link_to_playlist?
  link_class == '2' || text.include?('&list=')
end

#has_link_to_same_window? ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 47

def has_link_to_same_window?
  link_target == 'current'
end

#has_link_to_subscribe?(options = {}) ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 29

def has_link_to_subscribe?(options = {}) # TODO: options for which videos
  link_class == '5'
end

#has_link_to_video?(options = {}) ⇒ Boolean

# File 'lib/yt/models/annotation.rb', line 35

def has_link_to_video?(options = {}) # TODO: options for which videos
  link_class == '1' || type == 'promotion'
end

#starts_after?(seconds) ⇒ Boolean

Note:

This is broken for invideo programming, because they do not have the timestamp in the region, but in the “data” field

Returns whether the annotation starts after the number of seconds indicated.

# File 'lib/yt/models/annotation.rb', line 61

def starts_after?(seconds)
  timestamps.first > seconds if timestamps.any?
end

#starts_before?(seconds) ⇒ Boolean

Note:

This is broken for invideo programming, because they do not have the timestamp in the region, but in the “data” field

Returns whether the annotation starts before the number of seconds indicated.

# File 'lib/yt/models/annotation.rb', line 70

def starts_before?(seconds)
  timestamps.first < seconds if timestamps.any?
end

#text ⇒ String

# File 'lib/yt/models/annotation.rb', line 75

def text
  @text ||= @data['TEXT'] || ''
end