Class: Yt::Models::Reference

Inherits:

Base

• Object
• Base
• Yt::Models::Reference

Defined in:

lib/yt/models/reference.rb

Overview

Provides methods to interact with YouTube ContentID references.

See Also:

• https://developers.google.com/youtube/partner/docs/v1/references

Constant Summary

STATUSES =

Status

%q(activating active checking computing_fingerprint deleted
duplicate_on_hold inactive live_streaming_processing
urgent_reference_processing)

CONTENT_TYPES =

Content Type

%q(audio video audiovisual)

Instance Method Summary

• #activating? ⇒ Boolean

  Whether the reference is pending.

• #active? ⇒ Boolean

  Whether the reference is active.

• #asset_id ⇒ String

  The ID that uniquely identifies the asset that the reference is associated with.

• #audio? ⇒ Boolean

  Whether the reference covers the audio of the content.

• #audioswap_enabled? ⇒ boolean

  Whether or not the reference content is included in YouTube’s AudioSwap program.

• #audiovisual? ⇒ Boolean

  Whether the reference covers the audiovisual of the content.

• #checking? ⇒ Boolean

  Whether the reference is being compared to existing references to identify any reference conflicts that might exist.

• #claim_id ⇒ String

  The claim ID that represents the resulting association between the asset and the video.

• #computing_fingerprint? ⇒ Boolean

  Whether the reference’s fingerprint is being computed.

• #content_type ⇒ String

  Whether the reference covers the audio, video, or audiovisual portion of the claimed content.

• #delete ⇒ Boolean

  Soft-deletes the reference.

• #deleted? ⇒ Boolean

  Whether the reference is deleted.

• #duplicate_leader ⇒ String

  The ID that uniquely identifies the reference that this reference duplicates.

• #duplicate_on_hold? ⇒ Boolean

  Whether the reference iis a duplicate and is on hold.

• #id ⇒ String

  The ID that YouTube assigns and uses to uniquely identify the reference.

• #ignore_fp_match? ⇒ boolean

  Should the reference be used to generate claims.

• #inactive? ⇒ Boolean

  Whether the reference is inactive.

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

  A new instance of Reference.

• #length ⇒ Float

  The length of the reference in seconds.

• #live_streaming_processing? ⇒ Boolean

  Whether the reference is being processed from a live video stream.

• #status ⇒ String

  The reference’s status.

• #status_reason ⇒ String

  An explanation of how a reference entered its current state.

• #urgent? ⇒ Boolean

  The urgent status of the reference file.

• #urgent_reference_processing? ⇒ Boolean

  Whether the reference is urgent_reference_processing.

• #video? ⇒ Boolean

  Whether the reference covers the video of the content.

• #video_id ⇒ String

  The ID of the source video.

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 = {}) ⇒ Reference

# File 'lib/yt/models/reference.rb', line 8

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

Instance Method Details

#activating? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 94

def activating?
  status == 'activating'
end

#active? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 99

def active?
  status == 'active'
end

#asset_id ⇒ String

# File 'lib/yt/models/reference.rb', line 33

has_attribute :asset_id

#audio? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 152

def audio?
  content_type == 'audio'
end

#audioswap_enabled? ⇒ boolean

# File 'lib/yt/models/reference.rb', line 55

has_attribute :audioswap_enabled?, from: :audioswap_enabled

#audiovisual? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 164

def audiovisual?
  content_type == 'audiovisual'
end

#checking? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 105

def checking?
  status == 'checking'
end

#claim_id ⇒ String

# File 'lib/yt/models/reference.rb', line 49

has_attribute :claim_id

#computing_fingerprint? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 111

def computing_fingerprint?
  status == 'computing_fingerprint'
end

#content_type ⇒ String

# File 'lib/yt/models/reference.rb', line 148

has_attribute :content_type

#delete ⇒ Boolean

Note:

YouTube API does not provide a delete method for the Reference resource, but only an update method. Updating the status of a Reference to “inactive” can be considered a soft-deletion, since it allows to successively create new references for the same claim.

Soft-deletes the reference.

# File 'lib/yt/models/reference.rb', line 21

def delete
  body = {id: id, status: :inactive}
  do_update(body: body) {|data| @data = data}
  inactive?
end

#deleted? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 116

def deleted?
  status == 'deleted'
end

#duplicate_leader ⇒ String

# File 'lib/yt/models/reference.rb', line 80

has_attribute :duplicate_leader

#duplicate_on_hold? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 121

def duplicate_on_hold?
  status == 'duplicate_on_hold'
end

#id ⇒ String

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

has_attribute :id

#ignore_fp_match? ⇒ boolean

# File 'lib/yt/models/reference.rb', line 60

has_attribute :ignore_fp_match?, from: :ignore_fp_match

#inactive? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 126

def inactive?
  status == 'inactive'
end

#length ⇒ Float

# File 'lib/yt/models/reference.rb', line 36

has_attribute :length

#live_streaming_processing? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 132

def live_streaming_processing?
  status == 'live_streaming_processing'
end

#status ⇒ String

# File 'lib/yt/models/reference.rb', line 91

has_attribute :status

#status_reason ⇒ String

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

has_attribute :status_reason

#urgent? ⇒ Boolean

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

has_attribute :urgent?, from: :urgent

#urgent_reference_processing? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 137

def urgent_reference_processing?
  status == 'urgent_reference_processing'
end

#video? ⇒ Boolean

# File 'lib/yt/models/reference.rb', line 158

def video?
  content_type == 'video'
end

#video_id ⇒ String

# File 'lib/yt/models/reference.rb', line 42

has_attribute :video_id