com.spire.presentation
Interface IAudio

All Superinterfaces:

IShape

public interface IAudio
extends IShape

Method Summary

void	dispose() Dispose object and free resources.
ShapeAdjustCollection	getAdjustments() Gets a collection of shape's adjustment values.
java.lang.String	getAlternativeText() Gets the alternative text associated with a shape.
AudioCD	getAudioCd() Gets setting of CD.
ClickHyperlink	getClick() Gets or sets the hyperlink defined for mouse click.
IAudioData	getData() Gets or sets embedded audio data.
EffectDag	getEffectDag() Gets the EffectFormat object which contains pixel effects applied to a shape.
java.lang.String	getFileName() Gets the name of an audio file.
FillFormat	getFill() Gets the FillFormat object that contains fill formatting properties for a shape.
GraphicFrame	getFrame() Gets the shape frame's properties.
float	getHeight() Gets the height of the shape.
float	getLeft() Gets the x-coordinate of the upper-left corner of the shape.
TextLineFormat	getLine() Gets the LineFormat object that contains line formatting properties for a shape.
ClickHyperlink	getMouseOver() Gets the hyperlink defined for mouse over.
java.lang.String	getName() Gets the name of a shape.
ActiveSlide	getParent() Gets the parent slide of a shape.
PictureFillFormat	getPictureFill() Gets the PictureFillFormat object.
PlaceholderEx	getPlaceholder() Gets the placeholder for a shape.
AudioPlayMode	getPlayMode() Gets the audio play mode.
Presentation	getPresentation()
float	getRotation() Gets the number of degrees the specified shape is rotated around the z-axis.
PictureFrameLockEx	getShapeLocking() Gets shape's locks.
ShapeStyleEx	getShapeStyle() Gets shape's style object.
ShapeType	getShapeType() Gets the AutoShape type.
ActiveSlide	getSlide() Gets the parent slide of a shape.
TagCollection	getTagsList() Gets the shape's tags collection.
FormatThreeD	getThreeD() Gets the ThreeDFormat object that 3d effect properties for a shape.
float	getTop() Gets the y-coordinate of the upper-left corner of the shape.
AudioVolumeType	getVolume() Gets the audio volume.
float	getWidth() Gets the width of the shape.
int	getZOrderPosition() Gets the position of a shape in the z-order.
boolean	isEmbedded() Indicates whether a sound is embedded to a presentation.
boolean	isHidden() Indicates whether the shape is hidden.
void	isHidden(boolean value)
boolean	isLoop() Indicates whether an audio is looped.
void	isLoop(boolean value)
boolean	isPlayInBackground() Whether the audio plays in the background.
void	isPlayInBackground(boolean isPlayInBackground)
boolean	isTextBox() Indicates whether the shape is TextHolder.
void	removePlaceholder() Removes placeholder from the shape.
void	setAlternativeText(java.lang.String value) Sets the alternative text associated with a shape.
void	setClick(ClickHyperlink value) Sets the hyperlink defined for mouse click.
void	setData(IAudioData value) Sets embedded audio data.
void	setFileName(java.lang.String value) Sets the name of an audio file.
void	setFrame(GraphicFrame value) Sets the shape frame's properties.
void	setHeight(float value) Sets the height of the shape.
void	setLeft(double value) Sets the x-coordinate of the upper-left corner of the shape.
void	setMouseOver(ClickHyperlink value) Sets the hyperlink defined for mouse over.
void	setName(java.lang.String value) Sets the name of a shape.
void	setPlayMode(AudioPlayMode value) Sets the audio play mode.
void	setRotation(float value) Sets the number of degrees the specified shape is rotated around the z-axis.
void	setShapeType(ShapeType value) Sets the AutoShape type.
void	setTop(double value) Sets the y-coordinate of the upper-left corner of the shape.
void	setVolume(AudioVolumeType value) sets the audio volume.
void	setWidth(float value) Sets the width of the shape.

Methods inherited from interface com.spire.presentation.IShape

getAlternativeTitle, insertChart, insertPicture, insertSmartArt, insertTable, insertVideo, setAlternativeTitle, setShapeAlignment, setShapeArrange

Method Detail

getVolume

AudioVolumeType getVolume()

Gets the audio volume. Read/write .

Returns:

setVolume

void setVolume(AudioVolumeType value)

sets the audio volume. Read/write .

getPlayMode

AudioPlayMode getPlayMode()

Gets the audio play mode. Read/write .

Returns:

setPlayMode

void setPlayMode(AudioPlayMode value)
                 throws AppException

Sets the audio play mode. Read/write .

Throws:

AppException

isLoop

boolean isLoop()

Indicates whether an audio is looped. Read/write .

Returns:

isLoop

void isLoop(boolean value)

isEmbedded

boolean isEmbedded()

Indicates whether a sound is embedded to a presentation. Read-only .

Returns:

getFileName

java.lang.String getFileName()

Gets the name of an audio file. Read/write .

Returns:

setFileName

void setFileName(java.lang.String value)

Sets the name of an audio file. Read/write .

getData

IAudioData getData()

Gets or sets embedded audio data. Read/write .

Returns:

setData

void setData(IAudioData value)
             throws DocumentEditException

Sets embedded audio data. Read/write .

Throws:

DocumentEditException

getAudioCd

AudioCD getAudioCd()

Gets setting of CD.

Returns:

getShapeLocking

PictureFrameLockEx getShapeLocking()

Gets shape's locks. Readonly .

Returns:

getShapeType

