Discord.Internal.Types.VoiceWebsocket

WARNING

This module is considered internal.

The Package Versioning Policy does not apply.

The contents of this module may change in any way whatsoever and without any warning between minor versions of this package.

Description

This module defines basic types for the communication packets in the Discord Voice Gateway. Some ToJSON and FromJSON instances are defined, as according to the official Discord documentation for v4 of the gateway.

Prisms are defined using TemplateHaskell for VoiceWebsocketReceivable.

Documentation

data VoiceWebsocketReceivable

Constructors

Ready ReadyPayload

SessionDescription Text [Word8]

SpeakingR SpeakingPayload

HeartbeatAck Int

Hello Int

Int because this is heartbeat, and threadDelay uses it

Resumed

ClientDisconnect UserId

UnknownOPCode Integer Object

ParseError Text

Reconnect

Instances

Eq VoiceWebsocketReceivable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: VoiceWebsocketReceivable -> VoiceWebsocketReceivable -> Bool

(/=) :: VoiceWebsocketReceivable -> VoiceWebsocketReceivable -> Bool

Show VoiceWebsocketReceivable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> VoiceWebsocketReceivable -> ShowS

show :: VoiceWebsocketReceivable -> String

showList :: [VoiceWebsocketReceivable] -> ShowS

FromJSON VoiceWebsocketReceivable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

parseJSON :: Value -> Parser VoiceWebsocketReceivable

parseJSONList :: Value -> Parser [VoiceWebsocketReceivable]

HasWebsocket DiscordVoiceHandle (Weak ThreadId, (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan))

Defined in Discord.Internal.Types.VoiceCommon

Methods

websocket :: Lens' DiscordVoiceHandle (Weak ThreadId, (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan))

HasWsHandle WebsocketLaunchOpts (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan)

Defined in Discord.Internal.Types.VoiceCommon

Methods

wsHandle :: Lens' WebsocketLaunchOpts (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan)

_Ready :: Traversal' VoiceWebsocketReceivable ReadyPayload

_SessionDescription :: Traversal' VoiceWebsocketReceivable (Text, [Word8])

_Hello :: Traversal' VoiceWebsocketReceivable Int

data VoiceWebsocketSendable

Constructors

Identify IdentifyPayload

SelectProtocol SelectProtocolPayload

Heartbeat Int

Int because threadDelay uses it

Speaking SpeakingPayload

Resume GuildId Text Text

Instances

Eq VoiceWebsocketSendable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: VoiceWebsocketSendable -> VoiceWebsocketSendable -> Bool

(/=) :: VoiceWebsocketSendable -> VoiceWebsocketSendable -> Bool

Show VoiceWebsocketSendable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> VoiceWebsocketSendable -> ShowS

show :: VoiceWebsocketSendable -> String

showList :: [VoiceWebsocketSendable] -> ShowS

ToJSON VoiceWebsocketSendable

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

toJSON :: VoiceWebsocketSendable -> Value

toEncoding :: VoiceWebsocketSendable -> Encoding

toJSONList :: [VoiceWebsocketSendable] -> Value

toEncodingList :: [VoiceWebsocketSendable] -> Encoding

HasWebsocket DiscordVoiceHandle (Weak ThreadId, (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan))

Defined in Discord.Internal.Types.VoiceCommon

Methods

websocket :: Lens' DiscordVoiceHandle (Weak ThreadId, (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan))

HasWsHandle WebsocketLaunchOpts (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan)

Defined in Discord.Internal.Types.VoiceCommon

Methods

wsHandle :: Lens' WebsocketLaunchOpts (VoiceWebsocketReceiveChan, VoiceWebsocketSendChan)

data ReadyPayload

Constructors

ReadyPayload

Fields

• readyPayloadSSRC :: Integer
• readyPayloadIP :: Text
• readyPayloadPort :: Integer
• readyPayloadModes :: [Text]

Instances

Eq ReadyPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: ReadyPayload -> ReadyPayload -> Bool

(/=) :: ReadyPayload -> ReadyPayload -> Bool

Show ReadyPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> ReadyPayload -> ShowS

show :: ReadyPayload -> String

showList :: [ReadyPayload] -> ShowS

data SpeakingPayload

Constructors

SpeakingPayload

Fields

• speakingPayloadMicrophone :: Bool
• speakingPayloadSoundshare :: Bool
• speakingPayloadPriority :: Bool
• speakingPayloadDelay :: Integer
• speakingPayloadSSRC :: Integer

Instances

Eq SpeakingPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: SpeakingPayload -> SpeakingPayload -> Bool

(/=) :: SpeakingPayload -> SpeakingPayload -> Bool

Show SpeakingPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> SpeakingPayload -> ShowS

show :: SpeakingPayload -> String

showList :: [SpeakingPayload] -> ShowS

data IdentifyPayload

Constructors

IdentifyPayload

Fields

• identifyPayloadServerId :: GuildId
• identifyPayloadUserId :: UserId
• identifyPayloadSessionId :: Text
• identifyPayloadToken :: Text

Instances

Eq IdentifyPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: IdentifyPayload -> IdentifyPayload -> Bool

(/=) :: IdentifyPayload -> IdentifyPayload -> Bool

Show IdentifyPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> IdentifyPayload -> ShowS

show :: IdentifyPayload -> String

showList :: [IdentifyPayload] -> ShowS

data SelectProtocolPayload

Constructors

SelectProtocolPayload

Fields

• selectProtocolPayloadProtocol :: Text
• selectProtocolPayloadIP :: Text
• selectProtocolPayloadPort :: Integer
• selectProtocolPayloadMode :: Text

Instances

Eq SelectProtocolPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

(==) :: SelectProtocolPayload -> SelectProtocolPayload -> Bool

(/=) :: SelectProtocolPayload -> SelectProtocolPayload -> Bool

Show SelectProtocolPayload

Defined in Discord.Internal.Types.VoiceWebsocket

Methods

showsPrec :: Int -> SelectProtocolPayload -> ShowS

show :: SelectProtocolPayload -> String

showList :: [SelectProtocolPayload] -> ShowS

''VoiceWebsocketReceivable)