com.aspose.slides

Class AudioFrame

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GeometryShape

com.aspose.slides.PictureFrame

com.aspose.slides.AudioFrame

All Implemented Interfaces:

IAudioFrame, IGeometryShape, IHyperlinkContainer, IPictureFrame, IPresentationComponent, IShape, ISlideComponent

public class AudioFrame
extends PictureFrame
implements IAudioFrame

Represents an audio clip on a slide.

Method Summary

Modifier and Type	Method and Description
int	getAudioCdEndTrack() Returns or sets a last track index Read/write int.
int	getAudioCdEndTrackTime() Returns or sets a last track time.
int	getAudioCdStartTrack() Returns or sets a start track index.
int	getAudioCdStartTrackTime() Returns or sets a start track time.
boolean	getEmbedded() Determines whether a sound is embedded to a presentation.
IAudio	getEmbeddedAudio() Returns or sets embedded audio object.
boolean	getHideAtShowing() Determines whether an AudioFrame is hidden.
java.lang.String	getLinkPathLong() Returns or sets the name of an audio file which is linked to an AudioFrame.
boolean	getPlayAcrossSlides() Determines whether audio is playing across the slides.
boolean	getPlayLoopMode() Determines whether an audio is looped.
int	getPlayMode() Returns or sets the audio play mode.
boolean	getRewindAudio() Determines whether audio is automatically rewinded to start after playing.
int	getVolume() Returns or sets the audio volume.
void	setAudioCdEndTrack(int value) Returns or sets a last track index Read/write int.
void	setAudioCdEndTrackTime(int value) Returns or sets a last track time.
void	setAudioCdStartTrack(int value) Returns or sets a start track index.
void	setAudioCdStartTrackTime(int value) Returns or sets a start track time.
void	setEmbeddedAudio(IAudio value) Returns or sets embedded audio object.
void	setHideAtShowing(boolean value) Determines whether an AudioFrame is hidden.
void	setLinkPathLong(java.lang.String value) Returns or sets the name of an audio file which is linked to an AudioFrame.
void	setPlayAcrossSlides(boolean value) Determines whether audio is playing across the slides.
void	setPlayLoopMode(boolean value) Determines whether an audio is looped.
void	setPlayMode(int value) Returns or sets the audio play mode.
void	setRewindAudio(boolean value) Determines whether audio is automatically rewinded to start after playing.
void	setVolume(int value) Returns or sets the audio volume.

Methods inherited from class com.aspose.slides.PictureFrame

getPictureFormat, getPictureFrameLock, getRelativeScaleHeight, getRelativeScaleWidth, getShapeType, setRelativeScaleHeight, setRelativeScaleWidth, setShapeType

Methods inherited from class com.aspose.slides.GeometryShape

createShapeElements, getAdjustments, getGeometryPaths, getShapeStyle, setGeometryPath, setGeometryPaths

Methods inherited from class com.aspose.slides.Shape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, getLineFormat, getName, getOfficeInteropShapeId, getParent_Immediate, getParentGroup, getPlaceholder, getPresentation, getRawFrame, getRotation, getShapeLock, getSlide, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setFrame, setHeight, setHidden, setHyperlinkClick, setHyperlinkMouseOver, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.slides.IPictureFrame

getPictureFormat, getPictureFrameLock, getRelativeScaleHeight, getRelativeScaleWidth, setRelativeScaleHeight, setRelativeScaleWidth

Methods inherited from interface com.aspose.slides.IGeometryShape

createShapeElements, getAdjustments, getGeometryPaths, getShapeStyle, getShapeType, setGeometryPath, setGeometryPaths, setShapeType

Methods inherited from interface com.aspose.slides.IShape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getShapeLock, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setFrame, setHeight, setHidden, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from interface com.aspose.slides.ISlideComponent

getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent

getPresentation

Methods inherited from interface com.aspose.slides.IHyperlinkContainer

getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, setHyperlinkClick, setHyperlinkMouseOver

Method Detail

getAudioCdStartTrack

public final int getAudioCdStartTrack()

Returns or sets a start track index. Read/write int.

Specified by:

getAudioCdStartTrack in interface IAudioFrame

setAudioCdStartTrack

public final void setAudioCdStartTrack(int value)

Returns or sets a start track index. Read/write int.

Specified by:

setAudioCdStartTrack in interface IAudioFrame

getAudioCdStartTrackTime

public final int getAudioCdStartTrackTime()

Returns or sets a start track time. Read/write int.

Specified by:

getAudioCdStartTrackTime in interface IAudioFrame

setAudioCdStartTrackTime

public final void setAudioCdStartTrackTime(int value)

Returns or sets a start track time. Read/write int.

Specified by:

setAudioCdStartTrackTime in interface IAudioFrame

getAudioCdEndTrack

public final int getAudioCdEndTrack()

Returns or sets a last track index Read/write int.

Specified by:

getAudioCdEndTrack in interface IAudioFrame

setAudioCdEndTrack

public final void setAudioCdEndTrack(int value)

Returns or sets a last track index Read/write int.

Specified by:

setAudioCdEndTrack in interface IAudioFrame

getAudioCdEndTrackTime

public final int getAudioCdEndTrackTime()

Returns or sets a last track time. Read/write int.

Specified by:

getAudioCdEndTrackTime in interface IAudioFrame

setAudioCdEndTrackTime

public final void setAudioCdEndTrackTime(int value)

Returns or sets a last track time. Read/write int.

Specified by:

setAudioCdEndTrackTime in interface IAudioFrame

getVolume

public final int getVolume()

Returns or sets the audio volume. Read/write AudioVolumeMode.

