Skip to content

Commit 2a01fae

Browse files
petrtetenkopetrtetenko
committed
Aspose.Slides for Android 25.9 API references
1 parent a5d9087 commit 2a01fae

File tree

46 files changed

+2881
-1175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2881
-1175
lines changed

‎content/androidjava/english/com.aspose.slides/_index.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ url: /com.aspose.slides/
6262
| [BlackWhiteMode](../com.aspose.slides/blackwhitemode) | Determines how colored shape should be transformed into black and white. |
6363
| [BlobManagementOptions](../com.aspose.slides/blobmanagementoptions) | Represents options which can be used to manage BLOB handling rules and other BLOB settings. |
6464
| [Blur](../com.aspose.slides/blur) | Represents a Blur effect that is applied to the entire shape, including its fill. |
65+
| [BrightnessContrast](../com.aspose.slides/brightnesscontrast) | Represents a BrightnessContrast effect. |
6566
| [BrowsedAtKiosk](../com.aspose.slides/browsedatkiosk) | Browsed at a kiosk (full screen) |
6667
| [BrowsedByIndividual](../com.aspose.slides/browsedbyindividual) | Browsed by individual (window) |
6768
| [BubbleSizeRepresentationType](../com.aspose.slides/bubblesizerepresentationtype) | Specifies the possible ways to represent data as bubble chart sizes. |
@@ -192,6 +193,9 @@ url: /com.aspose.slides/
192193
| [ErrorBarValueType](../com.aspose.slides/errorbarvaluetype) | Represents type of error bar value |
193194
| [ErrorBarsCustomValues](../com.aspose.slides/errorbarscustomvalues) | Specifies the errors bar values. |
194195
| [ErrorBarsFormat](../com.aspose.slides/errorbarsformat) | Represents error bars of chart series. |
196+
| [ExcelDataCell](../com.aspose.slides/exceldatacell) | Represents a single cell in an Excel workbook. |
197+
| [ExcelDataWorkbook](../com.aspose.slides/exceldataworkbook) | Represents a workbook that provides access to Excel data for general use. |
198+
| [ExcelWorkbookImporter](../com.aspose.slides/excelworkbookimporter) | Provides functionality for importing content from an Excel workbook into a presentation. |
195199
| [ExternalResourceResolver](../com.aspose.slides/externalresourceresolver) | Callback class used to resolve external resources during Html, Svg documents import. |
196200
| [ExtraColorScheme](../com.aspose.slides/extracolorscheme) | Represents an additional color scheme which can be assigned to a slide. |
197201
| [ExtraColorSchemeCollection](../com.aspose.slides/extracolorschemecollection) | Represents a collection of additional color schemes. |
@@ -275,6 +279,7 @@ url: /com.aspose.slides/
275279
| [Ink](../com.aspose.slides/ink) | Represents an ink object on a slide. |
276280
| [InkActions](../com.aspose.slides/inkactions) | Represents the root of ink actions. |
277281
| [InkBrush](../com.aspose.slides/inkbrush) | Represents an inkBrush object. |
282+
| [InkEffectType](../com.aspose.slides/inkeffecttype) | Specifies a set of predefined visual effects for ink rendering. |
278283
| [InkOptions](../com.aspose.slides/inkoptions) | Provides options that control the look of Ink objects in exported document. |
279284
| [InkTrace](../com.aspose.slides/inktrace) | Represents an Trace object. |
280285
| [InnerShadow](../com.aspose.slides/innershadow) | Represents a Inner Shadow effect. |
@@ -473,6 +478,7 @@ url: /com.aspose.slides/
473478
| [PptxUnsupportedFormatException](../com.aspose.slides/pptxunsupportedformatexception) | Exception which thrown when presentation file format is unsupported. |
474479
| [Presentation](../com.aspose.slides/presentation) | Represents a Microsoft PowerPoint presentation. |
475480
| [PresentationAnimationsGenerator](../com.aspose.slides/presentationanimationsgenerator) | Represents a generator of the animations in the [Presentation](../com.aspose.slides/presentation). |
481+
| [PresentationContentAmountType](../com.aspose.slides/presentationcontentamounttype) | Specifies the amount of content included in the generated presentation, influencing both the number of slides and the level of detail per slide. |
476482
| [PresentationFactory](../com.aspose.slides/presentationfactory) | Allows to create presentation via COM interface |
477483
| [PresentationHeaderFooterManager](../com.aspose.slides/presentationheaderfootermanager) | Represents manager which holds behavior of all footer, date-time and page number placeholders of presentation. |
478484
| [PresentationInfo](../com.aspose.slides/presentationinfo) | Information about presentation file |
@@ -517,7 +523,7 @@ url: /com.aspose.slides/
517523
| [Shape](../com.aspose.slides/shape) | Represents a shape on a slide. |
518524
| [ShapeAdjustmentType](../com.aspose.slides/shapeadjustmenttype) | Specifies different types of shape adjustment values. |
519525
| [ShapeBevel](../com.aspose.slides/shapebevel) | Contains the properties of shape's main face relief. |
520-
| [ShapeCollection](../com.aspose.slides/shapecollection) | Represents a collection of a shapes. |
526+
| [ShapeCollection](../com.aspose.slides/shapecollection) | Represents a collection of shapes. |
521527
| [ShapeElement](../com.aspose.slides/shapeelement) | Represents a part of shape with same outline and fill properties. |
522528
| [ShapeElementFillSource](../com.aspose.slides/shapeelementfillsource) | Represents how shape element should be filled. |
523529
| [ShapeElementStrokeSource](../com.aspose.slides/shapeelementstrokesource) | Represents how shape element should be drawn. |
@@ -539,7 +545,7 @@ url: /com.aspose.slides/
539545
| [SlideShowSettings](../com.aspose.slides/slideshowsettings) | Represents the slide show settings for the presentation. |
540546
| [SlideShowTransition](../com.aspose.slides/slideshowtransition) | Represents slide show transition. |
541547
| [SlideShowType](../com.aspose.slides/slideshowtype) | Base slide show settings. |
542-
| [SlideSize](../com.aspose.slides/slidesize) | Represents a size of slide. |
548+
| [SlideSize](../com.aspose.slides/slidesize) | Represents the size and orientation of a slide. |
543549
| [SlideSizeScaleType](../com.aspose.slides/slidesizescaletype) | Represents the scale type of slide content. |
544550
| [SlideSizeType](../com.aspose.slides/slidesizetype) | Represents the slide size preset. |
545551
| [SlideThemeManager](../com.aspose.slides/slidethememanager) | Provides access to slide theme overriden. |
@@ -661,6 +667,7 @@ url: /com.aspose.slides/
661667

