ICaptionsCollection

All Implemented Interfaces: com.aspose.ms.System.Collections.Generic.IGenericEnumerable

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

Represents a collection of the closed captions.

Methods

Method	Description
get_Item(int index)	Returns the closed captions by index.
add(String label, String filePath)	Adds WebVTT closed captions at the end of the collection.
add(String label, InputStream stream)	Adds WebVTT closed captions at the end of the collection.
remove(ICaptions captions)	Removes the closed captions from the collection.
removeAt(int index)	Removes the closed captions at the specified index.
clear()	Removes all elements from the collection.
getCount()	Returns the number of elements in the collection.

public abstract ICaptions get_Item(int index)

Returns the closed captions by index. Read-only ICaptions.

Parameters:

Parameter	Type	Description
index	int

Returns: ICaptions

public abstract ICaptions add(String label, String filePath)

Adds WebVTT closed captions at the end of the collection.

Parameters:

Parameter	Type	Description
label	java.lang.String	Label of the closed captions.
filePath	java.lang.String	Path to the file in WebVTT format.

Returns: ICaptions

public abstract ICaptions add(String label, InputStream stream)

Adds WebVTT closed captions at the end of the collection.

Parameters:

Parameter	Type	Description
label	java.lang.String	Label of the closed captions.
stream	java.io.InputStream	Input stream with data in WebVTT format.

Returns: ICaptions

public abstract void remove(ICaptions captions)

Removes the closed captions from the collection.

Parameters:

Parameter	Type	Description
captions	ICaptions	Captions object that should be deleted.

public abstract void removeAt(int index)

Removes the closed captions at the specified index.

Parameters:

Parameter	Type	Description
index	int	Index of the closed captions that should be deleted.

public abstract void clear()

Removes all elements from the collection.

public abstract int getCount()

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

Returns: int