AudioFrame (Aspose.Slides for Java (25.10) API Documentation)

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.

  The following examples shows how to change Audio Play Options.
   Presentation pres = new Presentation("AudioFrameEmbed_out.pptx");
 try {
     // Gets the AudioFrame shape
     AudioFrame audioFrame = (AudioFrame)pres.getSlides().get_Item(0).getShapes().get_Item(0);
     // Sets the Play mode to play on click
     audioFrame.setPlayMode(AudioPlayModePreset.OnClick);
     // Sets the volume to Low
     audioFrame.setVolume(AudioVolumeMode.Low);
     // Sets the audio to play across slides
     audioFrame.setPlayAcrossSlides(true);
     // Disables loop for the audio
     audioFrame.setPlayLoopMode(false);
     // Hides the AudioFrame during the slide show
     audioFrame.setHideAtShowing(true);
     // Rewinds the audio to start after playing
     audioFrame.setRewindAudio(true);
     // Saves the PowerPoint file to disk
     pres.save("AudioFrameEmbed_changed.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Method Summary

All Methods Instance Methods Concrete Methods
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.
`ICaptionsCollection`	`getCaptionTracks()` Gets the collection of closed captions associated with the audio frame.
`boolean`	`getEmbedded()` Determines whether a sound is embedded to a presentation.
`IAudio`	`getEmbeddedAudio()` Returns or sets embedded audio object.
`float`	`getFadeInDuration()` Specifies the time duration for the initial fade-in of the media in milliseconds.
`float`	`getFadeOutDuration()` Specifies the time duration for the ending fade-out of the media in milliseconds.
`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.
`float`	`getTrimFromEnd()` Specifies the time duration to be removed from the end of the media during playback, in milliseconds.
`float`	`getTrimFromStart()` Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds.
`int`	`getVolume()` Returns or sets the audio volume.
`float`	`getVolumeValue()` Returns or sets the audio volume in percents.
`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`	`setFadeInDuration(float value)` Specifies the time duration for the initial fade-in of the media in milliseconds.
`void`	`setFadeOutDuration(float value)` Specifies the time duration for the ending fade-out of the media in milliseconds.
`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`	`setTrimFromEnd(float value)` Specifies the time duration to be removed from the end of the media during playback, in milliseconds.
`void`	`setTrimFromStart(float value)` Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds.
`void`	`setVolume(int value)` Returns or sets the audio volume.
`void`	`setVolumeValue(float value)` Returns or sets the audio volume in percents.

Methods inherited from class com.aspose.slides.PictureFrame
getPictureFormat, getPictureFrameLock, getRelativeScaleHeight, getRelativeScaleWidth, getShapeType, isCameo, 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, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParent_Immediate, getParentGroup, getPlaceholder, getPresentation, getRawFrame, getRotation, getShapeLock, getSlide, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, 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.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

getFadeInDuration

public final float getFadeInDuration()

Specifies the time duration for the initial fade-in of the media in milliseconds. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the duration of the starting fade for 200ms
     audioFrame.setFadeInDuration(200f);
     pres.save("AudioFrameFade_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getFadeInDuration in interface IAudioFrame

setFadeInDuration

public final void setFadeInDuration(float value)

Specifies the time duration for the initial fade-in of the media in milliseconds. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the duration of the starting fade for 200ms
     audioFrame.setFadeInDuration(200f);
     pres.save("AudioFrameFade_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: setFadeInDuration in interface IAudioFrame

getFadeOutDuration

public final float getFadeOutDuration()

Specifies the time duration for the ending fade-out of the media in milliseconds. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the duration of the ending fade for 500ms
     audioFrame.setFadeOutDuration(500f);
     pres.save("AudioFrameFade_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getFadeOutDuration in interface IAudioFrame

setFadeOutDuration

public final void setFadeOutDuration(float value)

Specifies the time duration for the ending fade-out of the media in milliseconds. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the duration of the ending fade for 500ms
     audioFrame.setFadeOutDuration(500f);
     pres.save("AudioFrameFade_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: setFadeOutDuration in interface IAudioFrame

getVolumeValue

public final float getVolumeValue()

Returns or sets the audio volume in percents. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the audio volume for 85%
     audioFrame.setVolumeValue(85f);
     pres.save("AudioFrameValue_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getVolumeValue in interface IAudioFrame

setVolumeValue

public final void setVolumeValue(float value)

Returns or sets the audio volume in percents. Read/write float.

Example:
   Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the audio volume for 85%
     audioFrame.setVolumeValue(85f);
     pres.save("AudioFrameValue_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: setVolumeValue in interface IAudioFrame

getTrimFromStart

public final float getTrimFromStart()

Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds. Read/write float.

Example:
  Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the start trimming time 1.5 seconds
     audioFrame.setTrimFromStart(1500f);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getTrimFromStart in interface IAudioFrame

setTrimFromStart

public final void setTrimFromStart(float value)

Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds. Read/write float.

Example:
  Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the start trimming time 1.5 seconds
     audioFrame.setTrimFromStart(1500f);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: setTrimFromStart in interface IAudioFrame

getTrimFromEnd

public final float getTrimFromEnd()

Specifies the time duration to be removed from the end of the media during playback, in milliseconds. Read/write float.

Example:
  Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the end trimming time 2 seconds
     audioFrame.setTrimFromEnd(2000f);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getTrimFromEnd in interface IAudioFrame

setTrimFromEnd

public final void setTrimFromEnd(float value)

Specifies the time duration to be removed from the end of the media during playback, in milliseconds. Read/write float.

Example:
  Presentation pres = new Presentation();
 try {
     FileInputStream audioStream = new FileInputStream("sampleaudio.mp3");
     IAudio audio = pres.getAudios().addAudio(audioStream, LoadingStreamBehavior.ReadStreamAndRelease);
     IAudioFrame audioFrame = pres.getSlides().get_Item(0).getShapes().addAudioFrameEmbedded(50, 50, 100, 100, audio);
     // Set the end trimming time 2 seconds
     audioFrame.setTrimFromEnd(2000f);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: setTrimFromEnd in interface IAudioFrame

getCaptionTracks

public final ICaptionsCollection getCaptionTracks()

Gets the collection of closed captions associated with the audio frame. This property is read-only and returns an ICaptionsCollection containing all caption tracks.

Example:
  Presentation pres = new Presentation("audio with captions.pptx");
 try {
     for (IShape shape : pres.getSlides().get_Item(0).getShapes())
     {
         if (shape instanceof IAudioFrame)
         {
             IAudioFrame audioFrame = (IAudioFrame) shape;
             // Save the caption track's binary data as a .vtt file
             for (ICaptions captionTrack : audioFrame.getCaptionTracks()) {
                 FileOutputStream fos = new FileOutputStream(captionTrack.getCaptionId() + ".vtt");
                 fos.write(captionTrack.getBinaryData());
                 fos.close();
             }
         }
     }
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getCaptionTracks in interface IAudioFrame

Class AudioFrame

Method Summary

Methods inherited from class com.aspose.slides.PictureFrame

Methods inherited from class com.aspose.slides.GeometryShape

Methods inherited from class com.aspose.slides.Shape

Methods inherited from class java.lang.Object

Methods inherited from interface com.aspose.slides.IPictureFrame

Methods inherited from interface com.aspose.slides.IGeometryShape

Methods inherited from interface com.aspose.slides.IShape

Methods inherited from interface com.aspose.slides.ISlideComponent

Methods inherited from interface com.aspose.slides.IPresentationComponent

Methods inherited from interface com.aspose.slides.IHyperlinkContainer

Method Detail

getAudioCdStartTrack

setAudioCdStartTrack

getAudioCdStartTrackTime

setAudioCdStartTrackTime

getAudioCdEndTrack

setAudioCdEndTrack

getAudioCdEndTrackTime

setAudioCdEndTrackTime

getVolume

setVolume

getPlayMode

setPlayMode

getHideAtShowing

setHideAtShowing

getPlayLoopMode

setPlayLoopMode