AudioFrame
Contents
[
Hide
]AudioFrame class
Represents an audio clip on a slide.
class AudioFrame : public Aspose::Slides::PictureFrame,
public Aspose::Slides::IAudioFrame
Methods
| Method | Description |
|---|---|
| System::SharedPtr<IPlaceholder> AddPlaceholder(System::SharedPtr<IPlaceholder>) override | Adds a new placeholder if there is no and sets placeholder properties to a specified one. |
| System::ArrayPtr<System::SharedPtr<IShapeElement>> CreateShapeElements() override | Creates and returns array of shape’s elements. |
| virtual bool Equals(ptr) | Compares objects using C# Object.Equals semantics. |
| static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares reference type objects in C# style. |
| static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares value type objects in C# style. |
| static bool Equals(float const&, float const&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
| static bool Equals(double const&, double const&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
| virtual bool FastCast(const Details::FastRttiBase&, void **) const | For internal purposes only. |
| System::SharedPtr<IAdjustValue> get_Adjustment(int32_t) override | Returns a shape’s adjustments value at the specified index. |
| System::SharedPtr<IAdjustValueCollection> get_Adjustments() override | Returns a collection of shape’s adjustment values. Read-only IAdjustValueCollection. |
| System::String get_AlternativeText() override | Returns the alternative text associated with a shape. Read System::String. |
| System::String get_AlternativeTextTitle() override | Returns the title of alternative text associated with a shape. Read System::String. |
| int32_t get_AudioCdEndTrack() override | Returns a last track index Read int32_t. |
| int32_t get_AudioCdEndTrackTime() override | Returns a last track time. Read int32_t. |
| int32_t get_AudioCdStartTrack() override | Returns a start track index. Read int32_t. |
| int32_t get_AudioCdStartTrackTime() override | Returns a start track time. Read int32_t. |
| Aspose::Slides::BlackWhiteMode get_BlackWhiteMode() override | Property specifies how a shape will render in black-and-white display mode.. Read Slides::BlackWhiteMode. |
| int32_t get_ConnectionSiteCount() override | Returns the number of connection sites on the shape. Read-only int32_t. |
| System::SharedPtr<ICustomData> get_CustomData() override | Returns the shape’s custom data. Read-only ICustomData. |
| System::SharedPtr<IEffectFormat> get_EffectFormat() override | 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. |
| bool get_Embedded() override | Determines whether a sound is embedded to a presentation. Read-only bool. |
| System::SharedPtr<IAudio> get_EmbeddedAudio() override | Returns embedded audio object. Read IAudio. |
| System::SharedPtr<IFillFormat> get_FillFormat() override | 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. |
| System::SharedPtr<IShapeFrame> get_Frame() override | Returns the shape frame’s properties. Read IShapeFrame. |
| float get_Height() override | Returns the height of the shape. Read float. |
| bool get_Hidden() override | Determines whether the shape is hidden. Read bool. |
| bool get_HideAtShowing() override | Determines whether an AudioFrame is hidden. Read bool. |
| System::SharedPtr<IHyperlink> get_HyperlinkClick() override | Returns the hyperlink defined for mouse click. Read IHyperlink. |
| System::SharedPtr<IHyperlinkManager> get_HyperlinkManager() override | Returns the hyperlink manager. Read-only IHyperlinkManager. |
| System::SharedPtr<IHyperlink> get_HyperlinkMouseOver() override | Returns the hyperlink defined for mouse over. Read IHyperlink. |
| bool get_IsDecorative() override | Gets ‘Mark as decorative’ option Reed/write bool. |
| bool get_IsGrouped() override | Determines whether the shape is grouped. Read-only bool. |
| bool get_IsTextHolder() override | Determines whether the shape is TextHolder_PPT. Read-only bool. |
| System::SharedPtr<ILineFormat> get_LineFormat() override | 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. |
| System::String get_LinkPathLong() override | Returns the name of an audio file which is linked to an AudioFrame. Read System::String. |
| System::String get_Name() override | Returns the name of a shape. Must be not null. Use empty string value if needed. Read System::String. |
| uint32_t get_OfficeInteropShapeId() override | Gets unique shape identifier in slide scope. Read-only uint32_t. See also Shape::get_UniqueId for getting unique shape identifier in presentation scope. |
| System::SharedPtr<IGroupShape> get_ParentGroup() override | Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. |
| System::SharedPtr<IPictureFillFormat> get_PictureFormat() override | Returns the PictureFillFormat object for a picture frame. Read-only IPictureFillFormat. |
| System::SharedPtr<IPictureFrameLock> get_PictureFrameLock() override | Returns shape’s locks. Read-only IPictureFrameLock. |
| System::SharedPtr<IPlaceholder> get_Placeholder() override | Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder. |
| bool get_PlayAcrossSlides() override | Determines whether audio is playing across the slides. Read bool. |
| bool get_PlayLoopMode() override | Determines whether an audio is looped. Read bool. |
| AudioPlayModePreset get_PlayMode() override | Returns the audio play mode. Read AudioPlayModePreset. |
| System::SharedPtr<IPresentation> get_Presentation() override | Returns the parent presentation of a slide. Read-only IPresentation. |
| System::SharedPtr<IShapeFrame> get_RawFrame() override | Returns the raw shape frame’s properties. Read IShapeFrame. |
| float get_RelativeScaleHeight() override | Returns the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read float. |
| float get_RelativeScaleWidth() override | Returns the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read float. |
| bool get_RewindAudio() override | Determines whether audio is automatically rewinded to start after playing. Read bool. |
| float get_Rotation() override | Returns 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 float. |
| System::SharedPtr<IBaseShapeLock> get_ShapeLock() override | Returns shape’s locks. Read-only IBaseShapeLock. |
| System::SharedPtr<IShapeStyle> get_ShapeStyle() override | Returns shape’s style object. Read-only IShapeStyle. |
| Aspose::Slides::ShapeType get_ShapeType() override | |
| System::SharedPtr<IBaseSlide> get_Slide() override | Returns the parent slide of a shape. Read-only IBaseSlide. |
| System::SharedPtr<IThreeDFormat> get_ThreeDFormat() override | 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. |
| uint32_t get_UniqueId() override | Gets unique shape identifier in presentation scope. Read-only uint32_t. See also Shape::get_OfficeInteropShapeId for getting unique shape identifier in slide scope. |
| AudioVolumeMode get_Volume() override | Returns the audio volume. Read AudioVolumeMode. |
| float get_Width() override | Returns the width of the shape. Read float. |
| float get_X() override | Returns the x-coordinate of the upper-left corner of the shape. Read float. |
| float get_Y() override | Returns the y-coordinate of the upper-left corner of the shape. Read float. |
| int32_t get_ZOrderPosition() override | 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 int32_t. |
| System::SharedPtr<IShape> GetBasePlaceholder() override | Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). |
| Detail::SmartPtrCounter * GetCounter() | Gets reference counter data structure associated with the object. |
| System::ArrayPtr<System::SharedPtr<IGeometryPath>> GetGeometryPaths() override | Returns the copy of path of the geometry shape. Coordinates are relative to the left top corner of the shape. |
| virtual int32_t GetHashCode() const | Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. |
| System::SharedPtr<IImage> GetImage() override | Returns shape thumbnail. ShapeThumbnailBounds::Shape shape thumbnail bounds type is used by default. |
| System::SharedPtr<IImage> GetImage(ShapeThumbnailBounds, float, float) override | Returns shape thumbnail. |
| System::SharedPtr<System::Drawing::Bitmap> GetThumbnail() override | Returns shape thumbnail. ShapeThumbnailBounds::Shape shape thumbnail bounds type is used by default. |
| System::SharedPtr<System::Drawing::Bitmap> GetThumbnail(ShapeThumbnailBounds, float, float) override | Returns shape thumbnail. |
| virtual const TypeInfo& GetType() const | Gets actual type of object. Analog of C# System.Object.GetType() call. |
| virtual bool Is(const TypeInfo&) const | Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator. |
| void Lock() | Implements C# lock() statement locking. Call directly or use LockContext sentry object. |
| virtual ptr MemberwiseClone() const | Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. |
| Object() | Creates object. Initializes all internal data structures. |
| Object(Object const&) | Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
| Object& operator=(Object const&) | Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
| static bool ReferenceEquals(ptr const&, ptr const&) | Compares objects by reference. |
| static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&) | Compares objects by reference. |
| static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t) | Reference-compares value type object with nullptr. |
| bool ReferenceEquals(String const&, std::nullptr_t) | Specialization of Object::ReferenceEquals for case of string and nullptr. |
| bool ReferenceEquals(String const&, String const&) | Specialization of Object::ReferenceEquals for case of strings. |
| int RemovedSharedRefs(int) | Decreases shared reference count by specified value. |
| void RemovePlaceholder() override | Defines that this shape isn’t a placeholder. |
| void set_AlternativeText(System::String) override | Sets the alternative text associated with a shape. Write System::String. |
| void set_AlternativeTextTitle(System::String) override | Sets the title of alternative text associated with a shape. Write System::String. |
| void set_AudioCdEndTrack(int32_t) override | Sets a last track index Write int32_t. |
| void set_AudioCdEndTrackTime(int32_t) override | Sets a last track time. Write int32_t. |
| void set_AudioCdStartTrack(int32_t) override | Sets a start track index. Write int32_t. |
| void set_AudioCdStartTrackTime(int32_t) override | Sets a start track time. Write int32_t. |
| void set_BlackWhiteMode(Aspose::Slides::BlackWhiteMode) override | Property specifies how a shape will render in black-and-white display mode.. Write Slides::BlackWhiteMode. |
| void set_EmbeddedAudio(System::SharedPtr<IAudio>) override | Sets embedded audio object. Write IAudio. |
| void set_Frame(System::SharedPtr<IShapeFrame>) override | Sets the shape frame’s properties. Write IShapeFrame. |
| void set_Height(float) override | Sets the height of the shape. Write float. |
| void set_Hidden(bool) override | Determines whether the shape is hidden. Write bool. |
| void set_HideAtShowing(bool) override | Determines whether an AudioFrame is hidden. Write bool. |
| void set_HyperlinkClick(System::SharedPtr<IHyperlink>) override | Sets the hyperlink defined for mouse click. Write IHyperlink. |
| void set_HyperlinkMouseOver(System::SharedPtr<IHyperlink>) override | Sets the hyperlink defined for mouse over. Write IHyperlink. |
| void set_IsDecorative(bool) override | Sets ‘Mark as decorative’ option Reed/write bool. |
| void set_LinkPathLong(System::String) override | Sets the name of an audio file which is linked to an AudioFrame. Write System::String. |
| void set_Name(System::String) override | Sets the name of a shape. Must be not null. Use empty string value if needed. Write System::String. |
| void set_PlayAcrossSlides(bool) override | Determines whether audio is playing across the slides. Write bool. |
| void set_PlayLoopMode(bool) override | Determines whether an audio is looped. Write bool. |
| void set_PlayMode(AudioPlayModePreset) override | Sets the audio play mode. Write AudioPlayModePreset. |
| void set_RawFrame(System::SharedPtr<IShapeFrame>) override | Sets the raw shape frame’s properties. Write IShapeFrame. |
| void set_RelativeScaleHeight(float) override | Sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Write float. |
| void set_RelativeScaleWidth(float) override | Sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Write float. |
| void set_RewindAudio(bool) override | Determines whether audio is automatically rewinded to start after playing. Write bool. |
| void set_Rotation(float) override | 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. Write float. |
| void set_ShapeType(Aspose::Slides::ShapeType) override | |
| void set_Volume(AudioVolumeMode) override | Sets the audio volume. Write AudioVolumeMode. |
| void set_Width(float) override | Sets the width of the shape. Write float. |
| void set_X(float) override | Sets the x-coordinate of the upper-left corner of the shape. Write float. |
| void set_Y(float) override | Sets the y-coordinate of the upper-left corner of the shape. Write float. |
| void SetGeometryPath(System::SharedPtr<IGeometryPath>) override | 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) to ShapeType::Custom. |
| void SetGeometryPaths(System::ArrayPtr<System::SharedPtr<IGeometryPath>>) override | 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) to ShapeType::Custom. |
| virtual void SetTemplateWeakPtr(uint32_t) | Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. |
| int SharedCount() const | Gets current value of shared reference counter. |
| Object * SharedRefAdded() | Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| int SharedRefRemovedSafe() | Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| virtual String ToString() const | Analog of C# Object.ToString() method. Enables converting custom objects to string. |
| static const TypeInfo& Type() | Implements C# typeof(System.Object) construct. |
| void Unlock() | Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. |
| Detail::SmartPtrCounter * WeakRefAdded() | Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| void WeakRefRemoved() | Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| void WriteAsSvg(System::SharedPtr<System::IO::Stream>) override | Saves content of Shape as SVG file. |
| void WriteAsSvg(System::SharedPtr<System::IO::Stream>, System::SharedPtr<Export::ISVGOptions>) override | Saves content of Shape as SVG file. |
| virtual ~Object() | Destroys object. Frees all internal data structures. |
Remarks
The following examples shows how to change Audio Play Options.
auto pres = System::MakeObject<Presentation>(u"AudioFrameEmbed_out.pptx");
// Gets the AudioFrame shape
System::SharedPtr<AudioFrame> audioFrame = System::ExplicitCast<AudioFrame>(pres->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0));
// Sets the Play mode to play on click
audioFrame->set_PlayMode(AudioPlayModePreset::OnClick);
// Sets the volume to Low
audioFrame->set_Volume(AudioVolumeMode::Low);
// Sets the audio to play across slides
audioFrame->set_PlayAcrossSlides(true);
// Disables loop for the audio
audioFrame->set_PlayLoopMode(false);
// Hides the AudioFrame during the slide show
audioFrame->set_HideAtShowing(true);
// Rewinds the audio to start after playing
audioFrame->set_RewindAudio(true);
// Saves the PowerPoint file to disk
pres->Save(u"AudioFrameEmbed_changed.pptx", SaveFormat::Pptx);
See Also
- Class PictureFrame
- Class IAudioFrame
- Namespace Aspose::Slides
- Library Aspose.Slides