Package org.schabi.newpipe.extractor.stream

Class SubtitlesStream.Builder

java.lang.Object

org.schabi.newpipe.extractor.stream.SubtitlesStream.Builder

Enclosing class:

SubtitlesStream

public static final class SubtitlesStream.Builder
extends java.lang.Object

Class to build SubtitlesStream objects.

Constructor Summary

Constructors

Constructor	Description
Builder()	Create a new SubtitlesStream.Builder instance with default values.

Method Summary

Modifier and Type	Method	Description
SubtitlesStream	build()	Build a SubtitlesStream using the builder's current values.
SubtitlesStream.Builder	setAutoGenerated(boolean autoGenerated)	Set whether the subtitles have been auto-generated by the streaming service.
SubtitlesStream.Builder	setContent(java.lang.String content, boolean isUrl)	Set the content of the SubtitlesStream.
SubtitlesStream.Builder	setDeliveryMethod(DeliveryMethod deliveryMethod)	Set the DeliveryMethod of the SubtitlesStream.
SubtitlesStream.Builder	setId(java.lang.String id)	Set the identifier of the SubtitlesStream.
SubtitlesStream.Builder	setLanguageCode(java.lang.String languageCode)	Set the language code of the SubtitlesStream.
SubtitlesStream.Builder	setManifestUrl(java.lang.String manifestUrl)	Sets the URL of the manifest this stream comes from (if applicable, otherwise null).
SubtitlesStream.Builder	setMediaFormat(MediaFormat mediaFormat)	Set the MediaFormat used by the SubtitlesStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a new SubtitlesStream.Builder instance with default values.

Method Detail

setId

public SubtitlesStream.Builder setId(@Nonnull
                                     java.lang.String id)

Set the identifier of the SubtitlesStream.

Parameters:

id - the identifier of the SubtitlesStream, which should not be null (otherwise the fallback to create the identifier will be used when building the builder)

Returns:

this SubtitlesStream.Builder instance

setContent

public SubtitlesStream.Builder setContent(@Nonnull
                                          java.lang.String content,
                                          boolean isUrl)

Set the content of the SubtitlesStream.

It must not be null, and should be non empty.

Parameters:

content - the content of the SubtitlesStream, which must not be null

isUrl - whether the content is a URL

Returns:

this SubtitlesStream.Builder instance

setMediaFormat

public SubtitlesStream.Builder setMediaFormat(@Nullable
                                              MediaFormat mediaFormat)

Set the MediaFormat used by the SubtitlesStream.

It should be one of the subtitles MediaFormats (SRT, TRANSCRIPT1, TRANSCRIPT2, TRANSCRIPT3, TTML, or VTT) but can be null if the media format could not be determined.

The default value is null.

Parameters:

mediaFormat - the MediaFormat of the SubtitlesStream, which can be null

Returns:

this SubtitlesStream.Builder instance

setDeliveryMethod

public SubtitlesStream.Builder setDeliveryMethod(@Nonnull
                                                 DeliveryMethod deliveryMethod)

Set the DeliveryMethod of the SubtitlesStream.

It must not be null.

The default delivery method is DeliveryMethod.PROGRESSIVE_HTTP.

Parameters:

deliveryMethod - the DeliveryMethod of the SubtitlesStream, which must not be null

Returns:

this SubtitlesStream.Builder instance

setManifestUrl

public SubtitlesStream.Builder setManifestUrl(@Nullable
                                              java.lang.String manifestUrl)

Sets the URL of the manifest this stream comes from (if applicable, otherwise null).

Parameters:

manifestUrl - the URL of the manifest this stream comes from or null

Returns:

this SubtitlesStream.Builder instance

setLanguageCode

public SubtitlesStream.Builder setLanguageCode(@Nonnull
                                               java.lang.String languageCode)

Set the language code of the SubtitlesStream.

It must not be null and should not be an empty string.

Parameters:

languageCode - the language code of the SubtitlesStream

Returns:

this SubtitlesStream.Builder instance

setAutoGenerated

public SubtitlesStream.Builder setAutoGenerated(boolean autoGenerated)

Set whether the subtitles have been auto-generated by the streaming service.

Parameters:

autoGenerated - whether the subtitles have been generated by the streaming service

Returns:

this SubtitlesStream.Builder instance

build

@Nonnull
public SubtitlesStream build()
                      throws ParsingException

Build a SubtitlesStream using the builder's current values.

The content (and so the isUrl boolean), the language code and the isAutoGenerated properties must have been set.

If no identifier has been set, an identifier will be generated using the language code and the media format suffix, if the media format is known.

Returns:

a new SubtitlesStream using the builder's current values

Throws:

java.lang.IllegalStateException - if id, content (and so isUrl), deliveryMethod, languageCode or the isAutogenerated have been not set, or have been set as null

ParsingException