com.yahoo.search
Interface VideoSearchResult

public interface VideoSearchResult

Video search result.

Author:

Ryan Kennedy

Method Summary

String	getChannels() Either 1 (mono) or 2 (stereo).
String	getClickUrl() The URL for linking to the video file.
String	getCopyright() The copyright owner.
BigDecimal	getDuration() The duration of the video file in seconds.
String	getFileFormat() One of avi, flash, mpeg, msmedia, quicktime, or realmedia.
BigInteger	getFileSize() The size of the file in bytes.
BigInteger	getHeight() The height of the keyframe Yahoo extracted from the video in pixels.
String	getPublisher() The creator of the video file.
String	getRefererUrl() The URL of the web page hosting the content.
String	getRestrictions() Provides any restrictions for this media object.
String	getSummary() Summary text associated with the video file.
ImageThumbnail	getThumbnail() The URL of the thumbnail file and its height and width in pixels.
String	getTitle() The title of the video file.
String	getUrl() The URL for the video file or stream.
BigInteger	getWidth() The width of the keyframe Yahoo extracted from the video in pixels.
boolean	isStreaming() Whether the video file is streaming (true) or not (false).

Method Detail

getTitle

String getTitle()

The title of the video file.

Returns:

The title of the video file.

getSummary

String getSummary()

Summary text associated with the video file.

Returns:

Summary text associated with the video file.

getUrl

String getUrl()

The URL for the video file or stream.

Returns:

The URL for the video file or stream.

getClickUrl

String getClickUrl()

The URL for linking to the video file. See URL linking for more information.

Returns:

The URL for linking to the video file.

getRefererUrl

String getRefererUrl()

The URL of the web page hosting the content.

Returns:

The URL of the web page hosting the content.

getFileSize

BigInteger getFileSize()

The size of the file in bytes.

Returns:

The size of the file in bytes.

getFileFormat

String getFileFormat()

One of avi, flash, mpeg, msmedia, quicktime, or realmedia.

NOTE: The value returned is not guaranteed to be one of the above options. The XML schema for video search specifies that FileFormat is of type xs:string. It is possible you may receive something other than the previously mentioned formats.

Returns:

One of avi, flash, mpeg, msmedia, quicktime, or realmedia.

getHeight

BigInteger getHeight()

The height of the keyframe Yahoo extracted from the video in pixels. The video has this height if rendered at 100%. This field is optional.

Returns:

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

getWidth

BigInteger getWidth()

The width of the keyframe Yahoo extracted from the video in pixels. The video has this width if rendered at 100%. This field is optional.

Returns:

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

getDuration

BigDecimal getDuration()

The duration of the video file in seconds.

Returns:

The duration of the video file in seconds.

isStreaming

boolean isStreaming()

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

Returns:

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

getChannels

String getChannels()

Either 1 (mono) or 2 (stereo).

NOTE: The value returned is not guaranteed to be one of the above options. The XML schema for video search specifies that Channels is of type xs:string. It is possible you may receive something other than the previously mentioned formats.

Returns:

Either 1 (mono) or 2 (stereo).

getThumbnail

ImageThumbnail getThumbnail()

The URL of the thumbnail file and its height and width in pixels. This field is optional.

Returns:

The URL of the thumbnail file and its height and width in pixels.

getPublisher

String getPublisher()

The creator of the video file. This field is optional.

Returns:

The creator of the video file.

getRestrictions

String getRestrictions()

Provides any restrictions for this media object. Restrictions include noframe and noinline. This field is optional.

• 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).

Returns:

Returns the restrictions placed on the video file.

getCopyright

String getCopyright()

The copyright owner. This field is optional.

Returns:

The copyright owner.