Movie
paper-pptx 0.2.0 API reference
A movie shape, one that places a video on a slide.
Like Picture, a movie shape is based on the p:pic element. A movie is composed of a video
and a poster frame, the placeholder image that represents the video before it is played.
Attributes
click_action
attributeclick_actionActionSettingActionSetting instance providing access to click behaviors.
Click behaviors are hyperlink-like behaviors including jumping to a hyperlink (web page)
or to another slide in the presentation. The click action is that defined on the overall
shape, not a run of text within the shape. An ActionSetting object is always returned,
even when no click behavior is defined on the shape.
crop_bottom
attributecrop_bottomfloatfloat representing relative portion cropped from shape bottom.
Read/write. 1.0 represents 100%. For example, 25% is represented by 0.25. Negative values are valid as are values greater than 1.0.
crop_left
attributecrop_leftfloatfloat representing relative portion cropped from left of shape.
Read/write. 1.0 represents 100%. A negative value extends the side beyond the image boundary.
crop_right
attributecrop_rightfloatfloat representing relative portion cropped from right of shape.
Read/write. 1.0 represents 100%.
crop_top
attributecrop_topfloatfloat representing relative portion cropped from shape top.
Read/write. 1.0 represents 100%.
element
attributeelementShapeElementlxml element for this shape, e.g. a CT_Shape instance.
Note that manipulating this element improperly can produce an invalid presentation file. Make sure you know what you're doing if you use this to change the underlying XML.
has_chart
attributehas_chartboolTrue if this shape is a graphic frame containing a chart object.
False otherwise. When True, the chart object can be accessed using the .chart
property.
has_table
attributehas_tableboolTrue if this shape is a graphic frame containing a table object.
False otherwise. When True, the table object can be accessed using the .table
property.
has_text_frame
attributehas_text_frameboolTrue if this shape can contain text.
height
attributeheightLengthRead/write. Integer distance between top and bottom extents of shape in EMUs.
is_placeholder
attributeis_placeholderboolTrue if this shape is a placeholder.
A shape is a placeholder if it has a <p:ph> element.
left
attributeleftLengthInteger distance of the left edge of this shape from the left edge of the slide.
Read/write. Expressed in English Metric Units (EMU)
line
attributelineLineFormatProvides access to properties of the picture outline, such as its color and width.
ln
attributelnCT_LineProperties | NoneThe a:ln element for this p:pic.
Contains the line format properties such as line color and width. None if no a:ln
element is present.
media_format
attributemedia_format_MediaFormatThe _MediaFormat object for this movie.
The _MediaFormat object provides access to formatting properties for the movie.
media_type
attributemedia_typePP_MEDIA_TYPEMember of :ref:PpMediaType describing this shape.
The return value is unconditionally PP_MEDIA_TYPE.MOVIE in this case.
name
attributenamestrName of this shape, e.g. 'Picture 7'.
part
attributepartBaseSlidePartThe package part containing this shape.
A BaseSlidePart subclass in this case. Access to a slide part should only be required if
you are extending the behavior of pp API objects.
placeholder_format
attributeplaceholder_format_PlaceholderFormatProvides access to placeholder-specific properties such as placeholder type.
Raises ValueError on access if the shape is not a placeholder.
poster_frame
attributeposter_frameReturn Image object containing poster frame for this movie.
Returns None if this movie has no poster frame (uncommon).
rotation
attributerotationfloatDegrees of clockwise rotation.
Read/write float. Negative values can be assigned to indicate counter-clockwise rotation, e.g. assigning -45.0 will change setting to 315.0.
shadow
attributeshadowShadowFormatShadowFormat object providing access to shadow for this shape.
A ShadowFormat object is always returned, even when no shadow is
explicitly defined on this shape (i.e. it inherits its shadow
behavior).
shape_id
attributeshape_idintRead-only positive integer identifying this shape.
The id of a shape is unique among all shapes on a slide.
shape_type
attributeshape_typeMSO_SHAPE_TYPEReturn member of :ref:MsoShapeType describing this shape.
The return value is unconditionally MSO_SHAPE_TYPE.MEDIA in this
case.
top
attributetopLengthDistance from the top edge of the slide to the top edge of this shape.
Read/write. Expressed in English Metric Units (EMU)
width
attributewidthLengthDistance between left and right extents of this shape.
Read/write. Expressed in English Metric Units (EMU).
Functions
get_or_add_ln
funcget_or_add_ln()Return the a:ln element for this p:pic-based image.
The a:ln element contains the line format properties XML.