IVideoFrame

IVideoFrame class

Represents a video clip on a slide.

class IVideoFrame : public virtual Aspose::Slides::IPictureFrame

Methods

MethodDescription
virtual System::SharedPtr<IPlaceholder> AddPlaceholder(System::SharedPtr<IPlaceholder>)Adds a new placeholder if there is no and sets placeholder properties to a specified one.
virtual System::ArrayPtr<System::SharedPtr<IShapeElement>> CreateShapeElements()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 **) constFor internal purposes only.
virtual System::SharedPtr<IAdjustValue> get_Adjustment(int32_t)Returns a shape’s adjustments value at the specified index.
virtual System::SharedPtr<IAdjustValueCollection> get_Adjustments()Returns a collection of shape’s adjustment values. Read-only IAdjustValueCollection.
virtual System::String get_AlternativeText()Returns the alternative text associated with a shape. Read System::String.
virtual System::String get_AlternativeTextTitle()Returns the title of alternative text associated with a shape. Read System::String.
virtual Aspose::Slides::BlackWhiteMode get_BlackWhiteMode()Property specifies how a shape will render in black-and-white display mode.. Read Slides::BlackWhiteMode.
virtual int32_t get_ConnectionSiteCount()Returns the number of connection sites on the shape. Read-only int32_t.
virtual System::SharedPtr<ICustomData> get_CustomData()Returns the shape’s custom data. Read-only ICustomData.
virtual System::SharedPtr<IEffectFormat> get_EffectFormat()Returns the EffectFormat object which contains pixel effects applied to a shape. Read-only IEffectFormat.
virtual System::SharedPtr<IVideo> get_EmbeddedVideo()Returns embedded video object. Read IVideo.
virtual System::SharedPtr<IFillFormat> get_FillFormat()Returns the FillFormat object that contains fill formatting properties for a shape. Read-only IFillFormat.
virtual System::SharedPtr<IShapeFrame> get_Frame()Returns the shape frame’s properties. Read IShapeFrame.
virtual bool get_FullScreenMode()Determines whether a video is shown in full screen mode. Read bool.
virtual float get_Height()Returns the height of the shape. Read float.
virtual bool get_Hidden()Determines whether the shape is hidden. Read bool.
virtual bool get_HideAtShowing()Determines whether a VideoFrame is hidden. Read bool.
virtual System::SharedPtr<IHyperlink> get_HyperlinkClick()Returns the hyperlink defined for mouse click. Read IHyperlink.
virtual System::SharedPtr<IHyperlinkManager> get_HyperlinkManager()Hyperlinks manager Read-only IHyperlinkManager.
virtual System::SharedPtr<IHyperlink> get_HyperlinkMouseOver()Returns the hyperlink defined for mouse over. Read IHyperlink.
virtual bool get_IsDecorative()Gets ‘Mark as decorative’ option Reed/write bool.
virtual bool get_IsGrouped()Determines whether the shape is grouped. Read-only bool.
virtual bool get_IsTextHolder()Determines whether the shape is TextHolder. Read-only bool.
virtual System::SharedPtr<ILineFormat> get_LineFormat()Returns the LineFormat object that contains line formatting properties for a shape. Read-only ILineFormat.
virtual System::String get_LinkPathLong()Returns the name of an video file which is linked to a VideoFrame. Read System::String.
virtual System::String get_Name()Returns the name of a shape. Read System::String.
virtual uint32_t get_OfficeInteropShapeId()Gets unique shape identifier in slide scope. Read-only uint32_t. See also IShape::get_UniqueId for getting unique shape identifier in presentation scope.
virtual System::SharedPtr<IGroupShape> get_ParentGroup()Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape.
virtual System::SharedPtr<IPictureFillFormat> get_PictureFormat()Returns the PictureFillFormat object for a picture frame. Read-only IPictureFillFormat.
virtual System::SharedPtr<IPictureFrameLock> get_PictureFrameLock()Returns PictureFrame’s locks. Read-only IPictureFrameLock.
virtual System::SharedPtr<IPlaceholder> get_Placeholder()Returns the placeholder for a shape. Read-only IPlaceholder.
virtual bool get_PlayLoopMode()Determines whether a video is looped. Read bool.
virtual VideoPlayModePreset get_PlayMode()Returns the video play mode. Read VideoPlayModePreset.
virtual System::SharedPtr<IPresentation> get_Presentation()Returns the presentation. Read-only IPresentation.
virtual System::SharedPtr<IShapeFrame> get_RawFrame()Returns the raw shape frame’s properties. Read IShapeFrame.
virtual float get_RelativeScaleHeight()Returns the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read float.
virtual float get_RelativeScaleWidth()Returns the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read float.
virtual bool get_RewindVideo()Determines whether a video is automatically rewinded to start as soon as the movie has finished playing. Read bool.
virtual float get_Rotation()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.
virtual System::SharedPtr<IBaseShapeLock> get_ShapeLock()Returns shape’s locks. Read-only IBaseShapeLock.
virtual System::SharedPtr<IShapeStyle> get_ShapeStyle()Returns shape’s style object. Read-only IShapeStyle.
virtual Aspose::Slides::ShapeType get_ShapeType()Returns the geometry preset type. Note: on value changing all adjustment values will reset to their default values. Read Slides::ShapeType.
virtual System::SharedPtr<IBaseSlide> get_Slide()Returns the base slide. Read-only IBaseSlide.
virtual System::SharedPtr<IThreeDFormat> get_ThreeDFormat()Returns the ThreeDFormat object that contains line formatting properties for a shape. Read-only IThreeDFormat.
virtual float get_TrimFromEnd()Trim end [ms]
virtual float get_TrimFromStart()Trim start [ms]
virtual uint32_t get_UniqueId()Gets unique shape identifier in presentation scope. Read-only uint32_t. See also IShape::get_OfficeInteropShapeId for getting unique shape identifier in slide scope.
virtual AudioVolumeMode get_Volume()Returns the audio volume. Read AudioVolumeMode.
virtual float get_Width()Returns the width of the shape. Read float.
virtual float get_X()Returns the x-coordinate of the upper-left corner of the shape. Read float.
virtual float get_Y()Returns the y-coordinate of the upper-left corner of the shape. Read float.
virtual int32_t get_ZOrderPosition()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.
virtual System::SharedPtr<IShape> GetBasePlaceholder()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.
virtual System::ArrayPtr<System::SharedPtr<IGeometryPath>> GetGeometryPaths()Returns the copy of path of the geometry shape. Coordinates are relative to the left top corner of the shape.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual System::SharedPtr<IImage> GetImage()Returns shape thumbnail. ShapeThumbnailBounds::Shape shape thumbnail bounds type is used by default.
virtual System::SharedPtr<IImage> GetImage(ShapeThumbnailBounds, float, float)Returns shape thumbnail.
virtual System::SharedPtr<System::Drawing::Bitmap> GetThumbnail()Returns shape thumbnail. ShapeThumbnailBounds::Shape shape thumbnail bounds type is used by default.
virtual System::SharedPtr<System::Drawing::Bitmap> GetThumbnail(ShapeThumbnailBounds, float, float)Returns shape thumbnail.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck 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() constAnalog 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.
virtual void RemovePlaceholder()Defines that this shape isn’t a placeholder.
virtual void set_AlternativeText(System::String)Sets the alternative text associated with a shape. Write System::String.
virtual void set_AlternativeTextTitle(System::String)Sets the title of alternative text associated with a shape. Write System::String.
virtual void set_BlackWhiteMode(Aspose::Slides::BlackWhiteMode)Property specifies how a shape will render in black-and-white display mode.. Write Slides::BlackWhiteMode.
virtual void set_EmbeddedVideo(System::SharedPtr<IVideo>)Sets embedded video object. Write IVideo.
virtual void set_Frame(System::SharedPtr<IShapeFrame>)Sets the shape frame’s properties. Write IShapeFrame.
virtual void set_FullScreenMode(bool)Determines whether a video is shown in full screen mode. Write bool.
virtual void set_Height(float)Sets the height of the shape. Write float.
virtual void set_Hidden(bool)Determines whether the shape is hidden. Write bool.
virtual void set_HideAtShowing(bool)Determines whether a VideoFrame is hidden. Write bool.
virtual void set_HyperlinkClick(System::SharedPtr<IHyperlink>)Sets the hyperlink defined for mouse click. Write IHyperlink.
virtual void set_HyperlinkMouseOver(System::SharedPtr<IHyperlink>)Sets the hyperlink defined for mouse over. Write IHyperlink.
virtual void set_IsDecorative(bool)Sets ‘Mark as decorative’ option Reed/write bool.
virtual void set_LinkPathLong(System::String)Sets the name of an video file which is linked to a VideoFrame. Write System::String.
virtual void set_Name(System::String)Sets the name of a shape. Write System::String.
virtual void set_PlayLoopMode(bool)Determines whether a video is looped. Write bool.
virtual void set_PlayMode(VideoPlayModePreset)Sets the video play mode. Write VideoPlayModePreset.
virtual void set_RawFrame(System::SharedPtr<IShapeFrame>)Sets the raw shape frame’s properties. Write IShapeFrame.
virtual void set_RelativeScaleHeight(float)Sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Write float.
virtual void set_RelativeScaleWidth(float)Sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Write float.
virtual void set_RewindVideo(bool)Determines whether a video is automatically rewinded to start as soon as the movie has finished playing. Write bool.
virtual void set_Rotation(float)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.
virtual void set_ShapeType(Aspose::Slides::ShapeType)Sets the geometry preset type. Note: on value changing all adjustment values will reset to their default values. Write Slides::ShapeType.
virtual void set_TrimFromEnd(float)Trim end [ms]
virtual void set_TrimFromStart(float)Trim start [ms]
virtual void set_Volume(AudioVolumeMode)Sets the audio volume. Write AudioVolumeMode.
virtual void set_Width(float)Sets the width of the shape. Write float.
virtual void set_X(float)Sets the x-coordinate of the upper-left corner of the shape. Write float.
virtual void set_Y(float)Sets the y-coordinate of the upper-left corner of the shape. Write float.
virtual void SetGeometryPath(System::SharedPtr<IGeometryPath>)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.
virtual void SetGeometryPaths(System::ArrayPtr<System::SharedPtr<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) 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() constGets 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() constAnalog 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.
virtual void WriteAsSvg(System::SharedPtr<System::IO::Stream>)Saves content of Shape as SVG file.
virtual void WriteAsSvg(System::SharedPtr<System::IO::Stream>, System::SharedPtr<Export::ISVGOptions>)Saves content of Shape as SVG file.
virtual ~Object()Destroys object. Frees all internal data structures.

See Also