Package discord4j.core.spec.legacy
Class LegacyVoiceChannelJoinSpec
java.lang.Object
discord4j.core.spec.legacy.LegacyVoiceChannelJoinSpec
- All Implemented Interfaces:
LegacySpec<Mono<VoiceConnection>>
LegacySpec used to request a connection to a
AudioChannel
and handle the initialization of the resulting
VoiceConnection
.-
Constructor Summary
ConstructorDescriptionLegacyVoiceChannelJoinSpec
(GatewayDiscordClient gateway, AudioChannel audioChannel) -
Method Summary
Modifier and TypeMethodDescriptionsetIpDiscoveryRetrySpec
(RetrySpec LegacyipDiscoveryRetrySpec) Set the retry policy to apply when performing IP discovery.setIpDiscoveryTimeout
(Duration ipDiscoveryTimeout) Set the maximum amount of time to wait for a single attempt at performing the IP discovery procedure.setProvider
(AudioProvider provider) Configure theAudioProvider
to use in the createdVoiceConnection
.setReceiver
(AudioReceiver receiver) Deprecated.Discord does not officially support bots receiving audio.setReceiveTaskFactory
(VoiceReceiveTaskFactory receiveTaskFactory) Deprecated.Discord does not officially support bots receiving audio.setSelfDeaf
(boolean selfDeaf) Set whether to deafen this client when establishing aVoiceConnection
.setSelfMute
(boolean selfMute) Set whether to mute this client when establishing aVoiceConnection
.setSendTaskFactory
(VoiceSendTaskFactory sendTaskFactory) Configure theVoiceSendTaskFactory
to use in the createdVoiceConnection
.setTimeout
(Duration timeout) Set the maximum amount of time to wait before the connection to the voice channel timeouts.
-
Constructor Details
-
LegacyVoiceChannelJoinSpec
-
-
Method Details
-
setProvider
Configure theAudioProvider
to use in the createdVoiceConnection
.- Parameters:
provider
- Used to send audio.- Returns:
- This spec.
-
setReceiver
Deprecated.Discord does not officially support bots receiving audio. It is not guaranteed that this functionality works properly. Use at your own risk.Configure theAudioReceiver
to use in the createdVoiceConnection
.- Parameters:
receiver
- Used to receive audio.- Returns:
- This spec.
-
setSendTaskFactory
Configure theVoiceSendTaskFactory
to use in the createdVoiceConnection
. A send task is created when establishing a Voice Gateway session and is torn down when disconnecting.- Parameters:
sendTaskFactory
- provides an audio send system that process outbound packets- Returns:
- this spec
-
setReceiveTaskFactory
@Deprecated public LegacyVoiceChannelJoinSpec setReceiveTaskFactory(VoiceReceiveTaskFactory receiveTaskFactory) Deprecated.Discord does not officially support bots receiving audio. It is not guaranteed that this functionality works properly. Use at your own risk.Configure theVoiceReceiveTaskFactory
to use in the createdVoiceConnection
. A receive task is created when establishing a Voice Gateway session and is torn down when disconnecting.- Parameters:
receiveTaskFactory
- provides an audio receive system to process inbound packets- Returns:
- this spec
-
setSelfDeaf
Set whether to deafen this client when establishing aVoiceConnection
.- Parameters:
selfDeaf
- if this client is deafened- Returns:
- this spec
-
setSelfMute
Set whether to mute this client when establishing aVoiceConnection
.- Parameters:
selfMute
- if this client is muted- Returns:
- this spec
-
setTimeout
Set the maximum amount of time to wait before the connection to the voice channel timeouts. For example, the connection may get stuck when the bot does not havePermission.VIEW_CHANNEL
or when the voice channel is full. The default value is 10 seconds.- Parameters:
timeout
- the maximum amount of time to wait before the connection to the voice channel timeouts- Returns:
- this spec
-
setIpDiscoveryTimeout
Set the maximum amount of time to wait for a single attempt at performing the IP discovery procedure. For more information about this procedure check IP discovery. The default value isDEFAULT_DISCOVERY_TIMEOUT
seconds.- Parameters:
ipDiscoveryTimeout
- the maximum amount of time to wait in a single attempt at IP discovery- Returns:
- this spec
-
setIpDiscoveryRetrySpec
Set the retry policy to apply when performing IP discovery. For more information about this procedure check IP discovery. The default value is retrying once before exiting.- Parameters:
LegacyipDiscoveryRetrySpec
- the maximum amount of time to wait in a single attempt at IP discovery- Returns:
- this spec
-
asRequest
- Specified by:
asRequest
in interfaceLegacySpec<Mono<VoiceConnection>>
-