VideoFrame

VideoFrame class

Represents a video clip on a slide.

addPlaceholder

Name	Description
addPlaceholder(Placeholder)	Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters:

Name	Type	Description
placeholderToCopyFrom	Placeholder	Placeholder to copy content from.

Result: Placeholder

---

createShapeElements

Name	Description
createShapeElements()	Creates and returns array of shape’s elements.

Result: ShapeElement

---

getAdjustments

Name	Description
getAdjustments()	Returns a collection of shape’s adjustment values. Read-only IAdjustValueCollection.

Result: AdjustValueCollection

---

getAlternativeText

Name	Description
getAlternativeText()	Returns or sets the alternative text associated with a shape. Read/write String.

Result: String

---

getAlternativeTextTitle

Name	Description
getAlternativeTextTitle()	Returns or sets the title of alternative text associated with a shape. Read/write String.

Result: String

---

getBasePlaceholder

Name	Description
getBasePlaceholder()	Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). A null is returned if the current shape is not inherited.

Result: SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector

---

getBlackWhiteMode

Name	Description
getBlackWhiteMode()	Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

Result: byte

---

getConnectionSiteCount

Name	Description
getConnectionSiteCount()	Returns the number of connection sites on the shape. Read-only int.

Result: int

---

getCustomData

Name	Description
getCustomData()	Returns the shape’s custom data. Read-only ICustomData.

Result: CustomData

---

getEffectFormat

Name	Description
getEffectFormat()	Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don’t have effect properties. Read-only IEffectFormat.

Result: EffectFormat

---

getEmbeddedVideo

Name	Description
getEmbeddedVideo()	Returns or sets embedded video object. Read/write IVideo.

Result: Video

---

getFillFormat

Name	Description
getFillFormat()	Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only IFillFormat.

Result: FillFormat

---

getFrame

Name	Description
getFrame()	Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

Result: ShapeFrame

---

getFullScreenMode

Name	Description
getFullScreenMode()	Determines whether a video is shown in full screen mode. Read/write boolean.

Result: boolean

---

getGeometryPaths

Name	Description
getGeometryPaths()	Returns the copy of path of the geometry shape. Coordinates are relative to the left top corner of the shape.

Result: GeometryPath

---

getHeight

Name	Description
getHeight()	Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getHidden

Name	Description
getHidden()	Determines whether the shape is hidden. Read/write boolean.

Result: boolean

---

getHideAtShowing

Name	Description
getHideAtShowing()	Determines whether a VideoFrame is hidden. Read/write boolean.

Result: boolean

---

getHyperlinkClick

Name	Description
getHyperlinkClick()	Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Result: Hyperlink

---

getHyperlinkManager

Name	Description
getHyperlinkManager()	Returns the hyperlink manager. Read-only IHyperlinkManager.

Result: HyperlinkManager

---

getHyperlinkMouseOver

Name	Description
getHyperlinkMouseOver()	Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Result: Hyperlink

---

getLineFormat

Name	Description
getLineFormat()	Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don’t have line properties. Read-only ILineFormat.

Result: LineFormat

---

getLinkPathLong

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

Result: String

---

getName

Name	Description
getName()	Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

Result: String

---

getOfficeInteropShapeId

