com.aspose.slides

Interface IAudioFrame

All Superinterfaces:

IGeometryShape, IHyperlinkContainer, IPictureFrame, IPresentationComponent, IShape, ISlideComponent

All Known Implementing Classes:

AudioFrame

public interface IAudioFrame
extends IPictureFrame

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.
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 an 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 an 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 an 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 an 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 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, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getShapeLock, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, 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

int getAudioCdStartTrack()

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

setAudioCdStartTrack

void setAudioCdStartTrack(int value)

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

getAudioCdStartTrackTime

int getAudioCdStartTrackTime()

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

setAudioCdStartTrackTime

void setAudioCdStartTrackTime(int value)

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

getAudioCdEndTrack

int getAudioCdEndTrack()

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

setAudioCdEndTrack

void setAudioCdEndTrack(int value)

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

getAudioCdEndTrackTime

int getAudioCdEndTrackTime()

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

setAudioCdEndTrackTime

void setAudioCdEndTrackTime(int value)

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

getVolume

int getVolume()

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

setVolume

void setVolume(int value)

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

getPlayMode

int getPlayMode()

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

setPlayMode

void setPlayMode(int value)

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

getHideAtShowing

boolean getHideAtShowing()

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

setHideAtShowing

void setHideAtShowing(boolean value)

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

getPlayLoopMode

boolean getPlayLoopMode()

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

setPlayLoopMode

void setPlayLoopMode(boolean value)

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

getPlayAcrossSlides

boolean getPlayAcrossSlides()

Determines whether an 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();
  }
  
  

setPlayAcrossSlides

void setPlayAcrossSlides(boolean value)

Determines whether an 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();
  }
  
  

getRewindAudio

boolean getRewindAudio()

Determines whether an 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();
  }
  
  

setRewindAudio

void setRewindAudio(boolean value)

Determines whether an 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();
  }
  
  

getEmbedded

boolean getEmbedded()

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

getLinkPathLong

java.lang.String getLinkPathLong()

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

setLinkPathLong

void setLinkPathLong(java.lang.String value)

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

getEmbeddedAudio

IAudio getEmbeddedAudio()

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

setEmbeddedAudio

void setEmbeddedAudio(IAudio value)

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

getFadeInDuration

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();
 }
  
  

setFadeInDuration

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();
 }
  
  

getFadeOutDuration

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();
 }
  
  

setFadeOutDuration

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();
 }
  
  

getVolumeValue

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();
 }
  
  

setVolumeValue

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();
 }
  
  

getTrimFromStart

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();
 }
 
 

setTrimFromStart

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();
 }
 
 

getTrimFromEnd

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();
 }
 
 

setTrimFromEnd

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();
 }
 
 

getCaptionTracks

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();
 }