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 at the specified index.
add(String label, String filePath)	Adds WebVTT closed captions to the end of the collection.
add(String label, InputStream stream)	Adds WebVTT closed captions to the end of the collection from a stream.
remove(ICaptions captions)	Removes the specified closed captions from the collection.
removeAt(int index)	Removes the closed captions at the specified index.
clear()	Removes all closed captions from the collection.
getCount()	Returns the number of elements in the collection.

get_Item(int index)

public abstract ICaptions get_Item(int index)

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

Parameters:

Parameter	Type	Description
index	int

Returns: ICaptions

add(String label, String filePath)

public abstract ICaptions add(String label, String filePath)

Adds WebVTT closed captions to the end of the collection.

Parameters:

Parameter	Type	Description
label	java.lang.String	The label of the closed captions.
filePath	java.lang.String	The path to the WebVTT file.

Returns: ICaptions - The added ICaptions instance.

add(String label, InputStream stream)

public abstract ICaptions add(String label, InputStream stream)

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

Parameters:

Parameter	Type	Description
label	java.lang.String	The label of the closed captions.
stream	java.io.InputStream	The input stream containing data in WebVTT format.

Returns: ICaptions - The added ICaptions instance.

remove(ICaptions captions)

public abstract void remove(ICaptions captions)

Removes the specified closed captions from the collection.

Parameters:

Parameter	Type	Description
captions	ICaptions	The closed captions to remove.

removeAt(int index)

public abstract void removeAt(int index)

Removes the closed captions at the specified index.

Parameters:

Parameter	Type	Description
index	int	The index of the closed captions to remove.

clear()

public abstract void clear()

Removes all closed captions from the collection.

getCount()

public abstract int getCount()

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

Returns: int