Name	Description
getOfficeInteropShapeId()	Gets unique shape identifier in slide scope. Read-only long. See also ( #getUniqueId) for getting unique shape identifier in presentation scope.

Result: long

---

getParentGroup

Name	Description
getParentGroup()	Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. Property ( #isGrouped) determines whether the shape is grouped.

Result: GroupShape

---

getParent_Immediate

Name	Description
getParent_Immediate()

---

getPictureFormat

Name	Description
getPictureFormat()	Returns the PictureFillFormat object for a picture frame. Read-only IPictureFillFormat.

Result: PictureFillFormat

---

getPictureFrameLock

Name	Description
getPictureFrameLock()	Returns shape’s locks. Read-only IPictureFrameLock.

Result: PictureFrameLock

---

getPlaceholder

Name	Description
getPlaceholder()	Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder.

Result: Placeholder

---

getPlayLoopMode

Name	Description
getPlayLoopMode()	Determines whether a video is looped. Read/write boolean.

Result: boolean

---

getPlayMode

Name	Description
getPlayMode()	Returns or sets the video play mode. Read/write VideoPlayModePreset.

Result: int

---

getPresentation

Name	Description
getPresentation()	Returns the parent presentation of a slide. Read-only IPresentation.

Result: Presentation

---

getRawFrame

Name	Description
getRawFrame()	Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

Result: ShapeFrame

---

getRelativeScaleHeight

Name	Description
getRelativeScaleHeight()	Returns or sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Result: float

---

getRelativeScaleWidth

Name	Description
getRelativeScaleWidth()	Returns or sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Result: float

---

getRewindVideo

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

Result: boolean

---

getRotation

Name	Description
getRotation()	Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getShapeLock

Name	Description
getShapeLock()	Returns shape’s locks. Read-only IBaseShapeLock.

Result: BaseShapeLock, PictureFrameLock, AutoShapeLock, GraphicalObjectLock, GroupShapeLock, ConnectorLock

---

getShapeStyle

Name	Description
getShapeStyle()	Returns shape’s style object. Read-only IShapeStyle.

Result: ShapeStyle

---

getShapeType

Name	Description
getShapeType()	Returns or sets the geometry preset type. Note: on value changing all adjustment values will reset to their default values. Read/write ShapeType.

Result: int

---

getSlide

Name	Description
getSlide()	Returns the parent slide of a shape. Read-only IBaseSlide.

Result: Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide

---

getThreeDFormat

Name	Description
getThreeDFormat()	Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don’t have 3d properties. Read-only IThreeDFormat.

Result: ThreeDFormat

---

getThumbnail

Name	Description
getThumbnail()	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Result: BufferedImage

---

getThumbnail

Name	Description
getThumbnail(int, float, float)	Returns shape thumbnail.

Parameters:

Name	Type	Description
bounds	int	Shape thumbnail bounds type.
scaleX	float	X scale
scaleY	float	Y scale

Result: BufferedImage

---

getTrimFromEnd

Name	Description
getTrimFromEnd()	Trim end [ms]

Result: float

---

getTrimFromStart

Name	Description
getTrimFromStart()	Trim start [ms]

Result: float

---

getUniqueId

Name	Description
getUniqueId()	Gets unique shape identifier in presentation scope. Read-only long. See also ( #getOfficeInteropShapeId) for getting unique shape identifier in slide scope.

Result: long

---

getVolume

Name	Description
getVolume()	Returns or sets the audio volume. Read/write AudioVolumeMode.

Result: int

---

getWidth

Name	Description
getWidth()	Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getX

Name	Description
getX()	Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getY

Name	Description
getY()	Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

Result: float

---

getZOrderPosition

Name	Description
getZOrderPosition()	Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int.

Result: int

---

isGrouped

Name	Description
isGrouped()	Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped.

Result: boolean

---

isTextHolder

Name	Description
isTextHolder()	Determines whether the shape is TextHolder_PPT. Read-only boolean.

Result: boolean

---

removePlaceholder

Name	Description
removePlaceholder()	Defines that this shape isn’t a placeholder.

---

setAlternativeText

Name	Description
setAlternativeText(String)	Returns or sets the alternative text associated with a shape. Read/write String.

---

setAlternativeTextTitle

Name	Description
setAlternativeTextTitle(String)	Returns or sets the title of alternative text associated with a shape. Read/write String.

---

setBlackWhiteMode

Name	Description
setBlackWhiteMode(byte)	Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

---

setEmbeddedVideo

Name	Description
setEmbeddedVideo(Video)	Returns or sets embedded video object. Read/write IVideo.

---

setFrame

Name	Description
setFrame(ShapeFrame)	Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

---

setFullScreenMode

Name	Description
setFullScreenMode(boolean)	Determines whether a video is shown in full screen mode. Read/write boolean.

---

setGeometryPath

Name	Description
setGeometryPath(GeometryPath)	Updates shape geometry from IGeometryPath object. Coordinates must be relative to the left top corner of the shape. Changes the type of the shape (ShapeType( #getShapeType/ #setShapeType(int))) to ShapeType#Custom.

Parameters:

Name	Type	Description
geometryPath	GeometryPath	Geometry path

Error

Error	Condition
ArgumentException	Empty path found

---

setGeometryPaths

Name	Description
setGeometryPaths(com.aspose.slides.IGeometryPath[])	Updates shape geometry from array of IGeometryPath. Coordinates must be relative to the left top corner of the shape. Changes the type of the shape (ShapeType( #getShapeType/ #setShapeType(int))) to ShapeType#Custom.

Parameters:

Name	Type	Description
geometryPaths	com.aspose.slides.IGeometryPath[]	Array geometry paths

Error

Error	Condition
ArgumentException	Empty path

---

setHeight

Name	Description
setHeight(float)	Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setHidden

Name	Description
setHidden(boolean)	Determines whether the shape is hidden. Read/write boolean.

---

setHideAtShowing

Name	Description
setHideAtShowing(boolean)	Determines whether a VideoFrame is hidden. Read/write boolean.

---

setHyperlinkClick

Name	Description
setHyperlinkClick(Hyperlink)	Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

---

setHyperlinkMouseOver

Name	Description
setHyperlinkMouseOver(Hyperlink)	Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

---

setLinkPathLong

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

---

setName

Name	Description
setName(String)	Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

---

setPlayLoopMode

Name	Description
setPlayLoopMode(boolean)	Determines whether a video is looped. Read/write boolean.

---

setPlayMode

Name	Description
setPlayMode(int)	Returns or sets the video play mode. Read/write VideoPlayModePreset.

---

setRawFrame

Name	Description
setRawFrame(ShapeFrame)	Returns or sets the raw shape frame’s properties. Read/write IShapeFrame.

---

setRelativeScaleHeight

Name	Description
setRelativeScaleHeight(float)	Returns or sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

---

setRelativeScaleWidth

Name	Description
setRelativeScaleWidth(float)	Returns or sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

---

setRewindVideo

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

---

setRotation

Name	Description
setRotation(float)	Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setShapeType

Name	Description
setShapeType(int)	Returns or sets the geometry preset type. Note: on value changing all adjustment values will reset to their default values. Read/write ShapeType.

---

setTrimFromEnd

Name	Description
setTrimFromEnd(float)	Trim end [ms]

---

setTrimFromStart

Name	Description
setTrimFromStart(float)	Trim start [ms]

---

setVolume

Name	Description
setVolume(int)	Returns or sets the audio volume. Read/write AudioVolumeMode.

---

setWidth

Name	Description
setWidth(float)	Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setX

Name	Description
setX(float)	Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

setY

Name	Description
setY(float)	Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

---

writeAsSvgToBytes

Name	Description
writeAsSvgToBytes ()	Saves content of Shape as SVG file.

Result: Bytes[]

---

writeAsSvgToBytes

Name	Description
writeAsSvgToBytes (SVGOptions)	Saves content of Shape as SVG file.

Parameters:

Name	Type	Description
svgOptions	SVGOptions	SVG generation options

Result: Bytes[]

---