com.aspose.slides

Interface ICaptionsCollection

All Superinterfaces:

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

All Known Implementing Classes:

CaptionsCollection

public interface ICaptionsCollection
extends com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICaptions>

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.
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 interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get_Item

ICaptions get_Item(int index)

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

add

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

Adds WebVTT closed captions to the end of the collection.

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 } is empty.

add

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

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

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

void remove(ICaptions captions)

Removes the specified closed captions from the collection.

Parameters:

captions - The closed captions to remove.

removeAt

void removeAt(int index)

Removes the closed captions at the specified index.

Parameters:

index - The index of the closed captions to remove.

clear

void clear()

Removes all closed captions from the collection.

getCount

int getCount()

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