Package org.schabi.newpipe.extractor.stream

Class VideoStream.Builder

java.lang.Object

org.schabi.newpipe.extractor.stream.VideoStream.Builder

Enclosing class:

VideoStream

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

Class to build VideoStream objects.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
VideoStream	build()	Build a VideoStream using the builder's current values.
VideoStream.Builder	setContent(java.lang.String content, boolean isUrl)	Set the content of the VideoStream.
VideoStream.Builder	setDeliveryMethod(DeliveryMethod deliveryMethod)	Set the DeliveryMethod of the VideoStream.
VideoStream.Builder	setId(java.lang.String id)	Set the identifier of the VideoStream.
VideoStream.Builder	setIsVideoOnly(boolean isVideoOnly)	Set whether the VideoStream is video-only.
VideoStream.Builder	setItagItem(ItagItem itagItem)	Set the ItagItem corresponding to the VideoStream.
VideoStream.Builder	setManifestUrl(java.lang.String manifestUrl)	Sets the URL of the manifest this stream comes from (if applicable, otherwise null).
VideoStream.Builder	setMediaFormat(MediaFormat mediaFormat)	Set the MediaFormat used by the VideoStream.
VideoStream.Builder	setResolution(java.lang.String resolution)	Set the resolution of the VideoStream.

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 VideoStream.Builder instance with its default values.

Method Detail

setId

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

Set the identifier of the VideoStream.

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

If you are not able to get an identifier, use the static constant ID_UNKNOWN of the Stream class.

Parameters:

id - the identifier of the VideoStream, which must not be null

Returns:

this VideoStream.Builder instance

setContent

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

Set the content of the VideoStream.

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

Parameters:

content - the content of the VideoStream

isUrl - whether the content is a URL

Returns:

this VideoStream.Builder instance

setMediaFormat

public VideoStream.Builder setMediaFormat(@Nullable
                                          MediaFormat mediaFormat)

Set the MediaFormat used by the VideoStream.

It should be one of the video MediaFormats (MPEG_4, v3GPP, or WEBM) but can be null if the media format could not be determined.

The default value is null.

Parameters:

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

Returns:

this VideoStream.Builder instance

setDeliveryMethod

public VideoStream.Builder setDeliveryMethod(@Nonnull
                                             DeliveryMethod deliveryMethod)

Set the DeliveryMethod of the VideoStream.

It must not be null.

The default delivery method is DeliveryMethod.PROGRESSIVE_HTTP.

Parameters:

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

Returns:

this VideoStream.Builder instance

setManifestUrl

public VideoStream.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 VideoStream.Builder instance

setIsVideoOnly

public VideoStream.Builder setIsVideoOnly(boolean isVideoOnly)

Set whether the VideoStream is video-only.

This property must be set before building the VideoStream.

Parameters:

isVideoOnly - whether the VideoStream is video-only

Returns:

this VideoStream.Builder instance

setResolution

public VideoStream.Builder setResolution(@Nonnull
                                         java.lang.String resolution)

Set the resolution of the VideoStream.

This resolution can be used by clients to know the quality of the video stream.

If you are not able to know the resolution, you should use VideoStream.RESOLUTION_UNKNOWN as the resolution of the video stream.

It must be set before building the builder and not null.

Parameters:

resolution - the resolution of the VideoStream

Returns:

this VideoStream.Builder instance

setItagItem

public VideoStream.Builder setItagItem(@Nullable
                                       ItagItem itagItem)

Set the ItagItem corresponding to the VideoStream.

ItagItems are YouTube specific objects, so they are only known for this service and can be null.

The default value is null.

Parameters:

itagItem - the ItagItem of the VideoStream, which can be null

Returns:

this VideoStream.Builder instance

build

@Nonnull
public VideoStream build()

Build a VideoStream using the builder's current values.

The identifier, the content (and so the isUrl boolean), the isVideoOnly and the resolution properties must have been set.

Returns:

a new VideoStream using the builder's current values

Throws:

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