Package org.schabi.newpipe.extractor.stream

Class AudioStream.Builder

java.lang.Object

org.schabi.newpipe.extractor.stream.AudioStream.Builder

Enclosing class:

AudioStream

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

Class to build AudioStream objects.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AudioStream	build()	Build an AudioStream using the builder's current values.
AudioStream.Builder	setAudioLocale(java.util.Locale audioLocale)	Set the Locale of the audio which represents its language.
AudioStream.Builder	setAudioTrackId(java.lang.String audioTrackId)	Set the audio track id of the AudioStream.
AudioStream.Builder	setAudioTrackName(java.lang.String audioTrackName)	Set the audio track name of the AudioStream.
AudioStream.Builder	setAudioTrackType(AudioTrackType audioTrackType)	Set the AudioTrackType of the AudioStream.
AudioStream.Builder	setAverageBitrate(int averageBitrate)	Set the average bitrate of the AudioStream.
AudioStream.Builder	setContent(java.lang.String content, boolean isUrl)	Set the content of the AudioStream.
AudioStream.Builder	setDeliveryMethod(DeliveryMethod deliveryMethod)	Set the DeliveryMethod of the AudioStream.
AudioStream.Builder	setId(java.lang.String id)	Set the identifier of the AudioStream.
AudioStream.Builder	setItagItem(ItagItem itagItem)	Set the ItagItem corresponding to the AudioStream.
AudioStream.Builder	setManifestUrl(java.lang.String manifestUrl)	Sets the URL of the manifest this stream comes from (if applicable, otherwise null).
AudioStream.Builder	setMediaFormat(MediaFormat mediaFormat)	Set the MediaFormat used by the AudioStream.

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

Method Detail

setId

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

Set the identifier of the AudioStream.

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 AudioStream, which must not be null

Returns:

this AudioStream.Builder instance

setContent

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

Set the content of the AudioStream.

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

Parameters:

content - the content of the AudioStream

isUrl - whether the content is a URL

Returns:

this AudioStream.Builder instance

setMediaFormat

public AudioStream.Builder setMediaFormat(@Nullable
                                          MediaFormat mediaFormat)

Set the MediaFormat used by the AudioStream.

It should be one of the audio MediaFormats (M4A, WEBMA, MP3, OPUS, OGG, or WEBMA_OPUS) but can be null if the media format could not be determined.

The default value is null.

Parameters:

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

Returns:

this AudioStream.Builder instance

setDeliveryMethod

public AudioStream.Builder setDeliveryMethod(@Nonnull
                                             DeliveryMethod deliveryMethod)

Set the DeliveryMethod of the AudioStream.

It must not be null.

The default delivery method is DeliveryMethod.PROGRESSIVE_HTTP.

Parameters:

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

Returns:

this AudioStream.Builder instance

setManifestUrl

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

setAverageBitrate

public AudioStream.Builder setAverageBitrate(int averageBitrate)

Set the average bitrate of the AudioStream.

The default value is AudioStream.UNKNOWN_BITRATE.

Parameters:

averageBitrate - the average bitrate of the AudioStream, which should positive

Returns:

this AudioStream.Builder instance

setAudioTrackId

public AudioStream.Builder setAudioTrackId(@Nullable
                                           java.lang.String audioTrackId)

Set the audio track id of the AudioStream.

The default value is null.

Parameters:

audioTrackId - the audio track id of the AudioStream, which can be null

Returns:

this AudioStream.Builder instance

setAudioTrackName

public AudioStream.Builder setAudioTrackName(@Nullable
                                             java.lang.String audioTrackName)

Set the audio track name of the AudioStream.

The default value is null.

Parameters:

audioTrackName - the audio track name of the AudioStream, which can be null

Returns:

this AudioStream.Builder instance

setAudioTrackType

public AudioStream.Builder setAudioTrackType(AudioTrackType audioTrackType)

Set the AudioTrackType of the AudioStream.

The default value is null.

Parameters:

audioTrackType - the audio track type of the AudioStream, which can be null

Returns:

this AudioStream.Builder instance

setAudioLocale

public AudioStream.Builder setAudioLocale(@Nullable
                                          java.util.Locale audioLocale)

Set the Locale of the audio which represents its language.

The default value is null, which means that the Locale is unknown.

Parameters:

audioLocale - the Locale of the audio, which could be null

Returns:

this AudioStream.Builder instance

setItagItem

public AudioStream.Builder setItagItem(@Nullable
                                       ItagItem itagItem)

Set the ItagItem corresponding to the AudioStream.

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 AudioStream, which can be null

Returns:

this AudioStream.Builder instance

build

@Nonnull
public AudioStream build()

Build an AudioStream using the builder's current values.

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

Returns:

a new AudioStream using the builder's current values

Throws:

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