662668
| Interface | Description |
663669
| --- | --- |
670+
| [IAIConversation](../com.aspose.slides/iaiconversation) | Represents a conversation instance. |
664671
| [IAIWebClient](../com.aspose.slides/iaiwebclient) | AI Web client interface. |
665672
| [IAccessiblePVIObject<T>](../com.aspose.slides/iaccessiblepviobject) | Represents a type that can return corresponding effective data with the inheritance applied. |
666673
| [IActualLayout](../com.aspose.slides/iactuallayout) | Specifies actual position of a chart element. |
@@ -711,6 +718,8 @@ url: /com.aspose.slides/
711718
| [IBlobManagementOptions](../com.aspose.slides/iblobmanagementoptions) | A Binary Large Object (BLOB) is a binary data stored as a single entity - i.e. |
712719
| [IBlur](../com.aspose.slides/iblur) | Represents a Blur effect that is applied to the entire shape, including its fill. |
713720
| [IBlurEffectiveData](../com.aspose.slides/iblureffectivedata) | Immutable object which represents a Blur effect that is applied to the entire shape, including its fill. |
721+
| [IBrightnessContrast](../com.aspose.slides/ibrightnesscontrast) | Represents a BrightnessContrast effect. |
722+
| [IBrightnessContrastEffectiveData](../com.aspose.slides/ibrightnesscontrasteffectivedata) | Immutable object which represents a BrightnessContrast effect. |
714723
| [IBulkTextFormattable](../com.aspose.slides/ibulktextformattable) | Represents an object with possibility of bulk setting child text elements' formats. |
715724
| [IBulletFormat](../com.aspose.slides/ibulletformat) | Represents paragraph bullet formatting properties. |
716725
| [IBulletFormatEffectiveData](../com.aspose.slides/ibulletformateffectivedata) | Immutable object which contains effective paragraph bullet formatting properties. |
@@ -809,6 +818,8 @@ url: /com.aspose.slides/
809818
| [IEmptyTransition](../com.aspose.slides/iemptytransition) | Empty slide transition effect. |
810819
| [IErrorBarsCustomValues](../com.aspose.slides/ierrorbarscustomvalues) | Specifies the errors bar values. |
811820
| [IErrorBarsFormat](../com.aspose.slides/ierrorbarsformat) | Represents error bars of chart series. |
821+
| [IExcelDataCell](../com.aspose.slides/iexceldatacell) | Represents a single cell in an Excel workbook. |
822+
| [IExcelDataWorkbook](../com.aspose.slides/iexceldataworkbook) | Represents a workbook that provides access to Excel data for general use. |
812823
| [IExternalResourceResolver](../com.aspose.slides/iexternalresourceresolver) | Callback interface used to resolve external resources during Html, Svg documents import. |
813824
| [IExtraColorScheme](../com.aspose.slides/iextracolorscheme) | Represents an additional color scheme which can be assigned to a slide. |
814825
| [IExtraColorSchemeCollection](../com.aspose.slides/iextracolorschemecollection) | Represents a collection of additional color schemes. |
@@ -1070,7 +1081,7 @@ url: /com.aspose.slides/
10701081
| [IShape](../com.aspose.slides/ishape) | Represents a shape on a slide. |
10711082
| [IShapeBevel](../com.aspose.slides/ishapebevel) | Represents properties of shape's main face relief. |
10721083
| [IShapeBevelEffectiveData](../com.aspose.slides/ishapebeveleffectivedata) | Immutable object which contains effective shape's face relief properties. |
1073-
| [IShapeCollection](../com.aspose.slides/ishapecollection) | Represents a collection of a shapes. |
1084+
| [IShapeCollection](../com.aspose.slides/ishapecollection) | Represents a collection of shapes. |
10741085
| [IShapeElement](../com.aspose.slides/ishapeelement) | Represents a part of shape with same outline and fill properties. |
10751086
| [IShapeFrame](../com.aspose.slides/ishapeframe) | Represents shape frame's properties. |
10761087
| [IShapeStyle](../com.aspose.slides/ishapestyle) | Represent shape's style reference. |
@@ -1085,7 +1096,7 @@ url: /com.aspose.slides/
10851096
| [ISlideHeaderFooterManager](../com.aspose.slides/islideheaderfootermanager) | Represents manager which holds behavior of the slide footer, date-time, page number placeholders. |
10861097
| [ISlideImageFormat](../com.aspose.slides/islideimageformat) | Determines format in which slide image will be saved for presentation to HTML export. |
10871098
| [ISlideShowTransition](../com.aspose.slides/islideshowtransition) | Represents slide show transition. |
1088-
| [ISlideSize](../com.aspose.slides/islidesize) | Represents a size of slide. |
1099+
| [ISlideSize](../com.aspose.slides/islidesize) | Represents the size and orientation of a slide. |
10891100
| [ISlideText](../com.aspose.slides/islidetext) | Represents the text extracted from the slide |
10901101
| [ISlidesLayoutOptions](../com.aspose.slides/islideslayoutoptions) | Represents the presentation layout mode for export. |
10911102
| [ISlidesPicture](../com.aspose.slides/islidespicture) | Represents a picture in a presentation. |

