com.aspose.slides

Class CaptionsCollection

java.lang.Object

com.aspose.slides.CaptionsCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICaptions>, com.aspose.ms.System.Collections.IEnumerable<ICaptions>, ICaptionsCollection, java.lang.Iterable<ICaptions>

public final class CaptionsCollection
extends java.lang.Object
implements ICaptionsCollection

Represents a collection of the closed captions.

Method Summary

Modifier and Type	Method and Description
ICaptions	add(java.lang.String label, java.io.InputStream stream) Adds WebVTT closed captions to the end of the collection from a stream.
ICaptions	add(java.lang.String label, java.lang.String filePath) Adds WebVTT closed captions to the end of the collection.
void	clear() Removes all closed captions from the collection.
ICaptions	get_Item(int index) Returns the closed captions at the specified index.
int	getCount() Returns the number of elements in the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICaptions>	iterator() Returns an enumerator that iterates through the collection.
void	remove(ICaptions captions) Removes the specified closed captions from the collection.
void	removeAt(int index) Removes the closed captions at the specified index.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get_Item

public final ICaptions get_Item(int index)

Returns the closed captions at the specified index. Read-only ICaptions.

Specified by:

get_Item in interface ICaptionsCollection

add

public final ICaptions add(java.lang.String label,
                           java.lang.String filePath)

Adds WebVTT closed captions to the end of the collection.

Specified by:

add in interface ICaptionsCollection

Parameters:

label - The label of the closed captions.

filePath - The path to the WebVTT file.

Returns:

The added ICaptions instance.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown if filePath is null.

com.aspose.ms.System.ArgumentException - Thrown if filePath is empty.

add

public final ICaptions add(java.lang.String label,
                           java.io.InputStream stream)

Adds WebVTT closed captions to the end of the collection from a stream.

Specified by:

add in interface ICaptionsCollection

Parameters:

label - The label of the closed captions.

stream - The input stream containing data in WebVTT format.

Returns:

The added ICaptions instance.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown if stream is null.

com.aspose.ms.System.ArgumentException - Thrown if the input data is not in WebVTT format.

remove

public final void remove(ICaptions captions)

Removes the specified closed captions from the collection.

Specified by:

remove in interface ICaptionsCollection

Parameters:

captions - The closed captions to remove.

removeAt

public final void removeAt(int index)

Removes the closed captions at the specified index.

Specified by:

removeAt in interface ICaptionsCollection

Parameters:

index - The index of the closed captions to remove.

clear

public final void clear()

Removes all closed captions from the collection.

Specified by:

clear in interface ICaptionsCollection

getCount

public final int getCount()

Returns the number of elements in the collection. Read-only int.

Specified by:

getCount in interface ICaptionsCollection

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICaptions> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICaptions>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<ICaptions>

Specified by:

iterator in interface java.lang.Iterable<ICaptions>

Returns:

A System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.