spire-presentation 10.6.4__py3-none-win_amd64.whl → 10.7.1__py3-none-win_amd64.whl

spire/presentation/IAudio.py

@@ -8,16 +8,15 @@ import abc
 
 class IAudio (  IShape) :
     """
-
+    Represents an audio object on a slide that inherits properties from IShape.
+    Provides control over audio playback settings, volume, and embedding status.
     """
     @property
 
     def Volume(self)->'AudioVolumeType':
         """
-    <summary>
         Gets or sets the audio volume.
-            Read/write <see cref="T:Spire.Presentation.AudioVolumeType" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_Volume.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Volume.restype=c_int
@@ -34,10 +33,7 @@ class IAudio (  IShape) :
 
     def PlayMode(self)->'AudioPlayMode':
         """
-    <summary>
         Gets or sets the audio play mode.
-            Read/write <see cref="T:Spire.Presentation.AudioPlayMode" />.
-    </summary>
         """
         GetDllLibPpt().IAudio_get_PlayMode.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_PlayMode.restype=c_int
@@ -53,10 +49,7 @@ class IAudio (  IShape) :
     @property
     def IsLoop(self)->bool:
         """
-    <summary>
         Indicates whether an audio is looped.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
         """
         GetDllLibPpt().IAudio_get_IsLoop.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_IsLoop.restype=c_bool
@@ -71,10 +64,8 @@ class IAudio (  IShape) :
     @property
     def IsEmbedded(self)->bool:
         """
-    <summary>
         Indicates whether a sound is embedded to a presentation.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_IsEmbedded.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_IsEmbedded.restype=c_bool
@@ -85,10 +76,7 @@ class IAudio (  IShape) :
 
     def FileName(self)->str:
         """
-    <summary>
         Gets or sets the name of an audio file.
-            Read/write <see cref="T:System.String" />.
-    </summary>
         """
         GetDllLibPpt().IAudio_get_FileName.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_FileName.restype=c_void_p
@@ -106,10 +94,8 @@ class IAudio (  IShape) :
 
     def Data(self)->'IAudioData':
         """
-    <summary>
         Gets or sets embedded audio data.
-            Read/write <see cref="T:Spire.Presentation.AudioData" />.
-    </summary>
+          
         """
         GetDllLibPpt().IAudio_get_Data.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Data.restype=c_void_p
@@ -127,9 +113,8 @@ class IAudio (  IShape) :
 
     def AudioCd(self)->'AudioCD':
         """
-    <summary>
         Gets setting of CD.
-    </summary>
+    
         """
         GetDllLibPpt().IAudio_get_AudioCd.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_AudioCd.restype=c_void_p
@@ -142,10 +127,8 @@ class IAudio (  IShape) :
 
     def ShapeLocking(self)->'SlidePictureLocking':
         """
-    <summary>
         Gets shape's locks.
-            Readonly <see cref="T:Spire.Presentation.SlidePictureLocking" />.
-    </summary>
+        Readonly
         """
         GetDllLibPpt().IAudio_get_ShapeLocking.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_ShapeLocking.restype=c_void_p
@@ -158,9 +141,8 @@ class IAudio (  IShape) :
 
     def ShapeType(self)->'ShapeType':
         """
-    <summary>
         Returns or sets the AutoShape type.
-    </summary>
+    
         """
         GetDllLibPpt().IAudio_get_ShapeType.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_ShapeType.restype=c_int
@@ -177,10 +159,8 @@ class IAudio (  IShape) :
 
     def PictureFill(self)->'PictureFillFormat':
         """
-    <summary>
         Gets the PictureFillFormat object.
-            Read-only <see cref="T:Spire.Presentation.Drawing.PictureFillFormat" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().IAudio_get_PictureFill.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_PictureFill.restype=c_void_p
@@ -193,10 +173,8 @@ class IAudio (  IShape) :
 
     def ShapeStyle(self)->'ShapeStyle':
         """
-    <summary>
         Gets shape's style object.
-            Read-only <see cref="P:Spire.Presentation.IAudio.ShapeStyle" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().IAudio_get_ShapeStyle.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_ShapeStyle.restype=c_void_p
@@ -209,10 +187,8 @@ class IAudio (  IShape) :
 
     def Adjustments(self)->'ShapeAdjustCollection':
         """
-    <summary>
         Gets a collection of shape's adjustment values.
-            Readonly <see cref="T:Spire.Presentation.Collections.ShapeAdjustCollection" />.
-    </summary>
+        Readonly 
         """
         GetDllLibPpt().IAudio_get_Adjustments.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Adjustments.restype=c_void_p
@@ -224,10 +200,8 @@ class IAudio (  IShape) :
     @property
     def IsPlaceholder(self)->bool:
         """
-    <summary>
         Indicates whether the shape is Placeholder.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Read-only
         """
         GetDllLibPpt().IAudio_get_IsPlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_IsPlaceholder.restype=c_bool
