AudioFrame class

Represents an audio clip on a slide.

Inheritance:AudioFrame → PictureFrame → GeometryShape → Shape

The AudioFrame type exposes the following members:

Properties

Property	Description
`is_text_holder`	Determines whether the shape is TextHolder_PPT. Read-only bool.
`placeholder`	Returns the placeholder for a shape. Returns None if the shape has no placeholder. 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. Note: can return None for certain types of shapes which don’t have line properties. Read-only `ILineFormat`.
`three_d_format`	Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return None for certain types of shapes which don’t have 3d properties. Read-only `IThreeDFormat`.
`effect_format`	Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return None for certain types of shapes which don’t have effect properties. Read-only `IEffectFormat`.
`fill_format`	Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return None for certain types of shapes which don’t have fill properties. 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`	Returns the hyperlink 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 int.
`connection_site_count`	Returns the number of connection sites on the shape. Read-only int.
`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 float.
`x`	Gets or sets the x-coordinate of the shape’s upper-left corner, measured in points. Read/write float.
`y`	Gets or sets the y-coordinate of the shape’s upper-left corner, measured in points. Read/write float.
`width`	Gets or sets the width of the shape, measured in points. Read/write float.
`height`	Gets or sets the height of the shape, measured in points. Read/write float.
`black_white_mode`	Property specifies how a shape will render in black-and-white display mode.. Read/write `BlackWhiteMode`.
`unique_id`	Returns an internal, presentation-scoped identifier intended for use by add-ins or other code. Because this value can be reassigned by the user or programmatically, it must not be treated as a persistent unique key. Read-only int. See also `Shape.office_interop_shape_id`.
`office_interop_shape_id`	Returns a slide-scoped unique identifier that remains constant for the lifetime of the shape and lets PowerPoint or interop code reliably reference the shape from anywhere in the document. Read-only int. See also `Shape.unique_id`.
`alternative_text`	Returns or sets the alternative text associated with a shape. Read/write str.
`alternative_text_title`	Returns or sets the title of alternative text associated with a shape. Read/write str.
`name`	Returns or sets the name of a shape. Must be not None. Use empty string value if needed. Read/write str.
`is_decorative`	Gets or sets ‘Mark as decorative’ option Reed/write bool.
`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 None. Read-only `IGroupShape`.
`slide`	Returns the parent slide of a shape. Read-only `IBaseSlide`.
`presentation`	Returns the parent presentation of a slide. Read-only `IPresentation`.
`shape_style`	Returns shape’s style object. Read-only `IShapeStyle`.
`shape_type`	Returns or sets the AutoShape type for a PictureFrame. There are allowable all items of the set `ShapeType`, except all sorts of lines: ShapeType.Line, ShapeType.StraightConnector1, ShapeType.BentConnector2, ShapeType.BentConnector3, ShapeType.BentConnector4, ShapeType.BentConnector5, ShapeType.CurvedConnector2, ShapeType.CurvedConnector3, ShapeType.CurvedConnector4, ShapeType.CurvedConnector5. 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 float.
`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 float.
`is_cameo`	Determines whether the PictureFrame is Cameo object or not. Read only bool.
`audio_cd_start_track`	Returns or sets a start track index. Read/write int.
`audio_cd_start_track_time`	Returns or sets a start track time. Read/write int.
`audio_cd_end_track`	Returns or sets a last track index Read/write int.
`audio_cd_end_track_time`	Returns or sets a last track time. Read/write int.
`volume`	Returns or sets the audio volume. Read/write `AudioVolumeMode`.
`play_mode`	Returns or sets the audio play mode. Read/write `AudioPlayModePreset`.
`hide_at_showing`	Determines whether an AudioFrame is hidden. Read/write bool.
`play_loop_mode`	Determines whether an audio is looped. Read/write bool.
`play_across_slides`	Determines whether audio is playing across the slides. Read/write bool.
`rewind_audio`	Determines whether audio is automatically rewinded to start after playing. Read/write bool.
`embedded`	Determines whether a sound is embedded to a presentation. Read-only bool.
`link_path_long`	Returns or sets the name of an audio file which is linked to an AudioFrame. Read/write str.
`embedded_audio`	Returns or sets embedded audio object. Read/write `IAudio`.
`fade_in_duration`	Specifies the time duration for the initial fade-in of the media in milliseconds. Read/write float.
`fade_out_duration`	Specifies the time duration for the ending fade-out of the media in milliseconds. Read/write float.
`volume_value`	Returns or sets the audio volume in percents. Read/write float.
`trim_from_start`	Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds. Read/write float.
`trim_from_end`	Specifies the time duration to be removed from the end of the media during playback, in milliseconds. Read/write float.
`caption_tracks`	Gets the collection of closed captions associated with the audio frame. This property is read-only and returns an `ICaptionsCollection` containing all caption tracks.

Methods

Method	Description
`get_thumbnail`	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
`get_thumbnail`	Returns shape thumbnail.
`get_image`	Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
`get_image`	Returns shape thumbnail.
`write_as_svg`	Saves content of Shape as SVG file.
`write_as_svg`	Saves content of Shape as SVG file.
`remove_placeholder`	Defines that this shape isn’t a placeholder.
`add_placeholder`	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). A None is returned if the current shape is not inherited.
`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`	Updates shape geometry from `IGeometryPath` object. Coordinates must be relative to the left top corner of the shape. Changes the type of the shape (`GeometryShape.shape_type`) to `ShapeType.CUSTOM`.
`set_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 (`GeometryShape.shape_type`) to `ShapeType.CUSTOM`.
`create_shape_elements`	Creates and returns array of shape’s elements.

Examples

The following examples shows how to change Audio Play Options.

AudioFrame class

AudioFrame class

Properties

Methods

Examples

See Also