Specified by:

getVolume in interface IAudioFrame

setVolume

public final void setVolume(int value)

Returns or sets the audio volume. Read/write AudioVolumeMode.

Specified by:

setVolume in interface IAudioFrame

getPlayMode

public final int getPlayMode()

Returns or sets the audio play mode. Read/write AudioPlayModePreset.

Specified by:

getPlayMode in interface IAudioFrame

setPlayMode

public final void setPlayMode(int value)

Returns or sets the audio play mode. Read/write AudioPlayModePreset.

Specified by:

setPlayMode in interface IAudioFrame

getHideAtShowing

public final boolean getHideAtShowing()

Determines whether an AudioFrame is hidden. Read/write boolean.

Specified by:

getHideAtShowing in interface IAudioFrame

setHideAtShowing

public final void setHideAtShowing(boolean value)

Determines whether an AudioFrame is hidden. Read/write boolean.

Specified by:

setHideAtShowing in interface IAudioFrame

getPlayLoopMode

public final boolean getPlayLoopMode()

Determines whether an audio is looped. Read/write boolean.

Specified by:

getPlayLoopMode in interface IAudioFrame

setPlayLoopMode

public final void setPlayLoopMode(boolean value)

Determines whether an audio is looped. Read/write boolean.

Specified by:

setPlayLoopMode in interface IAudioFrame

getPlayAcrossSlides

public final boolean getPlayAcrossSlides()

Determines whether audio is playing across the slides. Read/write boolean.

  
  Presentation pres = new Presentation();
  try {
      ISlide slide = pres.getSlides().get_Item(0);
      // Add Audio Frame
      IAudioFrame audioFrame = slide.getShapes().addAudioFrameLinked(50, 50, 100, 100, "sampleaudio.wav");
      // Set Audio to play across the slides
      audioFrame.setPlayAcrossSlides(true);
      // Set Audio to automatically rewind to start after playing
      audioFrame.setRewindAudio(true);
      pres.save("AudioFrame_out.pptx", SaveFormat.Pptx);
  } finally {
      if (pres != null) pres.dispose();
  }
  
  

Specified by:

getPlayAcrossSlides in interface IAudioFrame

setPlayAcrossSlides

public final void setPlayAcrossSlides(boolean value)

Determines whether audio is playing across the slides. Read/write boolean.

  
  Presentation pres = new Presentation();
  try {
      ISlide slide = pres.getSlides().get_Item(0);
      // Add Audio Frame
      IAudioFrame audioFrame = slide.getShapes().addAudioFrameLinked(50, 50, 100, 100, "sampleaudio.wav");
      // Set Audio to play across the slides
      audioFrame.setPlayAcrossSlides(true);
      // Set Audio to automatically rewind to start after playing
      audioFrame.setRewindAudio(true);
      pres.save("AudioFrame_out.pptx", SaveFormat.Pptx);
  } finally {
      if (pres != null) pres.dispose();
  }
  
  

Specified by:

setPlayAcrossSlides in interface IAudioFrame

getRewindAudio

public final boolean getRewindAudio()

Determines whether audio is automatically rewinded to start after playing. Read/write boolean.

  
  Presentation pres = new Presentation();
  try {
      ISlide slide = pres.getSlides().get_Item(0);
      // Add Audio Frame
      IAudioFrame audioFrame = slide.getShapes().addAudioFrameLinked(50, 50, 100, 100, "sampleaudio.wav");
      // Set Audio to play across the slides
      audioFrame.setPlayAcrossSlides(true);
      // Set Audio to automatically rewind to start after playing
      audioFrame.setRewindAudio(true);
      pres.save("AudioFrame_out.pptx", SaveFormat.Pptx);
  } finally {
      if (pres != null) pres.dispose();
  }
  
  

Specified by:

getRewindAudio in interface IAudioFrame

setRewindAudio

public final void setRewindAudio(boolean value)

Determines whether audio is automatically rewinded to start after playing. Read/write boolean.

  
  Presentation pres = new Presentation();
  try {
      ISlide slide = pres.getSlides().get_Item(0);
      // Add Audio Frame
      IAudioFrame audioFrame = slide.getShapes().addAudioFrameLinked(50, 50, 100, 100, "sampleaudio.wav");
      // Set Audio to play across the slides
      audioFrame.setPlayAcrossSlides(true);
      // Set Audio to automatically rewind to start after playing
      audioFrame.setRewindAudio(true);
      pres.save("AudioFrame_out.pptx", SaveFormat.Pptx);
  } finally {
      if (pres != null) pres.dispose();
  }
  
  

Specified by:

setRewindAudio in interface IAudioFrame

getEmbedded

public final boolean getEmbedded()

Determines whether a sound is embedded to a presentation. Read-only boolean.

Specified by:

getEmbedded in interface IAudioFrame

getLinkPathLong

public final java.lang.String getLinkPathLong()

Returns or sets the name of an audio file which is linked to an AudioFrame. Read/write String.

Specified by:

getLinkPathLong in interface IAudioFrame

setLinkPathLong

public final void setLinkPathLong(java.lang.String value)

Returns or sets the name of an audio file which is linked to an AudioFrame. Read/write String.

Specified by:

setLinkPathLong in interface IAudioFrame

getEmbeddedAudio

public final IAudio getEmbeddedAudio()

Returns or sets embedded audio object. Read/write IAudio.

Specified by:

getEmbeddedAudio in interface IAudioFrame

setEmbeddedAudio

public final void setEmbeddedAudio(IAudio value)

Returns or sets embedded audio object. Read/write IAudio.

Specified by:

setEmbeddedAudio in interface IAudioFrame