@@ -238,10 +212,8 @@ class IAudio (  IShape) :
 
     def Placeholder(self)->'Placeholder':
         """
-    <summary>
         Gets the placeholder for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAudio.Placeholder" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().IAudio_get_Placeholder.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Placeholder.restype=c_void_p
@@ -254,10 +226,8 @@ class IAudio (  IShape) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
         Gets the shape's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().IAudio_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_TagsList.restype=c_void_p
@@ -270,10 +240,8 @@ class IAudio (  IShape) :
 
     def Frame(self)->'GraphicFrame':
         """
-    <summary>
         Gets or sets the shape frame's properties.
-            Read/write <see cref="T:Spire.Presentation.Drawing.GraphicFrame" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().IAudio_get_Frame.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Frame.restype=c_void_p
@@ -291,11 +259,10 @@ class IAudio (  IShape) :
 
     def Line(self)->'TextLineFormat':
         """
-    <summary>
         Gets the LineFormat object that contains line formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAudio.Line" />.
-            Note: can return null for certain types of shapes which don't have line properties.
-    </summary>
+        Read-only 
+        Note: can return null for certain types of shapes which don't have line properties.
+  
         """
         GetDllLibPpt().IAudio_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Line.restype=c_void_p
@@ -308,11 +275,10 @@ class IAudio (  IShape) :
 
     def ThreeD(self)->'FormatThreeD':
         """
-    <summary>
         Gets the ThreeDFormat object that 3d effect properties for a shape.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-            Note: can return null for certain types of shapes which don't have 3d properties.
-    </summary>
+        Read-only 
+        Note: can return null for certain types of shapes which don't have 3d properties.
+    
         """
         GetDllLibPpt().IAudio_get_ThreeD.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_ThreeD.restype=c_void_p
@@ -325,11 +291,10 @@ class IAudio (  IShape) :
 
     def EffectDag(self)->'EffectDag':
         """
-    <summary>
         Gets the EffectFormat object which contains pixel effects applied to a shape.
-            Read-only <see cref="P:Spire.Presentation.IAudio.EffectDag" />
-            Note: can return null for certain types of shapes which don't have effect properties.
-    </summary>
+        Read-only .
+        Note: can return null for certain types of shapes which don't have effect properties.
+    
         """
         GetDllLibPpt().IAudio_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_EffectDag.restype=c_void_p
@@ -342,11 +307,10 @@ class IAudio (  IShape) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
         Gets the FillFormat object that contains fill formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAudio.Fill" />.
-            Note: can return null for certain types of shapes which don't have fill properties.
-    </summary>
+        Read-only.
+        Note: can return null for certain types of shapes which don't have fill properties.
+    
         """
         GetDllLibPpt().IAudio_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Fill.restype=c_void_p
@@ -359,10 +323,8 @@ class IAudio (  IShape) :
 
     def Click(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse click.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_Click.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Click.restype=c_void_p
@@ -380,10 +342,8 @@ class IAudio (  IShape) :
 
     def MouseOver(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse over.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+          
         """
         GetDllLibPpt().IAudio_get_MouseOver.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_MouseOver.restype=c_void_p
@@ -400,10 +360,8 @@ class IAudio (  IShape) :
     @property
     def IsHidden(self)->bool:
         """
-    <summary>
         Indicates whether the shape is hidden.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_IsHidden.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_IsHidden.restype=c_bool
@@ -418,10 +376,8 @@ class IAudio (  IShape) :
     @property
     def IsPlayinBackground(self)->bool:
         """
-    <summary>
         Whether the audio plays in the background.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_IsPlayinBackground.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_IsPlayinBackground.restype=c_bool
