API Reference
Class
PowerPointMedia
Represents an embedded audio or video media frame on a slide.
Inheritance
- PowerPointPicture
- PowerPointMedia
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method PowerPointMedia.SetPlaybackOptions
- Method PowerPointMedia.UpdateLink
- Method PowerPointSlide.AddAudio
- Method PowerPointSlide.AddAudio
- Method PowerPointSlide.AddLinkedAudio
- Method PowerPointSlide.AddLinkedVideo
- Method PowerPointSlide.AddVideo
- Method PowerPointSlide.AddVideo
- Property PowerPointSlide.Media
Methods
public PowerPointMediaPlaybackOptions GetPlaybackOptions() #Returns:
PowerPointMediaPlaybackOptionsReads typed playback metadata from the native timing and media nodes.
public PowerPointMedia SetPlaybackOptions(PowerPointMediaPlaybackOptions options) #Returns:
PowerPointMediaUpdates native playback, trim, and fade metadata in place.
Parameters
- options OfficeIMO.PowerPoint.PowerPointMediaPlaybackOptions
public Void UpdateData(Stream media) #Returns:
VoidReplaces the embedded audio or video payload.
Parameters
- media System.IO.Stream
public PowerPointMedia UpdateLink(Uri uri) #Returns:
PowerPointMediaUpdates a linked media URI without rewriting the frame or timing tree.
Parameters
- uri System.Uri
Inherited Methods
public Void Crop(Double leftPercent, Double topPercent, Double rightPercent, Double bottomPercent) #Returns:
VoidInherited from PowerPointPicture
Parameters
- leftPercent Double
- topPercent Double
- rightPercent Double
- bottomPercent Double
public PowerPointShape Duplicate(Int64 offsetX = 0, Int64 offsetY = 0) #Returns:
PowerPointShapeInherited from PowerPointShape
Parameters
- offsetX Int64 = 0
- offsetY Int64 = 0
public PowerPointShape DuplicateCm(Double offsetXCm, Double offsetYCm) #Returns:
PowerPointShapeInherited from PowerPointShape
Parameters
- offsetXCm Double
- offsetYCm Double
public PowerPointShape DuplicateInches(Double offsetXInches, Double offsetYInches) #Returns:
PowerPointShapeInherited from PowerPointShape
Parameters
- offsetXInches Double
- offsetYInches Double
public PowerPointShape DuplicatePoints(Double offsetXPoints, Double offsetYPoints) #Returns:
PowerPointShapeInherited from PowerPointShape
Parameters
- offsetXPoints Double
- offsetYPoints Double
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Void FitToBox(Double imageWidth, Double imageHeight, Boolean crop = true) #Returns:
VoidInherited from PowerPointPicture
Parameters
- imageWidth Double
- imageHeight Double
- crop Boolean = true
public Void MoveBy(Int64 offsetX, Int64 offsetY) #Returns:
VoidInherited from PowerPointShape
Parameters
- offsetX Int64
- offsetY Int64
public Void MoveByCm(Double offsetXCm, Double offsetYCm) #Returns:
VoidInherited from PowerPointShape
Parameters
- offsetXCm Double
- offsetYCm Double
public Void MoveByInches(Double offsetXInches, Double offsetYInches) #Returns:
VoidInherited from PowerPointShape
Parameters
- offsetXInches Double
- offsetYInches Double
public Void MoveByPoints(Double offsetXPoints, Double offsetYPoints) #Returns:
VoidInherited from PowerPointShape
Parameters
- offsetXPoints Double
- offsetYPoints Double
public Void MoveToReadingOrder(Int32 order) #Returns:
VoidInherited from PowerPointShape
Parameters
- order Int32
public Void Resize(Int64 width, Int64 height, PowerPointShapeAnchor anchor = TopLeft) #Returns:
VoidInherited from PowerPointShape
Parameters
- width Int64
- height Int64
- anchor PowerPointShapeAnchor = TopLeft
public Void ResizeCm(Double widthCm, Double heightCm, PowerPointShapeAnchor anchor = TopLeft) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthCm Double
- heightCm Double
- anchor PowerPointShapeAnchor = TopLeft
public Void ResizeInches(Double widthInches, Double heightInches, PowerPointShapeAnchor anchor = TopLeft) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthInches Double
- heightInches Double
- anchor PowerPointShapeAnchor = TopLeft
public Void ResizePoints(Double widthPoints, Double heightPoints, PowerPointShapeAnchor anchor = TopLeft) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthPoints Double
- heightPoints Double
- anchor PowerPointShapeAnchor = TopLeft
Scale 2 overloads
public Void Scale(Double scale, PowerPointShapeAnchor anchor = Center) #Returns:
VoidInherited from PowerPointShape
Parameters
- scale Double
- anchor PowerPointShapeAnchor = Center
public Void Scale(Double scaleX, Double scaleY, PowerPointShapeAnchor anchor = Center) #Returns:
VoidInherited from PowerPointShape
Parameters
- scaleX Double
- scaleY Double
- anchor PowerPointShapeAnchor = Center
public Void SetBlur(Double radiusPoints, Boolean grow = false) #Returns:
VoidInherited from PowerPointShape
Parameters
- radiusPoints Double
- grow Boolean = false
public Void SetClickSound(Stream audio, String name, String contentType = "audio/wav", String extension = ".wav") #Returns:
VoidInherited from PowerPointShape
Parameters
- audio Stream
- name String
- contentType String = "audio/wav"
- extension String = ".wav"
public Void SetClickStopsSound(Boolean value) #Returns:
VoidInherited from PowerPointShape
Parameters
- value Boolean
public Void SetGlow(String color, Double radiusPoints = 4, Int32 transparencyPercent = 30) #Returns:
VoidInherited from PowerPointShape
Parameters
- color String
- radiusPoints Double = 4
- transparencyPercent Int32 = 30
public PowerPointShape SetLanguage(String language) #Returns:
PowerPointShapeInherited from PowerPointShape
Parameters
- language String
public Void SetLineEnds(Nullable<OfficeLineMarkerKind> startType, Nullable<OfficeLineMarkerKind> endType, Nullable<PowerPointLineEndWidth> width = null, Nullable<PowerPointLineEndLength> length = null) #Returns:
VoidInherited from PowerPointShape
Parameters
- startType Nullable<OfficeLineMarkerKind>
- endType Nullable<OfficeLineMarkerKind>
- width Nullable<PowerPointLineEndWidth> = null
- length Nullable<PowerPointLineEndLength> = null
public Void SetMouseOverSound(Stream audio, String name, String contentType = "audio/wav", String extension = ".wav") #Returns:
VoidInherited from PowerPointShape
Parameters
- audio Stream
- name String
- contentType String = "audio/wav"
- extension String = ".wav"
public Void SetMouseOverStopsSound(Boolean value) #Returns:
VoidInherited from PowerPointShape
Parameters
- value Boolean
public Void SetPositionCm(Double leftCm, Double topCm) #Returns:
VoidInherited from PowerPointShape
Parameters
- leftCm Double
- topCm Double
public Void SetPositionInches(Double leftInches, Double topInches) #Returns:
VoidInherited from PowerPointShape
Parameters
- leftInches Double
- topInches Double
public Void SetPositionPoints(Double leftPoints, Double topPoints) #Returns:
VoidInherited from PowerPointShape
Parameters
- leftPoints Double
- topPoints Double
public Void SetReflection(Double blurPoints = 4, Double distancePoints = 2, Double directionDegrees = 270, Double fadeDirectionDegrees = 90, Int32 startOpacityPercent = 50, Int32 endOpacityPercent = 0, Int32 startPositionPercent = 0, Int32 endPositionPercent = 100, Nullable<PowerPointRectangleAlignment> alignment = null, Boolean rotateWithShape = false) #Returns:
VoidInherited from PowerPointShape
Parameters
- blurPoints Double = 4
- distancePoints Double = 2
- directionDegrees Double = 270
- fadeDirectionDegrees Double = 90
- startOpacityPercent Int32 = 50
- endOpacityPercent Int32 = 0
- startPositionPercent Int32 = 0
- endPositionPercent Int32 = 100
- alignment Nullable<PowerPointRectangleAlignment> = null
- rotateWithShape Boolean = false
public Void SetShadow(String color, Double blurPoints = 4, Double distancePoints = 3, Double angleDegrees = 45, Int32 transparencyPercent = 35, Boolean rotateWithShape = false) #Returns:
VoidInherited from PowerPointShape
Parameters
- color String
- blurPoints Double = 4
- distancePoints Double = 3
- angleDegrees Double = 45
- transparencyPercent Int32 = 35
- rotateWithShape Boolean = false
public Void SetSizeCm(Double widthCm, Double heightCm) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthCm Double
- heightCm Double
public Void SetSizeInches(Double widthInches, Double heightInches) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthInches Double
- heightInches Double
public Void SetSizePoints(Double widthPoints, Double heightPoints) #Returns:
VoidInherited from PowerPointShape
Parameters
- widthPoints Double
- heightPoints Double
public Void SetSoftEdges(Double radiusPoints) #Returns:
VoidInherited from PowerPointShape
Parameters
- radiusPoints Double
UpdateImage 2 overloads
public Void UpdateImage(Stream newImage, OfficeImageFormat type) #Returns:
VoidInherited from PowerPointPicture
Parameters
- newImage Stream
- type OfficeImageFormat
public Void UpdateImage(String imagePath) #Returns:
VoidInherited from PowerPointPicture
Parameters
- imagePath String
Properties
public PowerPointMediaKind Kind { get; } #Gets the media kind represented by this shape.
public String MediaContentType { get; } #Gets the MIME content type of the embedded media part.
public String MediaReferenceId { get; } #Gets the relationship id used by the audio/video file reference.
public String PlaybackReferenceId { get; } #Gets the p14 media relationship id used by PowerPoint playback metadata.
public PowerPointMediaSourceKind SourceKind { get; } #Gets whether the payload is embedded, linked, or broken.
public Uri LinkUri { get; } #Gets the external media URI when linked.
Inherited Properties
public String ContentType { get; } #Inherited from PowerPointPicture
public String MimeType { get; } #Inherited from PowerPointPicture
public Double CropLeftRatio { get; } #Inherited from PowerPointPicture
public Double CropTopRatio { get; } #Inherited from PowerPointPicture
public Double CropRightRatio { get; } #Inherited from PowerPointPicture
public Double CropBottomRatio { get; } #Inherited from PowerPointPicture
public Nullable<Int32> LuminanceBrightness { get; set; } #Inherited from PowerPointPicture
public Nullable<Int32> LuminanceContrast { get; set; } #Inherited from PowerPointPicture
public Boolean GrayScale { get; set; } #Inherited from PowerPointPicture
public Nullable<Int32> BlackWhiteThreshold { get; set; } #Inherited from PowerPointPicture
public Nullable<OfficeColor> TransparentColor { get; set; } #Inherited from PowerPointPicture
public Nullable<OfficeColor> RecolorColor { get; set; } #Inherited from PowerPointPicture
public String Title { get; set; } #Inherited from PowerPointShape
public String Description { get; set; } #Inherited from PowerPointShape
public Boolean Decorative { get; set; } #Inherited from PowerPointShape
public Int32 ReadingOrder { get; } #Inherited from PowerPointShape
public String Language { get; } #Inherited from PowerPointShape
public IReadOnlyList<String> Languages { get; } #Inherited from PowerPointShape
public String FillColor { get; set; } #Inherited from PowerPointShape
public Nullable<Int32> FillTransparency { get; set; } #Inherited from PowerPointShape
public Nullable<Double> Rotation { get; set; } #Inherited from PowerPointShape
public Nullable<Boolean> HorizontalFlip { get; set; } #Inherited from PowerPointShape
public Nullable<Boolean> VerticalFlip { get; set; } #Inherited from PowerPointShape
public Nullable<UInt32> Id { get; } #Inherited from PowerPointShape
public String Name { get; set; } #Inherited from PowerPointShape
public String AltText { get; set; } #Inherited from PowerPointShape
public Uri Hyperlink { get; } #Inherited from PowerPointShape
public Nullable<PowerPointPlaceholderType> ShapePlaceholderType { get; } #Inherited from PowerPointShape
public Nullable<UInt32> ShapePlaceholderIndex { get; } #Inherited from PowerPointShape
public Nullable<PowerPointPlaceholderSize> ShapePlaceholderSize { get; } #Inherited from PowerPointShape
public Nullable<PowerPointPlaceholderDirection> ShapePlaceholderOrientation { get; } #Inherited from PowerPointShape
public PowerPointShapeContentType ShapeContentType { get; } #Inherited from PowerPointShape
public Int32 DrawingOrder { get; } #Inherited from PowerPointShape
public Int64 Left { get; set; } #Inherited from PowerPointShape
public Double LeftPoints { get; set; } #Inherited from PowerPointShape
public Double LeftCm { get; set; } #Inherited from PowerPointShape
public Double LeftInches { get; set; } #Inherited from PowerPointShape
public Int64 Top { get; set; } #Inherited from PowerPointShape
public Double TopPoints { get; set; } #Inherited from PowerPointShape
public Double TopCm { get; set; } #Inherited from PowerPointShape
public Double TopInches { get; set; } #Inherited from PowerPointShape
public Int64 Width { get; set; } #Inherited from PowerPointShape
public Double WidthPoints { get; set; } #Inherited from PowerPointShape
public Double WidthCm { get; set; } #Inherited from PowerPointShape
public Double WidthInches { get; set; } #Inherited from PowerPointShape
public Int64 Height { get; set; } #Inherited from PowerPointShape
public Double HeightPoints { get; set; } #Inherited from PowerPointShape
public Double HeightCm { get; set; } #Inherited from PowerPointShape
public Double HeightInches { get; set; } #Inherited from PowerPointShape
public Int64 Right { get; set; } #Inherited from PowerPointShape
public Double RightPoints { get; set; } #Inherited from PowerPointShape
public Double RightCm { get; set; } #Inherited from PowerPointShape
public Double RightInches { get; set; } #Inherited from PowerPointShape
public Int64 Bottom { get; set; } #Inherited from PowerPointShape
public Double BottomPoints { get; set; } #Inherited from PowerPointShape
public Double BottomCm { get; set; } #Inherited from PowerPointShape
public Double BottomInches { get; set; } #Inherited from PowerPointShape
public Int64 CenterX { get; set; } #Inherited from PowerPointShape
public Double CenterXPoints { get; set; } #Inherited from PowerPointShape
public Double CenterXCm { get; set; } #Inherited from PowerPointShape
public Double CenterXInches { get; set; } #Inherited from PowerPointShape
public Int64 CenterY { get; set; } #Inherited from PowerPointShape
public Double CenterYPoints { get; set; } #Inherited from PowerPointShape
public Double CenterYCm { get; set; } #Inherited from PowerPointShape
public Double CenterYInches { get; set; } #Inherited from PowerPointShape
public PowerPointLayoutBox Bounds { get; set; } #Inherited from PowerPointShape
public String OutlineColor { get; set; } #Inherited from PowerPointShape
public Nullable<Int32> OutlineTransparency { get; set; } #Inherited from PowerPointShape
public Nullable<Double> OutlineWidthPoints { get; set; } #Inherited from PowerPointShape
public Nullable<PowerPointLineDashStyle> OutlineDash { get; set; } #Inherited from PowerPointShape
public String ClickSoundName { get; } #Inherited from PowerPointShape
public String MouseOverSoundName { get; } #Inherited from PowerPointShape