net.sf.mmm.client.ui.api.widget.media

Interface UiWidgetMedia

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAriaRole, AttributeReadDisposed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPaused, AttributeReadPositionInSeconds, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeReadVolume, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePaused, AttributeWritePositionInSeconds, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteUrl, AttributeWriteVisible, AttributeWriteVisibleAdvanced, AttributeWriteVolume, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiWidget

All Known Subinterfaces:

UiWidgetMediaAudio, UiWidgetMediaVideo

public interface UiWidgetMedia
extends UiWidget, AttributeWriteUrl, AttributeWritePaused, AttributeWriteVolume, AttributeWritePositionInSeconds

This is the abstract interface for a atomic widget that represents media player. For simple usage see UiWidgetMediaPlayer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Method Summary

Modifier and Type	Method and Description
Iterator<Range<Double>>	getBufferRanges()
double	getDurationInSeconds() This method gets the duration of the current media in seconds.

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteMode

setMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadMode

getMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteModeFixed

setModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModeFixed

getModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVisibleAdvanced

getVisibleFlag, isVisible, setVisible, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisibleRecursive

isVisibleRecursive

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEnabled

setEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModified

isModified

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAriaRole

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteUrl

setUrl

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadUrl

getUrl

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePaused

setPaused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPaused

isPaused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVolume

setVolume

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVolume

getVolume

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePositionInSeconds

setPositionInSeconds

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPositionInSeconds

getPositionInSeconds

Method Detail

getDurationInSeconds

double getDurationInSeconds()

This method gets the duration of the current media in seconds. The duration is the maximum value for the playback position.

Returns:

the duration in seconds.

getBufferRanges

Iterator<Range<Double>> getBufferRanges()

Returns:

an iterator of disjunct Ranges within the media that are available in the buffer. Typically just a single range starting at 0.0 ending before or at the media duration. However, in case of peer-to-peer technology the stream may also be available in chunks identified by multiple ranges. This method is typically used to display the buffered sections in the timer-bar of the media-player.