com.aspose.slides

Interface IVideoFrame

All Superinterfaces:

IGeometryShape, IHyperlinkContainer, IPictureFrame, IPresentationComponent, IShape, ISlideComponent

All Known Implementing Classes:

VideoFrame

public interface IVideoFrame
extends IPictureFrame

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

boolean getRewindVideo()

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

setRewindVideo

void setRewindVideo(boolean value)

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

getPlayLoopMode

boolean getPlayLoopMode()

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

setPlayLoopMode

void setPlayLoopMode(boolean value)

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

getHideAtShowing

boolean getHideAtShowing()

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

setHideAtShowing

void setHideAtShowing(boolean value)

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

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 video play mode. Read/write VideoPlayModePreset.

setPlayMode

void setPlayMode(int value)

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

getFullScreenMode

boolean getFullScreenMode()

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

setFullScreenMode

void setFullScreenMode(boolean value)

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

getLinkPathLong

java.lang.String getLinkPathLong()

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

setLinkPathLong

void setLinkPathLong(java.lang.String value)

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

getEmbeddedVideo

IVideo getEmbeddedVideo()

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

setEmbeddedVideo

void setEmbeddedVideo(IVideo value)

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

getTrimFromStart

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

setTrimFromStart

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

getTrimFromEnd

float getTrimFromEnd()

Trim end [ms]

setTrimFromEnd

void setTrimFromEnd(float value)

Trim end [ms]

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