com.aspose.slides
Class AudioFrame

java.lang.Object
  extended by com.aspose.slides.Shape
      extended by com.aspose.slides.PictureFrame
          extended by com.aspose.slides.AudioFrame
All Implemented Interfaces:
IPictureFrame, IShape, IShapeFormat

public final class AudioFrame
extends PictureFrame

Represents an AudioFrame.


Method Summary
 byte[] getAudioData()
          Returns embedded audio data.
 java.lang.String getFileName()
          Returns the file from which the media object was created.
 int getSoundLength()
          Returns the length of embedded wav sound in milliseconds.
 boolean isEmbedded()
          Determines whether the sound is embedded to a presentation.
 boolean isLoopUntilStopped()
          Determines whether the sound loops continuously until either the next movie or sound starts, the user clicks the slide, or a slide transition occurs.
 boolean isRewindSound()
          Determines whether the sound is automatically rewinded to start as soon as the sound has finished playing.
 void setFileName(java.lang.String value)
          Sets the file from which the media object was created.
 void setLoopUntilStopped(boolean value)
          Sets whether the sound loops continuously until either the next movie or sound starts, the user clicks the slide, or a slide transition occurs.
 void setRewindSound(boolean value)
          Sets whether the sound is automatically rewinded to start as soon as the sound has finished playing.
 void setSoundLength(int value)
          Sets the length of embedded wav sound in milliseconds.
 
Methods inherited from class com.aspose.slides.PictureFrame
addTextFrame, getBrightness, getColorType, getContrast, getCropBottom, getCropLeft, getCropRight, getCropTop, getPictureFileName, getPictureId, getRecolor, getTransparentColor, isPictureLinked, makeColorTransparent, serialize, setBrightness, setColorType, setContrast, setCropBottom, setCropLeft, setCropRight, setCropTop, setPictureFileName, setPictureId, setTransparentColor
 
Methods inherited from class com.aspose.slides.Shape
addLink, clearLink, createShapeElements, createShapeElements, getAlternativeText, getAnimationSettings, getConnectionSites, getConnectionSitesRaw, getFillFormat, getHeight, getLineFormat, getLink, getMasterShapeId, getName, getParent, getPlaceholder, getProtection, getRotation, getShadowFormat, getShapeId, getShapeRectangle, getTags, getTextFrame, getThreeDFormat, getWidth, getX, getY, getZOrderPosition, hasExternalData, isFlipHorizontal, isFlipVertical, isHidden, isMasterTextHolder, isTextHolder, setAlternativeText, setFlipHorizontal, setFlipVertical, setHeight, setHidden, setName, setProtection, setRotation, setWidth, setX, setY, zOrder
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isEmbedded

public boolean isEmbedded()
Determines whether the sound is embedded to a presentation.


getFileName

public java.lang.String getFileName()
Returns the file from which the media object was created.

Used for linked audio files only.

If the path isn't specified, the current working folder is used.

Returns:
the file from which the media object was created.

setFileName

public void setFileName(java.lang.String value)
Sets the file from which the media object was created.

Used for linked audio files only.

If the path isn't specified, the current working folder is used.

Parameters:
value - the file from which the media object was created.

isLoopUntilStopped

public boolean isLoopUntilStopped()
Determines whether the sound loops continuously until either the next movie or sound starts, the user clicks the slide, or a slide transition occurs.

Returns:
true if the sound loops continuously.

setLoopUntilStopped

public void setLoopUntilStopped(boolean value)
Sets whether the sound loops continuously until either the next movie or sound starts, the user clicks the slide, or a slide transition occurs.

Parameters:
value - true if the sound loops continuously.

getSoundLength

public int getSoundLength()
Returns the length of embedded wav sound in milliseconds.

Returns:
the length of embedded wav sound in milliseconds.

setSoundLength

public void setSoundLength(int value)
Sets the length of embedded wav sound in milliseconds.

Parameters:
value - length of embedded wav sound in milliseconds.

isRewindSound

public boolean isRewindSound()
Determines whether the sound is automatically rewinded to start as soon as the sound has finished playing.

Returns:
true if the sound is automatically rewinded to start.

setRewindSound

public void setRewindSound(boolean value)
Sets whether the sound is automatically rewinded to start as soon as the sound has finished playing.

Parameters:
value - true if the sound is automatically rewinded to start.

getAudioData

public byte[] getAudioData()
Returns embedded audio data.

Used for embedded audio files only.

Returns:
Returns embedded audio data.