VideoFrame

VideoFrame class

Represents a video clip on a slide.

The VideoFrame type exposes the following members:

Properties

Name Description
is_text_holder Determines whether the shape is TextHolder.
Read-only bool.
placeholder Returns the placeholder for a shape.
Read-only IPlaceholder.
custom_data Returns the shape’s custom data.
Read-only ICustomData.
raw_frame Returns or sets the raw shape frame’s properties.
Read/write IShapeFrame.
frame Returns or sets the shape frame’s properties.
Read/write IShapeFrame.
line_format Returns the LineFormat object that contains line formatting properties for a shape.
Read-only ILineFormat.
three_d_format Returns the ThreeDFormat object that contains line formatting properties for a shape.
Read-only IThreeDFormat.
effect_format Returns the EffectFormat object which contains pixel effects applied to a shape.
Read-only IEffectFormat.
fill_format Returns the FillFormat object that contains fill formatting properties for a shape.
Read-only IFillFormat.
hyperlink_click Returns or sets the hyperlink defined for mouse click.
Read/write IHyperlink.
hyperlink_mouse_over Returns or sets the hyperlink defined for mouse over.
Read/write IHyperlink.
hyperlink_manager Hyperlinks manager
Read-only IHyperlinkManager.
hidden Determines whether the shape is hidden.
Read/write bool.
z_order_position 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
connection_site_count Returns the number of connection sites on the shape.
Read-only
rotation 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
x Returns or sets the x-coordinate of the upper-left corner of the shape.
Read/write
y Returns or sets the y-coordinate of the upper-left corner of the shape.
Read/write
width Returns or sets the width of the shape.
Read/write
height Returns or sets the height of the shape.
Read/write
black_white_mode Property specifies how a shape will render in black-and-white display mode..
Read/write BlackWhiteMode.
unique_id Gets unique shape identifier in presentation scope.
Read-only int.
See also office_interop_shape_id for getting unique shape identifier in slide scope.
office_interop_shape_id Gets unique shape identifier in slide scope.
Read-only int.
See also unique_id for getting unique shape identifier in presentation scope.
alternative_text Returns or sets the alternative text associated with a shape.
Read/write string.
alternative_text_title Returns or sets the title of alternative text associated with a shape.
Read/write string.
name Returns or sets the name of a shape.
Read/write string.
shape_lock Returns shape’s locks.
Read-only IPictureFrameLock.
is_grouped Determines whether the shape is grouped.
Read-only bool.
parent_group Returns parent GroupShape object if shape is grouped. Otherwise returns null.
Read-only IGroupShape.
slide Returns the base slide.
Read-only IBaseSlide.
presentation Returns the presentation.
Read-only IPresentation.
shape_style Returns shape’s style object.
Read-only IShapeStyle.
shape_type Returns or sets the geometry preset type.
Note: on value changing all adjustment values will reset to their default values.
Read/write ShapeType.
adjustments Returns a collection of shape’s adjustment values.
Read-only IAdjustValueCollection.
picture_frame_lock Returns shape’s locks.
Read-only IPictureFrameLock.
picture_format Returns the PictureFillFormat object for a picture frame.
Read-only IPictureFillFormat.
relative_scale_height Returns or sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%.
Read/write
relative_scale_width Returns or sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%.
Read/write
rewind_video Determines whether a video is automatically rewinded to start
as soon as the movie has finished playing.
Read/write bool.
play_loop_mode Determines whether a video is looped.
Read/write bool.
hide_at_showing Determines whether a VideoFrame is hidden.
Read/write bool.
volume Returns or sets the audio volume.
Read/write AudioVolumeMode.
play_mode Returns or sets the video play mode.
Read/write VideoPlayModePreset.
full_screen_mode Determines whether a video is shown in full screen mode.
Read/write bool.
link_path_long Returns or sets the name of an video file which is linked to a VideoFrame.
Read/write string.
embedded_video Returns or sets embedded video object.
Read/write IVideo.
as_i_hyperlink_container Allows to get base IHyperlinkContainer interface.
Read-only IHyperlinkContainer.
as_i_slide_component Allows to get base ISlideComponent interface.
Read-only ISlideComponent.
as_i_presentation_component Allows to get base IPresentationComponent interface.
Read-only IPresentationComponent.
as_i_shape Allows to get base IShape interface.
Read-only IShape.
as_i_geometry_shape Allows to get base IGeometryShape interface.
Read-only IGeometryShape.
as_i_picture_frame Allows to get base IPictureFrame interface.
Read-only IPictureFrame.

Methods

Name Description
get_thumbnail() Returns shape thumbnail.
ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
get_thumbnail(bounds, scale_x, scale_y) Returns shape thumbnail.
write_as_svg(stream) Saves content of Shape as SVG file.
write_as_svg(stream, svg_options) Saves content of Shape as SVG file.
remove_placeholder() Defines that this shape isn’t a placeholder.
add_placeholder(placeholder_to_copy_from) Adds a new placeholder if there is no and sets placeholder properties to a specified one.
get_base_placeholder() Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from).
get_geometry_paths() Returns the copy of path of the geometry shape. Coordinates are relative to the left top corner of the shape.
set_geometry_path(geometry_path) Updates shape geometry from IGeometryPath object. Coordinates must be relative to the left
top corner of the shape.
Changes the type of the shape (shape_type) to CUSTOM.
set_geometry_paths(geometry_paths) 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 (shape_type) to CUSTOM.
create_shape_elements() Creates and returns array of shape’s elements.

See Also