add method

Contents
[ ]

add

Adds WebVTT closed captions to the end of the collection.

Returns

The added ICaptions instance.

def add(self, label, file_path):
    ...
ParameterTypeDescription
labelstrThe label of the closed captions.
file_pathstrThe path to the WebVTT file.

Exceptions

ExceptionDescription
RuntimeError(Proxy error(ArgumentNullException))Thrown if file_path is None.
RuntimeError(Proxy error(ArgumentException))Thrown if file_path is empty.

add

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

Returns

The added ICaptions instance.

def add(self, label, stream):
    ...
ParameterTypeDescription
labelstrThe label of the closed captions.
streamio.RawIOBaseThe input stream containing data in WebVTT format.

Exceptions

ExceptionDescription
RuntimeError(Proxy error(ArgumentNullException))Thrown if stream is None.
RuntimeError(Proxy error(ArgumentException))Thrown if the input data is not in WebVTT format.

See Also