Package org.silverpeas.core.webapi.media.streaming

Class StreamingProviderDataEntity

java.lang.Object

org.silverpeas.core.webapi.media.streaming.StreamingProviderDataEntity

All Implemented Interfaces:

Serializable, WebEntity

Direct Known Subclasses:

VimeoDataEntity, YoutubeDataEntity

public class StreamingProviderDataEntity
extends Object
implements WebEntity

This entity ensures that all streaming data are formatted in a single way whatever the streaming provider.

Author:

silveryocha

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamingProviderDataEntity()
protected	StreamingProviderDataEntity(StreamingProvider streamingProvider, OembedDataEntity oembedData)	Constructor from OembedDataEntity (http://oembed.com).

Method Summary

Modifier and Type	Method	Description
void	forceSecureEmbedUrl()
static Optional<StreamingProviderDataEntity>	from(String homepageUrl)	Creates a streaming provider data entity from specified homepage url.
String	getAuthor()
MediaDefinitionEntity	getDefinition()
String	getEmbedHtml()
String	getFormattedDurationHMS()
StreamingProvider	getProvider()
String	getSilverpeasEmbedUrl()
MediaDefinitionEntity	getThumbnailDefinition()
List<URI>	getThumbnailPreviewUrls()
URI	getThumbnailUrl()
String	getTitle()
URI	getURI()	Gets the URI at which this web entity is published and can be accessed.
void	setAuthor(String author)
void	setDefinition(MediaDefinitionEntity definition)
void	setEmbedHtml(String embedHtml)
void	setFormattedDurationHMS(String formattedDurationHMS)
void	setProvider(StreamingProvider provider)
void	setThumbnailDefinition(MediaDefinitionEntity thumbnailDefinition)
void	setThumbnailPreviewUrls(List<URI> thumbnailPreviewUrls)
void	setThumbnailUrl(URI thumbnailUrl)
void	setTitle(String title)
void	setUri(URI uri)
StreamingProviderDataEntity	withURI(URI uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

StreamingProviderDataEntity

protected StreamingProviderDataEntity(StreamingProvider streamingProvider,
                                      OembedDataEntity oembedData)

Constructor from OembedDataEntity (http://oembed.com).

Parameters:

streamingProvider - the Silverpeas provider identifier.

oembedData - the oembed data as JSON format.

StreamingProviderDataEntity

protected StreamingProviderDataEntity()

Method Detail

from

public static Optional<StreamingProviderDataEntity> from(String homepageUrl)

Creates a streaming provider data entity from specified homepage url.

Parameters:

homepageUrl - the streaming home page url.

Returns:

the streaming provider data entity representing the specified streaming.

withURI

public StreamingProviderDataEntity withURI(URI uri)

getURI

public URI getURI()

Description copied from interface: WebEntity

Gets the URI at which this web entity is published and can be accessed.

Specified by:

getURI in interface WebEntity

Returns:

the web entity URI.

setUri

public void setUri(URI uri)

getProvider

public StreamingProvider getProvider()

setProvider

public void setProvider(StreamingProvider provider)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getAuthor

public String getAuthor()

setAuthor

public void setAuthor(String author)

getFormattedDurationHMS

public String getFormattedDurationHMS()

setFormattedDurationHMS

public void setFormattedDurationHMS(String formattedDurationHMS)

getDefinition

public MediaDefinitionEntity getDefinition()

setDefinition

public void setDefinition(MediaDefinitionEntity definition)

getSilverpeasEmbedUrl

public String getSilverpeasEmbedUrl()

getEmbedHtml

public String getEmbedHtml()

setEmbedHtml

public void setEmbedHtml(String embedHtml)

forceSecureEmbedUrl

public void forceSecureEmbedUrl()

getThumbnailUrl

public URI getThumbnailUrl()

setThumbnailUrl

public void setThumbnailUrl(URI thumbnailUrl)

getThumbnailDefinition

public MediaDefinitionEntity getThumbnailDefinition()

setThumbnailDefinition

public void setThumbnailDefinition(MediaDefinitionEntity thumbnailDefinition)

getThumbnailPreviewUrls

public List<URI> getThumbnailPreviewUrls()

setThumbnailPreviewUrls

public void setThumbnailPreviewUrls(List<URI> thumbnailPreviewUrls)