com.aspose.slides

Class VideoFrame

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GeometryShape

com.aspose.slides.PictureFrame

com.aspose.slides.VideoFrame

All Implemented Interfaces:

IGeometryShape, IHyperlinkContainer, IPictureFrame, IPresentationComponent, IShape, ISlideComponent, IVideoFrame

public class VideoFrame
extends PictureFrame
implements IVideoFrame

Represents a video clip on a slide.

Method Summary

Modifier and Type	Method and Description
ICaptionsCollection	getCaptionTracks() Gets the collection of closed captions associated with the video frame.
IVideo	getEmbeddedVideo() Returns or sets embedded video object.
boolean	getFullScreenMode() Determines whether a video is shown in full screen mode.
boolean	getHideAtShowing() Determines whether a VideoFrame is hidden.
java.lang.String	getLinkPathLong() Returns or sets the name of an video file which is linked to a VideoFrame.
boolean	getPlayLoopMode() Determines whether a video is looped.
int	getPlayMode() Returns or sets the video play mode.
boolean	getRewindVideo() Determines whether a video is automatically rewinded to start as soon as the movie has finished playing.
float	getTrimFromEnd() Trim end [ms]
float	getTrimFromStart() Trim start [ms]
int	getVolume() Returns or sets the audio volume.
void	setEmbeddedVideo(IVideo value) Returns or sets embedded video object.
void	setFullScreenMode(boolean value) Determines whether a video is shown in full screen mode.
void	setHideAtShowing(boolean value) Determines whether a VideoFrame is hidden.
void	setLinkPathLong(java.lang.String value) Returns or sets the name of an video file which is linked to a VideoFrame.
void	setPlayLoopMode(boolean value) Determines whether a video is looped.
void	setPlayMode(int value) Returns or sets the video play mode.
void	setRewindVideo(boolean value) Determines whether a video is automatically rewinded to start as soon as the movie has finished playing.
void	setTrimFromEnd(float value) Trim end [ms]
void	setTrimFromStart(float value) Trim start [ms]
void	setVolume(int value) Returns or sets the audio volume.

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.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

getRewindVideo

public final boolean getRewindVideo()

Determines whether a video is automatically rewinded to start as soon as the movie has finished playing. Read/write boolean.

Specified by:

getRewindVideo in interface IVideoFrame

setRewindVideo

public final void setRewindVideo(boolean value)

Determines whether a video is automatically rewinded to start as soon as the movie has finished playing. Read/write boolean.

Specified by:

setRewindVideo in interface IVideoFrame

getPlayLoopMode

public final boolean getPlayLoopMode()

Determines whether a video is looped. Read/write boolean.

Specified by:

getPlayLoopMode in interface IVideoFrame

setPlayLoopMode

public final void setPlayLoopMode(boolean value)

Determines whether a video is looped. Read/write boolean.

Specified by:

setPlayLoopMode in interface IVideoFrame

getHideAtShowing

public final boolean getHideAtShowing()

Determines whether a VideoFrame is hidden. Read/write boolean.

Specified by:

getHideAtShowing in interface IVideoFrame

setHideAtShowing

public final void setHideAtShowing(boolean value)

Determines whether a VideoFrame is hidden. Read/write boolean.

Specified by:

setHideAtShowing in interface IVideoFrame

getVolume

public final int getVolume()

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

Specified by:

getVolume in interface IVideoFrame

setVolume

public final void setVolume(int value)

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

Specified by:

setVolume in interface IVideoFrame

getPlayMode

public final int getPlayMode()

Returns or sets the video play mode. Read/write VideoPlayModePreset.

Specified by:

getPlayMode in interface IVideoFrame

setPlayMode

public final void setPlayMode(int value)

Returns or sets the video play mode. Read/write VideoPlayModePreset.

Specified by:

setPlayMode in interface IVideoFrame

getFullScreenMode

public final boolean getFullScreenMode()

Determines whether a video is shown in full screen mode. Read/write boolean.

Specified by:

getFullScreenMode in interface IVideoFrame

setFullScreenMode

public final void setFullScreenMode(boolean value)

Determines whether a video is shown in full screen mode. Read/write boolean.

Specified by:

setFullScreenMode in interface IVideoFrame

getLinkPathLong

public final java.lang.String getLinkPathLong()

Returns or sets the name of an video file which is linked to a VideoFrame. Read/write String.

Specified by:

getLinkPathLong in interface IVideoFrame

setLinkPathLong

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

Returns or sets the name of an video file which is linked to a VideoFrame. Read/write String.

Specified by:

setLinkPathLong in interface IVideoFrame

getEmbeddedVideo

public final IVideo getEmbeddedVideo()

Returns or sets embedded video object. Read/write IVideo.

Specified by:

getEmbeddedVideo in interface IVideoFrame

setEmbeddedVideo

public final void setEmbeddedVideo(IVideo value)

Returns or sets embedded video object. Read/write IVideo.

Specified by:

setEmbeddedVideo in interface IVideoFrame

getTrimFromStart

public final float getTrimFromStart()

Trim start [ms]

Example:
 
 Presentation pres = new Presentation();
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     IVideo video = pres.getVideos().addVideo(Files.readAllBytes(Paths.get("video.mp4")));
     IVideoFrame videoFrame = slide.getShapes().addVideoFrame(0, 0, 100, 100, video);
     //set triming start time 1sec
     videoFrame.setTrimFromStart(1000f);
     //set triming end time 2sec
     videoFrame.setTrimFromEnd(2000f);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getTrimFromStart in interface IVideoFrame

setTrimFromStart

public final void setTrimFromStart(float value)

Trim start [ms]

Example:
 
 Presentation pres = new Presentation();
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     IVideo video = pres.getVideos().addVideo(Files.readAllBytes(Paths.get("video.mp4")));
     IVideoFrame videoFrame = slide.getShapes().addVideoFrame(0, 0, 100, 100, video);
     //set triming start time 1sec
     videoFrame.setTrimFromStart(1000f);
     //set triming end time 2sec
     videoFrame.setTrimFromEnd(2000f);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setTrimFromStart in interface IVideoFrame

getTrimFromEnd

public final float getTrimFromEnd()

Trim end [ms]

Specified by:

getTrimFromEnd in interface IVideoFrame

setTrimFromEnd

public final void setTrimFromEnd(float value)

Trim end [ms]

Specified by:

setTrimFromEnd in interface IVideoFrame

getCaptionTracks

public final ICaptionsCollection getCaptionTracks()

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

Example:
  
 Presentation pres = new Presentation("video with captions.pptx");
 try {
     for (IShape shape : pres.getSlides().get_Item(0).getShapes())
     {
         if (!(shape instanceof IVideoFrame))
             continue;
         IVideoFrame videoFrame = (IVideoFrame) shape;
         for (ICaptions captionTrack : videoFrame.getCaptionTracks())
         {
             // Extracts the captions binary data and saves them to the file
             FileOutputStream fos = new FileOutputStream(captionTrack.getCaptionId() + ".vtt");
             fos.write(captionTrack.getBinaryData());
             fos.close();
         }
     }
 } finally {
     if (pres != null) pres.dispose();
 }
  
  

Specified by:

getCaptionTracks in interface IVideoFrame