Package com.ebasetech.xi.api.controls

Interface MultimediaControlProperties

All Superinterfaces:

AriaControlProperties, BorderStyleProperties, MarginStyleProperties, MessageProperties

All Known Subinterfaces:

AudioControl, VideoControl

public interface MultimediaControlProperties
extends BorderStyleProperties, MarginStyleProperties, AriaControlProperties, MessageProperties

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeight()	multimedia player height.
java.lang.String	getSrc()	The URL of the multimedia content to embed.
Text	getText()	Returns the Text object for the multimedia text.
Text	getTitle()	Returns the Text object for the title text.
java.lang.String	getWidth()	multimedia player width.
boolean	isAutoplay()	Returns whether the embedded content will automatically play as soon as it loaded.
boolean	isLoop()	Returns whether the multimedia player will automatically restart upon reaching the end of the content.
boolean	isMuted()	Returns whether the multimedia player will initially be silenced.
boolean	isShowControls()	Returns whether the browser will offer controls to allow the user to control the multimedia playback.
void	setAutoplay(boolean autoplay)	Sets whether the embedded content will automatically play as soon as it loaded.
void	setHeight(java.lang.String imageHeight)	Sets the multimedia player height.
void	setLoop(boolean loop)	Sets whether the multimedia player will automatically restart upon reaching the end of the content.
void	setMuted(boolean loop)	Sets whether the multimedia player will initially be silenced.
void	setShowControls(boolean controls)	Sets whether the browser will offer controls to allow the user to control the multimedia playback.
void	setSrc(java.lang.String src)	Sets the URL of the multimedia content to embed.
void	setWidth(java.lang.String imageWidth)	Sets the multimedia player width.

Methods inherited from interface com.ebasetech.xi.api.controls.AriaControlProperties

addAriaCustomAttribute, getAriaCustomAttributes, getAriaDescribedBy, getAriaLabelledBy, getAriaLabelText, getAriaRole, removeAriaCustomAttribute, setAriaCustomAttributes, setAriaRole

Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties

getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin

Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties

getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle

Method Details

getText

Text getText()

Returns the Text object for the multimedia text.

Further documentation

Since:

V5.12

getTitle

Text getTitle()

Returns the Text object for the title text.

Further documentation

Since:

V5.12

getSrc

java.lang.String getSrc()

The URL of the multimedia content to embed. The URL can be either relative or absolute.

Further documentation.

Since:

V5.12

setSrc

void setSrc(java.lang.String src)

Sets the URL of the multimedia content to embed. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

Further documentation.

Since:

V4.4

isAutoplay

boolean isAutoplay()

Returns whether the embedded content will automatically play as soon as it loaded.

Further documentation.

Since:

V5.12

setAutoplay

void setAutoplay(boolean autoplay)

Sets whether the embedded content will automatically play as soon as it loaded.

Further documentation.

Since:

V4.4

isShowControls

boolean isShowControls()

Returns whether the browser will offer controls to allow the user to control the multimedia playback.

Further documentation.

Since:

V5.12

setShowControls

void setShowControls(boolean controls)

Sets whether the browser will offer controls to allow the user to control the multimedia playback.

Further documentation.

Since:

V4.4

isLoop

boolean isLoop()

Returns whether the multimedia player will automatically restart upon reaching the end of the content.

Further documentation.

Since:

V5.12

setLoop

void setLoop(boolean loop)

Sets whether the multimedia player will automatically restart upon reaching the end of the content.

Further documentation.

Since:

V5.12

isMuted

boolean isMuted()

Returns whether the multimedia player will initially be silenced.

Further documentation.

Since:

V5.12

setMuted

void setMuted(boolean loop)

Sets whether the multimedia player will initially be silenced.

Further documentation.

Since:

V5.12

getWidth

java.lang.String getWidth()

multimedia player width. See setWidth(String) for details of supported values when setting this property.

Since:

V5.12

setWidth

void setWidth(java.lang.String imageWidth)

Sets the multimedia player width.

Any valid value for the CSS width property can be specified e.g. 300px

Since:

V5.12

getHeight

java.lang.String getHeight()

multimedia player height. See setHeight(String) for details of supported values when setting this property.

Since:

V5.12

setHeight

void setHeight(java.lang.String imageHeight)

Sets the multimedia player height.

Any valid value for the CSS height property can be specified e.g. 300px

Since:

V5.12