Class: YahooVideo::SearchResult

Inherits:
Record
  • Object
show all
Defined in:
lib/yahoo-video.rb

Overview

Describes a single search result as returned by the Yahoo! Video search service. Parameters are passed to the constructor as hash key/value pairs.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Record

#initialize

Constructor Details

This class inherits a constructor from YahooVideo::Record

Instance Attribute Details

#channels ⇒ Object (readonly)

the number of channels in the audio. usually 1 (mono) or 2 (stereo).



120
121
122
 
# File 'lib/yahoo-video.rb', line 120

def channels
  @channels
end

#click_url ⇒ Object (readonly)

the url for linking to the video file.



123
124
125
 
# File 'lib/yahoo-video.rb', line 123

def click_url
  @click_url
end

#copyright ⇒ Object (readonly)

the copyright owner.



126
127
128
 
# File 'lib/yahoo-video.rb', line 126

def copyright
  @copyright
end

#duration ⇒ Object (readonly)

the duration of the video file in seconds.



129
130
131
 
# File 'lib/yahoo-video.rb', line 129

def duration
  @duration
end

#file_format ⇒ Object (readonly)

the format of the video file – one of avi, flash, mpeg, msmedia, quicktime, or realmedia.



133
134
135
 
# File 'lib/yahoo-video.rb', line 133

def file_format
  @file_format
end

#file_size ⇒ Object (readonly)

the size of the video file in bytes.



136
137
138
 
# File 'lib/yahoo-video.rb', line 136

def file_size
  @file_size
end

#height ⇒ Object (readonly)

the height of the keyframe Yahoo! extracted from the video in pixels. the video has this height if rendered at 100%.



140
141
142
 
# File 'lib/yahoo-video.rb', line 140

def height
  @height
end

#publisher ⇒ Object (readonly)

the creator of the video file.



143
144
145
 
# File 'lib/yahoo-video.rb', line 143

def publisher
  @publisher
end

#referer_url ⇒ Object (readonly)

the url of the web page hosting the content.



146
147
148
 
# File 'lib/yahoo-video.rb', line 146

def referer_url
  @referer_url
end

#restrictions ⇒ Object (readonly)

Provides any restrictions for this media object. Restrictions include noframe and noinline.

  • noframe means that you should not display it with a framed page on your site.

  • noinline means that you should not inline the object in the frame up top (it won’t work because the site has some protection based on the “referrer” field).



156
157
158
 
# File 'lib/yahoo-video.rb', line 156

def restrictions
  @restrictions
end

#streaming ⇒ Object (readonly)

whether the video file is streaming (true) or not (false).



159
160
161
 
# File 'lib/yahoo-video.rb', line 159

def streaming
  @streaming
end

#summary ⇒ Object (readonly)

summary text description associated with the video file.



162
163
164
 
# File 'lib/yahoo-video.rb', line 162

def summary
  @summary
end

#thumbnail ⇒ Object (readonly)

the Thumbnail record describing the url of the thumbnail file and its height and width in pixels.



166
167
168
 
# File 'lib/yahoo-video.rb', line 166

def thumbnail
  @thumbnail
end

#title ⇒ Object (readonly)

the title of the video file.



169
170
171
 
# File 'lib/yahoo-video.rb', line 169

def title
  @title
end

#url ⇒ Object (readonly)

the url for the video file or stream.



172
173
174
 
# File 'lib/yahoo-video.rb', line 172

def url
  @url
end

#width ⇒ Object (readonly)

the width of the keyframe Yahoo! extracted from the video in pixels. the video has this width if rendered at 100%.



176
177
178
 
# File 'lib/yahoo-video.rb', line 176

def width
  @width
end