‎content/androidjava/english/com.aspose.slides/audioframe/_index.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Represents an audio clip on a slide.
8282
| [setTrimFromStart(float value)](#setTrimFromStart-float-) | Specifies the time duration to be removed from the beginning of the media during playback, in milliseconds. |
8383
| [getTrimFromEnd()](#getTrimFromEnd--) | Specifies the time duration to be removed from the end of the media during playback, in milliseconds. |
8484
| [setTrimFromEnd(float value)](#setTrimFromEnd-float-) | Specifies the time duration to be removed from the end of the media during playback, in milliseconds. |
85+
| [getCaptionTracks()](#getCaptionTracks--) | Gets the collection of closed captions associated with the audio frame. |
8586
### getAudioCdStartTrack() {#getAudioCdStartTrack--}
8687
```
8788
public final int getAudioCdStartTrack()
@@ -731,3 +732,38 @@ Specifies the time duration to be removed from the end of the media during playb
731732
| --- | --- | --- |
732733
| value | float | |
733734
735+
### getCaptionTracks() {#getCaptionTracks--}
736+
```
737+
public final ICaptionsCollection getCaptionTracks()
738+
```
739+
740+
741+
Gets the collection of closed captions associated with the audio frame. This property is read-only and returns an [ICaptionsCollection](../../com.aspose.slides/icaptionscollection) containing all caption tracks.
742+
743+
--------------------
744+
745+
> ```
746+
> Example:
747+
>
748+
> Presentation pres = new Presentation("audio with captions.pptx");
749+
> try {
750+
> for (IShape shape : pres.getSlides().get_Item(0).getShapes())
751+
> {
752+
> if (shape instanceof IAudioFrame)
753+
> {
754+
> IAudioFrame audioFrame = (IAudioFrame) shape;
755+
> // Save the caption track's binary data as a .vtt file
756+
> for (ICaptions captionTrack : audioFrame.getCaptionTracks()) {
757+
> FileOutputStream fos = new FileOutputStream(captionTrack.getCaptionId() + ".vtt");
758+
> fos.write(captionTrack.getBinaryData());
759+
> fos.close();
760+
> }
761+
> }
762+
> }
763+
> } finally {
764+
> if (pres != null) pres.dispose();
765+
> }
766+
> ```
767+
768+
**Returns:**
769+
[ICaptionsCollection](../../com.aspose.slides/icaptionscollection)

‎content/androidjava/english/com.aspose.slides/blobmanagementoptions/_index.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Represents options which can be used to manage BLOB handling rules and other BLO
3030
| [setTemporaryFilesAllowed(boolean value)](#setTemporaryFilesAllowed-boolean-) | This property defines if temporary files can be created while working with BLOBs, what greatly decreases the memory consumption but requires permissions to create files. |
3131
| [getTempFilesRootPath()](#getTempFilesRootPath--) | The root path where temporary files will be created. |
3232
| [setTempFilesRootPath(String value)](#setTempFilesRootPath-java.lang.String-) | The root path where temporary files will be created. |
33-
| [getMaxBlobsBytesInMemory()](#getMaxBlobsBytesInMemory--) | Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. |
34-
| [setMaxBlobsBytesInMemory(long value)](#setMaxBlobsBytesInMemory-long-) | Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. |
33+
| [getMaxBlobsBytesInMemory()](#getMaxBlobsBytesInMemory--) | Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. |
34+
| [setMaxBlobsBytesInMemory(long value)](#setMaxBlobsBytesInMemory-long-) | Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. |
3535
### BlobManagementOptions() {#BlobManagementOptions--}
3636
```
3737
public BlobManagementOptions()
@@ -123,15 +123,19 @@ public final long getMaxBlobsBytesInMemory()
123123
```
124124

125125

126-
Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. First, all BLOBs loading into memory as default behavior and only when it reaches the limit defined by this property, other mechanisms (such as temporary files) can be involved. In terms of performance, the most efficient way is storing BLOBs in memory, but from the other side, it leads to a high memory consumption what may be undesirable. Using this property, you may set the optimal behavior for your environment or other requirements.
126+
Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. By default, all BLOBs are loaded into memory; only once this limit is reached are alternative mechanisms (such as temporary files) employed. Keeping BLOBs in memory maximizes performance but can lead to high memory usage. Use this property to tailor behavior to your environment or requirements.
127127

128128
--------------------
129129

130-
This property will be ignored if IsTemporaryFilesAllowed (\#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean)) is set to false. It makes no sense to limit the maximum BLOBs in memory, because if IsTemporaryFilesAllowed (\#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean)) is set to false, the memory is the only place where BLOBs can be stored.
130+
This property is ignored if \#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean) is set to false, since memory is then the only storage location available and limiting in-memory BLOB usage has no effect.
131131

132132
--------------------
133133

134-
Default value is 629,145,600 bytes (600Mb).
134+
The default value is 629,145,600 bytes (600 MB).
135+
136+
--------------------
137+
138+
You may set this property to zero, but a small minimum amount of memory will still be reserved.
135139

136140
**Returns:**
137141
long
@@ -141,15 +145,19 @@ public final void setMaxBlobsBytesInMemory(long value)
141145
```
142146

143147

144-
Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. First, all BLOBs loading into memory as default behavior and only when it reaches the limit defined by this property, other mechanisms (such as temporary files) can be involved. In terms of performance, the most efficient way is storing BLOBs in memory, but from the other side, it leads to a high memory consumption what may be undesirable. Using this property, you may set the optimal behavior for your environment or other requirements.
148+
Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. By default, all BLOBs are loaded into memory; only once this limit is reached are alternative mechanisms (such as temporary files) employed. Keeping BLOBs in memory maximizes performance but can lead to high memory usage. Use this property to tailor behavior to your environment or requirements.
149+
150+
--------------------
151+
152+
This property is ignored if \#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean) is set to false, since memory is then the only storage location available and limiting in-memory BLOB usage has no effect.
145153

146154
--------------------
147155

148-
This property will be ignored if IsTemporaryFilesAllowed (\#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean)) is set to false. It makes no sense to limit the maximum BLOBs in memory, because if IsTemporaryFilesAllowed (\#isTemporaryFilesAllowed.isTemporaryFilesAllowed/\#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean)) is set to false, the memory is the only place where BLOBs can be stored.
156+
The default value is 629,145,600 bytes (600 MB).
149157

150158
--------------------
151159

152-
Default value is 629,145,600 bytes (600Mb).
160+
You may set this property to zero, but a small minimum amount of memory will still be reserved.
153161

154162
**Parameters:**
155163
| Parameter | Type | Description |

‎content/androidjava/english/com.aspose.slides/brightnesscontrast/_index.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: BrightnessContrast
3+
second_title: Aspose.Slides for Android via Java API Reference
4+
description: Represents a BrightnessContrast effect.
5+
type: docs
6+
url: /com.aspose.slides/brightnesscontrast/
7+
---
8+
**Inheritance:**
9+
java.lang.Object, [com.aspose.slides.PVIObject](../../com.aspose.slides/pviobject), [com.aspose.slides.ImageTransformOperation](../../com.aspose.slides/imagetransformoperation)
10+
11+
**All Implemented Interfaces:**
12+
[com.aspose.slides.IBrightnessContrast](../../com.aspose.slides/ibrightnesscontrast), com.aspose.slides.IVisualEffect
13+
```
14+
public final class BrightnessContrast extends ImageTransformOperation implements IBrightnessContrast, IVisualEffect
15+
```
16+
17+
Represents a BrightnessContrast effect. Ajusts brightness and contrast
18+
## Methods
19+
20+
| Method | Description |
21+
| --- | --- |
22+
| [getEffective()](#getEffective--) | Gets effective BrightnessContrast effect data with the inheritance applied. |
23+
| [equals(Object obj)](#equals-java.lang.Object-) | Determines whether the specified [BrightnessContrast](../../com.aspose.slides/brightnesscontrast) is equal to the current [BrightnessContrast](../../com.aspose.slides/brightnesscontrast). |
24+
| [hashCode()](#hashCode--) | Serves as a hash function for a particular type. |
25+
### getEffective() {#getEffective--}
26+
```
27+
public final IBrightnessContrastEffectiveData getEffective()
28+
```
29+
30+
31+
Gets effective BrightnessContrast effect data with the inheritance applied.
32+
33+
**Returns:**
34+
[IBrightnessContrastEffectiveData](../../com.aspose.slides/ibrightnesscontrasteffectivedata) - A [IBrightnessContrastEffectiveData](../../com.aspose.slides/ibrightnesscontrasteffectivedata).
35+
### equals(Object obj) {#equals-java.lang.Object-}
36+
```
37+
public boolean equals(Object obj)
38+
```
39+
40+
41+
Determines whether the specified [BrightnessContrast](../../com.aspose.slides/brightnesscontrast) is equal to the current [BrightnessContrast](../../com.aspose.slides/brightnesscontrast).
42+
43+
**Parameters:**
44+
| Parameter | Type | Description |
45+
| --- | --- | --- |
46+
| obj | java.lang.Object | The [BrightnessContrast](../../com.aspose.slides/brightnesscontrast) to compare. |
47+
48+
**Returns:**
49+
boolean - true if objects are equal; otherwise, false.
50+
### hashCode() {#hashCode--}
51+
```
52+
public int hashCode()
53+
```
54+
55+
56+
Serves as a hash function for a particular type.
57+
58+
**Returns:**
59+
int - A hash code for the current object.

0 commit comments

Comments
 (0)