Package org.javacord.api.audio

Class SilentAudioSource

java.lang.Object

org.javacord.api.audio.AudioSourceBase

org.javacord.api.audio.SilentAudioSource

All Implemented Interfaces:

AudioSource, PauseableAudioSource, SeekableAudioSource, AudioSourceAttachableListenerManager, Specializable<AudioSource>

public class SilentAudioSource
extends AudioSourceBase
implements PauseableAudioSource, SeekableAudioSource

A silent audio source that's always muted.

Can be used to create "gaps" between audio sources.

Field Summary

Fields

Modifier and Type	Field	Description
static byte[]	SILENCE_FRAME	A frame of silence.

Constructor Summary

Constructors

Constructor	Description
SilentAudioSource(SilentAudioSource toCopy)	Creates a new silent audio source and copies the duration settings from the given one.
SilentAudioSource(DiscordApi api, long duration, java.util.concurrent.TimeUnit unit)	Creates a new silent audio source.

Method Summary

Modifier and Type	Method	Description
AudioSource	copy()	Creates a copy of the audio source that can be reused for another audio connection.
java.time.Duration	getDuration()	Gets the duration of the audio source.
byte[]	getNextFrame()	Polls for the next 20ms of audio from the source.
java.time.Duration	getPosition()	Gets the position of the audio source.
boolean	hasFinished()	Checks whether the audio source has finished and can be dequeued.
boolean	hasNextFrame()	Checks whether there is 20ms of audio available to be polled.
boolean	isMuted()	Checks whether the audio source is muted.
boolean	isPaused()	Checks if the audio source is paused.
void	setPaused(boolean paused)	Sets whether the audio source should be paused.
long	setPosition(long position, java.util.concurrent.TimeUnit unit)	Sets the position of the audio source.

Methods inherited from class org.javacord.api.audio.AudioSourceBase

addAudioSourceAttachableListener, addAudioSourceFinishedListener, addTransformer, applyTransformers, getApi, getAudioSourceAttachableListeners, getAudioSourceFinishedListeners, getDelegate, getTransformers, removeAudioSourceAttachableListener, removeListener, removeTransformer, removeTransformers, setMuted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javacord.api.audio.AudioSource

addTransformer, asBufferableAudioSource, asDownloadableAudioSource, asPauseableAudioSource, asSeekableAudioSource, getApi, getTransformers, mute, removeTransformer, removeTransformers, setMuted, unmute

Methods inherited from interface org.javacord.api.listener.audio.AudioSourceAttachableListenerManager

addAudioSourceAttachableListener, addAudioSourceFinishedListener, getAudioSourceAttachableListeners, getAudioSourceFinishedListeners, removeAudioSourceAttachableListener, removeListener

Methods inherited from interface org.javacord.api.audio.PauseableAudioSource

pause, resume

Methods inherited from interface org.javacord.api.util.Specializable

as

Field Detail

SILENCE_FRAME

public static final byte[] SILENCE_FRAME

A frame of silence.

Constructor Detail

SilentAudioSource

public SilentAudioSource(DiscordApi api,
                         long duration,
                         java.util.concurrent.TimeUnit unit)

Creates a new silent audio source.

As audio frames always have a fixed 20ms duration, the duration will be rounded down to the closest multiple of 20ms. E.g. when trying to set the duration to 79ms, the duration will instead be set to 60ms.

Parameters:

api - The discord api instance.

duration - How long it should be silent.

unit - A TimeUnit determining how to interpret the duration parameter. As audio frames have a fixed size of 20ms, units bellow TimeUnit.MILLISECONDS are not recommended.

SilentAudioSource

public SilentAudioSource(SilentAudioSource toCopy)

Creates a new silent audio source and copies the duration settings from the given one.

Does not copy the state of the audio source, e.g. if it is muted, it's transformers, etc.

Parameters:

toCopy - The silent audio source to copy from.

Method Detail

getNextFrame

public byte[] getNextFrame()

Description copied from interface: AudioSource

Polls for the next 20ms of audio from the source.

Specified by:

getNextFrame in interface AudioSource

Returns:

A byte array containing 20ms of audio, or null if AudioSource.hasNextFrame() is false.

hasNextFrame

public boolean hasNextFrame()

Description copied from interface: AudioSource

Checks whether there is 20ms of audio available to be polled.

If there is no frame available, but the source has not been finished, it will play a silent sound instead.

Specified by:

hasNextFrame in interface AudioSource

Returns:

Whether there is a frame available to be polled.

hasFinished

public boolean hasFinished()

Description copied from interface: AudioSource

Checks whether the audio source has finished and can be dequeued.

This should not be confused with AudioSource.hasNextFrame() which only indicated if there is a frame available right now. An audio source might have no frame available, but is still not finished, e.g. because it's streaming something but downloads it too slowly.

Specified by:

hasFinished in interface AudioSource

Overrides:

hasFinished in class AudioSourceBase

Returns:

Whether the audio source has finished and can be dequeued.

isMuted

public boolean isMuted()

Description copied from interface: AudioSource

Checks whether the audio source is muted.

Specified by:

isMuted in interface AudioSource

Overrides:

isMuted in class AudioSourceBase

Returns:

Whether the audio source is muted.

copy

public AudioSource copy()

Description copied from interface: AudioSource

Creates a copy of the audio source that can be reused for another audio connection.

Does not copy the state of the audio source, e.g. if it is muted, it's transformers, etc.

Specified by:

copy in interface AudioSource

Returns:

A copy of the audio source.

setPaused

public void setPaused(boolean paused)

Description copied from interface: PauseableAudioSource

Sets whether the audio source should be paused.

A paused audio source will completely stop. This means, that after unpausing the audio source will continue at the same "position".

Specified by:

setPaused in interface PauseableAudioSource

Parameters:

paused - Whether the audio source should be paused.

isPaused

public boolean isPaused()

Description copied from interface: PauseableAudioSource

Checks if the audio source is paused.

Specified by:

isPaused in interface PauseableAudioSource

Returns:

Whether the audio source is paused or not.

setPosition

public long setPosition(long position,
                        java.util.concurrent.TimeUnit unit)

Description copied from interface: SeekableAudioSource

Sets the position of the audio source.

As audio frames always have a fixed 20ms duration, the position will be rounded down to the closest multiple of 20ms. E.g. when calling setPosition(79, TimeUnit.MILLISECONDS), the position will instead be set to 60ms.

Attempting to set the position to a value that's larger than the audio source's duration, will instead set it to the maximum duration of the audio source.

Negative positions will be interpreted as 0.

Specified by:

setPosition in interface SeekableAudioSource

Parameters:

position - The position to jump to.

unit - A TimeUnit determining how to interpret the position parameter. As audio frames have a fixed size of 20ms, units bellow TimeUnit.MILLISECONDS are not recommended.

Returns:

The new position of the audio source in the given time unit.

getPosition

public java.time.Duration getPosition()

Description copied from interface: SeekableAudioSource

Gets the position of the audio source.

Specified by:

getPosition in interface SeekableAudioSource

Returns:

The position of the audio source.

getDuration

public java.time.Duration getDuration()

Description copied from interface: SeekableAudioSource

Gets the duration of the audio source.

Specified by:

getDuration in interface SeekableAudioSource

Returns:

The duration of the audio source.