Package net.dv8tion.jda.api.audio

Class UserAudio

  • public class UserAudio
extends java.lang.Object
    Represents a packet of User specific audio.

    • Constructor Summary

      Constructors 
      Constructor Description
      UserAudio​(User user, short[] audioData)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] getAudioData​(double volume)
      Provides 20 Milliseconds of combined audio data in 48KHz 16bit stereo signed BigEndian PCM.
      User getUser()
      The User that provided the audio data.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UserAudio

        public UserAudio​(@Nonnull
                 User user,
                 @Nonnull
                 short[] audioData)

    • Method Detail

      • getUser

        @Nonnull
public User getUser()
        The User that provided the audio data.
        Returns:
        Never-null User object.

      • getAudioData

        @Nonnull
public byte[] getAudioData​(double volume)
        Provides 20 Milliseconds of combined audio data in 48KHz 16bit stereo signed BigEndian PCM.
        Format defined by: AudioReceiveHandler.OUTPUT_FORMAT.

        The output volume of the data can be modified by the provided `volume` parameter. `1.0` is considered to be 100% volume.
        Going above `1.0` can increase the volume further, but you run the risk of audio distortion.

        Parameters:
        volume - Value used to modify the "volume" of the returned audio data. 1.0 is normal volume.
        Returns:
        Never-null byte array of PCM data defined by AudioReceiveHandler.OUTPUT_FORMAT