@@ -437,10 +393,8 @@ class IAudio (  IShape) :
 
     def Parent(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+            
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().IAudio_get_Parent.argtypes=[c_void_p]
@@ -453,12 +407,10 @@ class IAudio (  IShape) :
     @property
     def ZOrderPosition(self)->int:
         """
-    <summary>
         Gets or sets 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/Write <see cref="T:System.Int32" />.
-    </summary>
+        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.
+   
         """
         GetDllLibPpt().IAudio_get_ZOrderPosition.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_ZOrderPosition.restype=c_int
@@ -473,12 +425,10 @@ class IAudio (  IShape) :
     @property
     def Rotation(self)->float:
         """
-    <summary>
         Gets 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 <see cref="T:System.Single" />.
-    </summary>
+        the z-axis. A positive value indicates clockwise rotation; a negative value
+        indicates counterclockwise rotation.
+            
         """
         GetDllLibPpt().IAudio_get_Rotation.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Rotation.restype=c_float
@@ -493,10 +443,8 @@ class IAudio (  IShape) :
     @property
     def Left(self)->float:
         """
-    <summary>
         Gets or sets the x-coordinate of the upper-left corner of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Left.restype=c_float
@@ -511,10 +459,8 @@ class IAudio (  IShape) :
     @property
     def Top(self)->float:
         """
-    <summary>
         Gets or sets the y-coordinate of the upper-left corner of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Top.restype=c_float
@@ -529,10 +475,8 @@ class IAudio (  IShape) :
     @property
     def Width(self)->float:
         """
-    <summary>
         Gets or sets the width of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+            
         """
         GetDllLibPpt().IAudio_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Width.restype=c_float
@@ -547,10 +491,8 @@ class IAudio (  IShape) :
     @property
     def Height(self)->float:
         """
-    <summary>
         Gets or sets the height of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+            
         """
         GetDllLibPpt().IAudio_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Height.restype=c_float
@@ -566,10 +508,8 @@ class IAudio (  IShape) :
 
     def AlternativeText(self)->str:
         """
-    <summary>
         Gets or sets the alternative text associated with a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+           
         """
         GetDllLibPpt().IAudio_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_AlternativeText.restype=c_void_p
@@ -587,10 +527,8 @@ class IAudio (  IShape) :
 
     def Name(self)->str:
         """
-    <summary>
         Gets or sets the name of a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+            
         """
         GetDllLibPpt().IAudio_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_Name.restype=c_void_p
@@ -608,10 +546,8 @@ class IAudio (  IShape) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+            
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().IAudio_get_Slide.argtypes=[c_void_p]
@@ -625,7 +561,10 @@ class IAudio (  IShape) :
 
     def Presentation(self)->'Presentation':
         """
+        Gets the parent Presentation object that contains this component.
 
+        Returns:
+            Presentation: The parent presentation instance
         """
         from spire.presentation import Presentation
         GetDllLibPpt().IAudio_get_Presentation.argtypes=[c_void_p]
@@ -638,10 +577,8 @@ class IAudio (  IShape) :
     @property
     def HideAtShowing(self)->bool:
         """
-    <summary>
         Indicates whether an Audio is hidden.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+            
         """
         GetDllLibPpt().IAudio_get_HideAtShowing.argtypes=[c_void_p]
         GetDllLibPpt().IAudio_get_HideAtShowing.restype=c_bool
@@ -655,18 +592,16 @@ class IAudio (  IShape) :
 
     def RemovePlaceholder(self):
         """
-    <summary>
         Removes placeholder from the shape.
-    </summary>
+   
         """
         GetDllLibPpt().IAudio_RemovePlaceholder.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IAudio_RemovePlaceholder,self.Ptr)
 
     def Dispose(self):
         """
-    <summary>
         Dispose object and free resources.
-    </summary>
+    
         """
         GetDllLibPpt().IAudio_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IAudio_Dispose,self.Ptr)

spire/presentation/IAudioData.py

@@ -8,15 +8,15 @@ import abc
 
 class IAudioData (SpireObject) :
     """
-
+    Represents embedded audio data with methods to access audio streams.
+    Provides audio content type information and saving capabilities.
     """
     @property
 
     def ContentType(self)->str:
         """
-    <summary>
-        Gets a MIME type of an audio.
-    </summary>
+        Gets MIME type of the audio (e.g., 'audio/mpeg').
+        Read-only string.
         """
         GetDllLibPpt().IAudioData_get_ContentType.argtypes=[c_void_p]
         GetDllLibPpt().IAudioData_get_ContentType.restype=c_void_p
@@ -24,29 +24,12 @@ class IAudioData (SpireObject) :
         return ret
 
 
-#    @property
-#
-#    def Data(self)->List['Byte']:
-#        """
-#    <summary>
-#        Gets the copy of an audio's data.
-#            Read-only <see cref="T:System.Byte" />[].
-#    </summary>
-#        """
-#        GetDllLibPpt().IAudioData_get_Data.argtypes=[c_void_p]
-#        GetDllLibPpt().IAudioData_get_Data.restype=IntPtrArray
-#        intPtrArray = CallCFunction(GetDllLibPpt().IAudioData_get_Data,self.Ptr)
-#        ret = GetVectorFromArray(intPtrArray, Byte)
-#        return ret
-
-
     @property
 
     def Stream(self)->'Stream':
         """
-    <summary>
-        Gets stream.
-    </summary>
+        Gets audio data as a stream.
+        Read-only Stream object.
         """
         GetDllLibPpt().IAudioData_get_Stream.argtypes=[c_void_p]
         GetDllLibPpt().IAudioData_get_Stream.restype=c_void_p
@@ -57,12 +40,7 @@ class IAudioData (SpireObject) :
 
 
     def GetStream(self)->'Stream':
-        """
-    <summary>
-        Gets stream from audio.
-    </summary>
-    <returns></returns>
-        """
+        """Returns audio data as a new Stream instance."""
         GetDllLibPpt().IAudioData_GetStream.argtypes=[c_void_p]
         GetDllLibPpt().IAudioData_GetStream.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().IAudioData_GetStream,self.Ptr)
@@ -73,10 +51,10 @@ class IAudioData (SpireObject) :
 
     def SaveToFile(self ,fileName:str):
         """
-    <summary>
-        Save audio to disk.
-    </summary>
-    <param name="fileName"></param>
+        Saves audio data to disk.
+        
+        Args:
+            fileName: Output file path
         """
         
         fileNamePtr = StrToPtr(fileName)