ShapeType getShapeType()

Gets the AutoShape type.

Returns:

setShapeType

void setShapeType(ShapeType value)

Sets the AutoShape type.

getPictureFill

PictureFillFormat getPictureFill()

Gets the PictureFillFormat object. Read-only .

Returns:

getShapeStyle

ShapeStyleEx getShapeStyle()

Gets shape's style object. Read-only .

Returns:

getAdjustments

ShapeAdjustCollection getAdjustments()

Gets a collection of shape's adjustment values. Readonly .

Returns:

isTextBox

boolean isTextBox()

Indicates whether the shape is TextHolder. Read-only .

Specified by:

isTextBox in interface IShape

Returns:

getPlaceholder

PlaceholderEx getPlaceholder()

Gets the placeholder for a shape. Read-only .

Specified by:

getPlaceholder in interface IShape

Returns:

getTagsList

TagCollection getTagsList()

Gets the shape's tags collection. Read-only .

Specified by:

getTagsList in interface IShape

Returns:

getFrame

GraphicFrame getFrame()

Gets the shape frame's properties. Read/write .

Specified by:

getFrame in interface IShape

Returns:

setFrame

void setFrame(GraphicFrame value)

Sets the shape frame's properties. Read/write .

Specified by:

setFrame in interface IShape

getLine

TextLineFormat getLine()

Gets the LineFormat object that contains line formatting properties for a shape. can return null for certain types of shapes which don't have line properties. Read-only .

Specified by:

getLine in interface IShape

Returns:

getThreeD

FormatThreeD getThreeD()

Gets the ThreeDFormat object that 3d effect properties for a shape. can return null for certain types of shapes which don't have 3d properties. Read-only .

Specified by:

getThreeD in interface IShape

Returns:

getEffectDag

EffectDag getEffectDag()

Gets the EffectFormat object which contains pixel effects applied to a shape. can return null for certain types of shapes which don't have effect properties. Read-only

Specified by:

getEffectDag in interface IShape

Returns:

getFill

FillFormat getFill()

Gets the FillFormat object that contains fill formatting properties for a shape. can return null for certain types of shapes which don't have fill properties. Read-only .

Specified by:

getFill in interface IShape

Returns:

getClick

ClickHyperlink getClick()

Gets or sets the hyperlink defined for mouse click. Read/write .

Specified by:

getClick in interface IShape

Returns:

setClick

void setClick(ClickHyperlink value)

Sets the hyperlink defined for mouse click. Read/write .

Specified by:

setClick in interface IShape

getMouseOver

ClickHyperlink getMouseOver()

Gets the hyperlink defined for mouse over. Read/write .

Specified by:

getMouseOver in interface IShape

Returns:

setMouseOver

void setMouseOver(ClickHyperlink value)

Sets the hyperlink defined for mouse over. Read/write .

Specified by:

setMouseOver in interface IShape

isHidden

boolean isHidden()

Indicates whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Returns:

isHidden

void isHidden(boolean value)

Specified by:

isHidden in interface IShape

isPlayInBackground

boolean isPlayInBackground()

Whether the audio plays in the background. Read/write .

Returns:

isPlayInBackground

void isPlayInBackground(boolean isPlayInBackground)

getParent

ActiveSlide getParent()

Gets the parent slide of a shape. Read-only .

Specified by:

getParent in interface IShape

Returns:

getZOrderPosition

int getZOrderPosition()

Gets the position of a shape in the z-order. Read-only .

Specified by:

getZOrderPosition in interface IShape

Returns:

Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.

getRotation

float getRotation()

Gets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

getRotation in interface IShape

Returns:

setRotation

void setRotation(float value)

Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

setRotation in interface IShape

getLeft

float getLeft()

Gets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getLeft in interface IShape

Returns:

setLeft

void setLeft(double value)

Sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setLeft in interface IShape

getTop

float getTop()

Gets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getTop in interface IShape

Returns:

setTop

void setTop(double value)

Sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setTop in interface IShape

getWidth

float getWidth()

Gets the width of the shape. Read/write .

Specified by:

getWidth in interface IShape

Returns:

setWidth

void setWidth(float value)

Sets the width of the shape. Read/write .

Specified by:

setWidth in interface IShape

getHeight

float getHeight()

Gets the height of the shape. Read/write .

Specified by:

getHeight in interface IShape

Returns:

setHeight

void setHeight(float value)

Sets the height of the shape. Read/write .

Specified by:

setHeight in interface IShape

getAlternativeText

java.lang.String getAlternativeText()

Gets the alternative text associated with a shape. Read/write .

Specified by:

getAlternativeText in interface IShape

Returns:

setAlternativeText

void setAlternativeText(java.lang.String value)

Sets the alternative text associated with a shape. Read/write .

Specified by:

setAlternativeText in interface IShape

getName

java.lang.String getName()

Gets the name of a shape. Read/write .

Specified by:

getName in interface IShape

Returns:

setName

void setName(java.lang.String value)

Sets the name of a shape. Read/write .

Specified by:

setName in interface IShape

getSlide

ActiveSlide getSlide()

Gets the parent slide of a shape. Read-only .

Specified by:

getSlide in interface IShape

Returns:

getPresentation

Presentation getPresentation()

Specified by:

getPresentation in interface IShape

removePlaceholder

void removePlaceholder()

Removes placeholder from the shape.

Specified by:

removePlaceholder in interface IShape

dispose

void dispose()

Dispose object and free resources.

Specified by:

dispose in interface IShape