diff --git a/current/help.html b/current/help.html index 05a6b7e9a..8db868201 100644 --- a/current/help.html +++ b/current/help.html @@ -1 +1 @@ -
Call
s currently stored in the manager …\nA shard-aware struct responsible for managing Call
s.\nID of the voice channel being joined, if it is known.\nSets this Config
’s symphonia codec registry.\nRegistry of the inner codecs supported by the driver, …\nConstants affecting driver function and API handling.\nSets this Config
’s chosen cryptographic tagging scheme.\nSelected tagging mode for voice packet encryption.\nReturns id
of the channel, if connected or connecting to …\nReturns the current voice connection details for this Call,\nSets whether the current connection is to be deafened.\nSets this Config
’s channel layout for output audio when …\nConfigures the channel layout for output audio when using …\nSets this Config
’s received packet decryption/decoding …\nConfigures whether decoding and decryption occur for all …\nSets this Config
’s sample rate for output audio when …\nConfigures the sample rate for output audio when using …\nSets this Config
’s received packet decoder cleanup timer.\nConfigures the amount of time after a user/SSRC is …\nSets this Config
’s channel for sending disposal messages.\nThe Sender for a channel that will run the destructor of …\nRunner for a voice connection.\nSets this Config
’s voice connection retry configuration.\nConnection retry logic for the Driver
.\nSets this Config
’s timeout for establishing a voice …\nConfigures the maximum amount of time to wait for an …\nURL of the voice websocket gateway server assigned to this …\nDriver and gateway error handling.\nEvents relating to tracks, timing, and other callers.\nSets this Config
’s symphonia format registry/probe set.\nRegistry of the muxers and container formats supported by …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCreates a new Call, configuring the driver as specified.\nSets this Config
’s timeout for joining a voice channel.\nConfigures the amount of time to wait for Discord to reply …\nRetrieves a Call
for the given guild, if one already …\nRetrieves a Call
for the given guild, creating a new one if\nReturns a lightweight reference to the audio scheduler …\nID of the target voice channel’s parent guild.\nNewtypes around Discord IDs for library …\nSet the bot’s user, and the number of shards in use.\nRaw audio input data streams and sources.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the current connection is self-deafened in …\nReturns whether the current connection is self-muted in …\nCreates an iterator for all Call
s currently managed.\nFuture types for gateway interactions.\nConnect or switch to the given voice channel by its Id.\nConnects to a target by retrieving its relevant Call
and …\nJoin the selected voice channel, without running/starting …\nPartially connects to a target by retrieving its relevant …\nLeaves the current voice channel, disconnecting from it.\nRetrieves the handler for the given target and leaves the …\nSets this Config
’s audio mixing channel count.\nConfigures whether the driver will mix and output stereo …\nSets whether the current connection is to be muted.\nCreates a new Call, which will send out WebSocket messages …\nSets this Config
’s playout buffer length, in packets.\nConfigures the number of audio packets to buffer for each …\nSets this Config
’s additional pre-allocated space to …\nConfigures the initial amount of extra space allocated to …\nSets this Config
’s number of tracks to preallocate.\nNumber of concurrently active tracks to allocate memory …\nHandle events received on the cluster.\nRetrieves the Call
for the given target and leaves the …\nSets this Config
’s mixer scheduler.\nThe scheduler is responsible for mapping idle and active …\nCompatibility and convenience methods for working with …\nCreate a new Songbird instance for serenity.\nCreate a new Songbird instance for serenity, using the …\nUnique string describing this session for …\nSets a shared configuration for all drivers created from …\nHandlers for sending packets over sharded connections.\nCreates a new, standalone Call which is not connected via …\nCreates a new standalone Call from the given configuration …\nEphemeral secret used to validate the above session.\nLive, controllable audio instances.\nCreate a new Songbird instance for twilight.\nCreate a new Songbird instance for twilight.\nUpdates the voice server data.\nUpdates the internal voice state of the current user.\nSets this Config
’s number to enable/disable …\nConfigures whether or not each mixed audio packet is …\nUserID of this bot.\nNumber of audio frames/packets to be sent per second.\nMaximum number of audio frames/packets to be sent per …\nDefault bitrate for audio.\nLength (in milliseconds) of any audio frame.\nNumber of bytes in one complete frame of raw f32
-encoded …\nNumber of samples in one complete frame of audio per …\nProfile type used by Discord’s Opus audio traffic.\nThe one (and only) RTP version.\nSample rate of audio to be sent to Discord.\nSample rate of audio to be sent to Discord.\nOpus silent frame, used to signal speech start and end …\nNumber of bytes in one complete frame of raw f32
-encoded …\nNumber of individual samples in one complete frame of …\nLength of time between any two audio frames.\nType-converted delay between sends of UDP keepalive frames.\nDelay between sends of UDP keepalive frames.\nThe voice gateway version used by the library.\nMaximum packet size for a voice packet.\nDiscord’s currently preferred non-E2EE encryption scheme.\nDefault bitrate decided by the encoder (not recommended).\nOpus encoder bitrate settings.\nExplicit bitrate choice (in bits/second).\nThe channel layout of output audio when using …\nFuture for a call to Driver::connect
.\nVariants of the XSalsa20Poly1305
encryption scheme.\nThe default shared scheduler instance.\nDecrypts and decodes each received packet, correctly …\nDecode behaviour for received RTP packets within the …\nDecrypts the body of each received packet.\nThe scheduler exited or crashed while awating the request.\nThe control object for a Discord voice connection, …\nDecode to a sample rate of 12kHz.\nDecode to a sample rate of 16kHz.\nDecode to a sample rate of 24kHz.\nDecode to a sample rate of 48kHz.\nDecode to a sample rate of 8kHz.\nAn additional random 4B suffix is used as the source of …\nRuntime statistics for an individual worker.\nMaximum bitrate allowed (up to maximum number of bytes for …\nAllows at most n
tasks to run per thread.\nMixing behaviour for sent audio sources processed within …\nDecode received audio packets into a single channel.\nAudio sources will be downmixed into a mono buffer.\nThe RTP header is used as the source of nonce bytes for …\nPackets received from Discord are handed over to events …\nThe sample rate of output audio when using …\nA reference to a shared group of threads used for running …\nConfiguration for how a Scheduler
handles tasks.\nErrors encountered when communicating with the internals …\nStrategies for mapping live mixer tasks to individual …\nDecode received audio packets into two interleaved …\nAudio sources will be mixed into into a stereo buffer, …\nAn additional random 24B suffix is used as the source of …\nA fallback non-E2EE encryption scheme.\nAttach a global event handler to an audio context. Global …\nReturns the nonce length in bytes required by algorithm.\nReturns a view of this driver’s configuration.\nConnects to a voice channel using the specified server.\nLeaves the current connected voice channel, if connected …\nEncrypts a Discord RT(C)P packet using the given …\nAdds an existing Track
to this driver’s built-in queue.\nAdds an audio Input
to this driver’s built-in queue.\nAdd an existing Track
to the queue, using a known time to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the driver is muted (i.e., processes audio …\nReturns the number of nanoseconds required to process all …\nLeaves the current voice channel, disconnecting from it.\nReturns the number of mixer tasks scheduled on this worker …\nReturns the total number of active calls scheduled and …\nMove costly mixers to another thread if their parent …\nSets whether the current connection is to be muted.\nCreate a new mixer scheduler from the allocation strategy …\nCreates a new voice driver.\nReturns the number of bytes each nonce is stored as within …\nOpus encoder bitrate settings.\nCalculates the number of additional bytes required compared\nReturns the number of bytes occupied by the …\nReturns the number of bytes occupied by the encryption …\nPlays audio from a Track
object.\nPlays audio from an input, returning a handle for further …\nExclusively plays audio from a Track
object.\nPlays audio from an input, returning a handle for further …\nReturns a reference to this driver’s built-in queue.\nRemoves all global event handlers from an audio context.\nConfiguration for connection retries.\nSets the bitrate for encoding Opus packets sent along the …\nSets the configuration for this driver (and parent Call
, …\nReturns whether this mode will decrypt received packets.\nStops playing audio from all sources, if any are set.\nHow Live mixer tasks will be mapped to individual threads.\nReturns the number of bytes occupied by an encryption …\nReturns the name of a mode as it will appear during …\nReturns the total number of calls (idle and active) …\nRequest a list of handles to statistics for currently live …\nRequest a list of handles to statistics for currently live …\nReturns the total number of threads spawned to process …\nExponential backoff waiting strategy, where the duration …\nThe driver will wait for the same amount of time between …\nExponential backoff waiting strategy.\nConfiguration to be used for retrying driver connection …\nLogic used to determine how long to wait between retry …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nAmount of uniform random jitter to apply to generated wait …\nMaximum amount of time to wait between retries.\nMinimum amount of time to wait between retries.\nThe maximum number of retries to attempt.\nStrategy used to determine how long to wait between retry …\nThe driver hung up an internal signaller, either due to …\nErrors encountered while connecting to a Discord voice …\nConvenience type for Discord voice/driver connection error …\nAn error occurred during [en/de]cryption of voice packets.\nThe symmetric key supplied by Discord had the wrong size.\nServer did not return the expected crypto mode during …\nSelected crypto mode was not offered by server.\nThe driver failed to establish a voice connection.\nRequest to join was dropped, cancelled, or replaced.\nAn indicator that an endpoint URL was invalid.\nContains the error value\nContains the error value\nDiscord failed to correctly respond to IP discovery.\nCould not parse Discord’s view of our IP.\nFailed to message other background tasks after connection …\nMiscellaneous I/O error.\nError returned when a manager or call handler is unable to …\nConvenience type for Discord gateway error handling.\nJSON (de)serialization error.\nThis type represents all possible errors that can occur …\nTried to leave a Call
which was not found.\nNo available gateway connection was provided to send voice …\nContains the success value\nContains the success value\nSerenity-specific WebSocket send error.\nConnection attempt timed out.\nConnection details were not received from Discord in the …\nTwilight-specific WebSocket send error when a message …\nError communicating with gateway server over WebSocket.\nCategorizes the cause of this error.\nOne-based column number at which the error was detected.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nThe kind reported by the underlying standard library I/O …\nReturns true if this error was caused by input data that …\nReturns true if this error was caused by prematurely …\nReturns true if this error was caused by a failure to read …\nReturns true if this error was caused by input that was not\nOne-based line number at which the error was detected.\nIndicates whether this failure may have left (or been …\nIndicates whether this failure can be reattempted via …\nCancels the event, if it was intended to persist.\nFired whenever a client disconnects.\nFires whenever a user disconnects from the same stream as …\nUntimed events belonging to the global context, such as …\nCore events\nVoice core events occur on receipt of voice packets and …\nDelayed events rely upon a delay parameter, and fire one …\nFires when this driver successfully connects to a voice …\nFires when this driver successfully connects to a voice …\nFires when this driver fails to connect to, or drops from, …\nFires when this driver fails to connect to, or drops from, …\nFires when this driver successfully reconnects after a …\nFires when this driver successfully reconnects after a …\nThe attached track has ended.\nThe attached track has encountered a runtime or …\nClasses of event which may occur, triggering a handler at …\nInformation about which tracks or data fired an event.\nInternal representation of an event, as handled by the …\nTrait to handle an event which can be fired per-track, or …\nStorage for EventData
, designed to be used for both local …\nThe attached track has looped.\nThe attached track has been paused.\nPeriodic events rely upon two parameters: a period and an …\nThe attached track has resumed playing.\nThe attached track has become playable.\nThe attached track is being readied or recreated.\nTelemetry/statistics packet, received from another stream.\nFires on receipt of an RTCP packet, containing various …\nOpus audio packet, received from another stream.\nFires on receipt of a voice packet from another stream in …\nSpeaking state update, typically describing how another …\nSpeaking state update from the WS gateway, typically …\nTrack event context, passed to events created via …\nUntimed events belonging to a track, such as state …\nTrack events correspond to certain actions or changes of …\nTrack events correspond to certain actions or changes of …\nTrack and voice core events.\nReordered and decoded audio packets, received every 20ms.\nFires every 20ms, containing the scheduled voice packet …\nRespond to one received event.\nAdd an event to this store.\nComputes the next firing time for a timer event.\nTypes containing the main body of an EventContext
.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCreate a representation of an event and its associated …\nCreates a new event store to be used globally.\nCreates a new event store to be used within a Track
.\nRetreive the event class for an event (i.e., when matching)\nThis (re)connection attempt was dropped due to another …\nThe voice driver failed to connect to the server.\nVoice connection details gathered at setup/reinstantiation.\nVoice connection details gathered at termination or …\nThe location that a voice connection was terminated.\nThe reason that a voice connection failed.\nSongbird had an internal error.\nA host-specific I/O error caused the fault; this is likely …\nSongbird and Discord disagreed on the protocol used to …\nThe voice driver failed to reconnect to the server.\nThe call was manually disconnected by a user command, e.g. …\nTelemetry/statistics packet, received from another stream\nOpus audio packet, received from another stream\nThe voice connection was terminated mid-session by either …\nA voice connection was not established in the specified …\nVoice packet and audio data for a single user, from a …\nAudio data from all users in a voice channel, fired every …\nThe Websocket connection was closed by Discord.\nID of the voice channel being joined, if it is known.\nID of the voice channel being joined, if it is known.\nPCM audio obtained from a user.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nID of the target voice channel’s parent guild.\nID of the target voice channel’s parent guild.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nThe location that a voice connection was terminated.\nRaw RTCP packet data.\nRaw RTP packet data.\nRTP packet clocked out for this tick.\nNumber of bytes at the end of the packet to discard.\nNumber of bytes at the end of the packet to discard.\nByte index into the packet body (after headers) for where …\nByte index into the packet body (after headers) for where …\nThe cause of any connection failure.\nCreate a zero-copy view of the inner RTCP packet.\nCreate a zero-copy view of the inner RTP packet.\nThe domain name of Discord’s voice/TURN server.\nUnique string describing this session for …\nUnique string describing this session for …\nSet of all SSRCs currently known in the call who aren’t …\nDecoded voice data and source packets sent by each user.\nThe RTP SSRC (“Synchronisation source”) assigned by …\nID of a Discord voice/text channel.\nID of a Discord guild (colloquially, “server”).\nID of a Discord user.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nAn adapter for converting an async media source into a …\nAn async port of symphonia’s MediaSource
.\nAsyncReadOnlySource
wraps any source implementing …\nAn unread byte stream for an audio file.\nErrors encountered when creating an AudioStream
or …\nExtra information about an Input
which is acquired without …\nErrors encountered when trying to access out-of-band …\nHandle for a child process which ensures that any …\nData and behaviour required to instantiate a lazy audio …\nFailed to create a LiveInput
from the lazy Compose
.\nThe operation failed, and should not be retried.\nA lazily instantiated local file.\nLazy HLS stream\nA lazily instantiated HTTP request.\nAn audio source, which can be live or lazily initialised.\nA byte source which is not yet initialised.\nAn initialised byte source.\nAn initialised audio source.\nErrors encountered when readying or pre-processing an Input
…\nIn-stream information about an Input
acquired by parsing …\nErrors encountered when trying to access in-stream Metadata
…\nThis input has no lazy Compose
initialiser, which is …\nThis input is currently lazily initialised, and must be …\nThis input is ready, but has not had its headers parsed.\nA blocking thread panicked or failed to return a parsed …\nFailed to read headers, codecs, or a valid stream from a …\nAn audio file which has had its headers parsed and decoder …\nAn audio file which has had its headers parsed and decoder …\nAn unread, raw file stream.\nAdapter around a raw, interleaved, f32
PCM byte stream.\nThere was an error when trying to access auxiliary …\nThe operation failed, and should be retried after a given …\nThe operation was not supported, and will never succeed.\nAn unread file which has been wrapped with a large …\nA lazily instantiated call to download a file, finding its …\nThe album name of this stream.\nThe main artist of this stream.\nRequests auxiliary metadata which can be accessed without …\nRequests auxiliary metadata which can be accessed without …\nRequests auxiliary metadata which can be accessed without …\nReturns the length in bytes, if available. This may be an …\nIn-memory, shared input sources for reuse between calls, …\nThe YouTube channel of this stream.\nThe number of audio channels in this stream.\nA reqwest client instance used to send the HTTP GET …\nCodec registries extending Symphonia’s probe and …\nContent length, used as an upper bound in range requests …\nCreate a source synchronously.\nCreate a source asynchronously.\nThe date of creation of this stream.\nDecoder state for the chosen track.\nThe reported duration of this stream.\nMetadata found inside the format/container of an audio …\nAudio packet, seeking, and state access for all tracks in …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nExtract metadata and details from the output of …\nGets a reference to the underlying reader.\nHTTP header fields to add to any created requests.\nExtension and MIME type information which may help guide …\nThe wrapped file stream.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nUnwraps this AsyncReadOnlySource
, returning the underlying …\nReturns whether this stream’s headers have been fully …\nReturns whether this audio stream is full initialised, …\nReturns if the source is seekable. This may be an …\nReturns a reference to the live input, if it has been …\nReturns a mutable reference to the live input, if it been …\nInitialises (but does not parse) an Input::Lazy
into an …\nInitialises (but does not parse) an Input::Lazy
into an …\nInitialises and parses an Input::Lazy
into an Input::Live
, …\nInitialises and parses an Input::Lazy
into an Input::Live
, …\nMetadata extracted by symphonia while detecting a file’s …\nTries to get any information about this audio stream …\nTries to get any information about this audio stream …\nWrap and pull from an async file stream, with an …\nWrap an input PCM byte source to be readable by symphonia.\nCreate a new ChildContainer
from a child process\nCreates a lazy file object, which will open the target …\nCreate a lazy HLS request.\nCreate a lazy HTTP request.\nCreates a lazy request to select an audio stream from url
, …\nInstantiates a new AsyncReadOnlySource
by taking ownership …\nCreates a request to search youtube for an optionally …\nCreates a request to search youtube for an optionally …\nCreate a lazy HTTP request.\nCreate a lazy HTTP request.\nCreates a lazy request to select an audio stream from url
…\nReturns a reference to the data parsed from this input …\nReturns a reference to the data parsed from this input …\nReturns a mutable reference to the data parsed from this …\nReturns a mutable reference to the data parsed from this …\nMetadata found while probing for the format of an Input
…\nConverts this audio source into a Parsed
object using the …\nThe target URL of the required resource.\nThe sample rate of this stream.\nRuns a search for the given query, returning a list of up …\nDetermines whether this source will be instantiated using …\nThe source url of this stream.\nThe time at which the first true sample is played back.\nWhether the contained format supports arbitrary seeking.\nMove all fields from an AuxMetadata
object into a new one.\nThe thumbnail url of this stream.\nThe YouTube title of this stream.\nThe track name of this stream.\nThe chosen track’s ID.\nTries to recreate this stream in event of an error, …\nTries to recreate this stream in event of an error, …\nUtility methods for seeking or decoding.\nEstimate of a source’s length in bytes.\nErrors encountered using a Compressed
or Decompressed
…\nA wrapper around an existing Input
which compresses the …\nConfiguration for a cached source.\nThe audio stream could not be created.\nThe audio stream could not be created.\nThe audio stream failed to be created due to a panic in …\nThe audio stream failed to be created due to a panic in …\nA wrapper around an existing Input
which caches the …\nErrors encountered using a Memory
cached source.\nExpected amount of time that an input should last.\nA wrapper around an existing Input
which caches its data …\nThe file’s metadata could not be converted to JSON.\nThe input’s metadata was too large after conversion to …\nThe Opus encoder could not be created.\nTransform applied inside Compressed
, converting a …\nSymphonia failed to parse the container or decode the …\nThe input stream had already been read (i.e., Parsed
) and …\nThe input stream had already been read (i.e., Parsed
) and …\nStreamcatcher’s configuration was illegal, and the cache …\nStreamcatcher’s configuration was illegal, and the cache …\nEstimate of a source’s length in time.\nThe audio stream’s channel count could not be determined.\nModify the given cache configuration to initially allocate …\nRegistry of audio codecs supported by the driver.\nEstimates the cost, in B/s, of audio data compressed at …\nProvides the default config used by a cached source.\nGenerate a storage configuration given an estimated …\nRegistry of the muxers and container formats supported by …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nWrap an existing Input
with an in-memory store, compressed …\nWrap an existing Input
with an in-memory store, …\nWrap an existing Input
with an in-memory store with the …\nAcquire a new handle to this object, creating a new view …\nAcquire a new handle to this object, creating a new view …\nAcquire a new handle to this object, creating a new view …\nInner shared bytestore.\nInner shared bytestore.\nInner shared bytestore.\nCalculates the cost, in B/s, of raw floating-point audio …\nConfiguration for the inner streamcatcher instance.\nWrap an existing Input
with an in-memory store, compressed …\nWrap an existing Input
with an in-memory store, …\nWrap an existing Input
with an in-memory store with the …\nDefault Symphonia CodecRegistry
, including the …\nDCA[0/1] Format reader for Symphonia.\nOpus decoder for symphonia, based on libopus v1.3 (via …\nDefault Symphonia Probe, including DCA format support.\nSymphonia support for a simple container for raw f32-PCM …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalculates the time position in a FloatPCM
stream from a …\nCreate an Opus decoder outputting at a sample rate of …\nCalculates the time position in a FloatPCM
stream from a …\nCalculates the byte position in a FloatPCM
stream from a …\nCalculates the sample position in a FloatPCM
stream from a …\nFuture for a call to Call::join
.\nFuture for a call to Call::join_gateway
.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nHelper trait to add installation/creation methods to …\nZero-size type used to retrieve the registered Songbird
…\nReturns the argument unchanged.\nRetrieve the Songbird voice client from a serenity context…\nCalls U::from(self)
.\nInstalls a new songbird instance into the serenity client.\nInstalls a given songbird instance into the serenity …\nRegisters a new Songbird voice system with serenity, …\nRegisters a Songbird voice system serenity, based on the …\nRegisters a given Songbird voice system with serenity, as …\nInstalls a given songbird instance into the serenity …\nA generic shard handle source.\nHandle to a generic shard instance.\nTrait for a generic shard cluster or other handle source.\nSerenity-specific wrapper for sharder state initialised by …\nHandle to one of serenity’s shard runners.\nHandle to an individual shard designed to buffer unsent …\nSerenity-specific wrapper for sharder state initialised by …\nA reference to an individual websocket connection.\nSource of individual shard connection handles.\nTwilight-specific wrapper for a map of command senders.\nHandle to a map of twilight command senders.\nMap containing MessageSender
s for Twilight.\nTrait for a generic shard handle to send voice state …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nGet the message sender for shard_id
.\nGet access to a new shard\nReturns a new handle to the required inner shard.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nConstruct a map of shards and command senders to those …\nGet the total number of shards in the map.\nSend a voice update message to the inner shard handle.\nActions for the mixer to take after inspecting track state …\nErrors associated with control and manipulation of tracks.\nFailed to create a live bytestream from the lazy Compose
.\nFailed to decode a frame received from an Input
.\nAnother seek
/make_playable
request was made, and so this …\nThe track has naturally ended, and cannot be restarted.\nContains the error value\nThe track has encountered a runtime or initialisation …\nThe operation failed because the track has ended, has been …\nTrack will loop n
more times.\nTrack will loop endlessly until loop state is changed or …\nThe supplied event listener can never be fired by a track, …\nLooping behaviour for a Track
.\nContains the success value\nFailed to read headers, codecs, or a valid stream from an …\nThe track is currently paused, and may be resumed.\nA command to seek or ready the target track failed when …\nThe track is currently playing.\nErrors reported by the mixer while attempting to play (or …\nPlayback status of a track.\nThis track is fully initialised and usable.\nThe mixer is currently creating and parsing this track’s …\nReference to a track which is known to be part of a queue.\nWhether this track has been made live, is being processed, …\nFailed to seek to the requested location.\nThe track has been manually stopped, and cannot be …\nInitial state for audio playback.\nAsynchronous reply for an operation applied to a …\nHandle for safe control of a Track
from other threads, …\nA simple queue for several audio sources, designed to play …\nAlias for most calls to a TrackHandle
.\nState of an Track
object, designed to be passed to event …\nThis track is still a lazy Compose
object, and hasn’t …\nLive track and input state exposed during …\nPerform an arbitrary synchronous action on a raw Track
…\nAdds a Track
object to the queue, to be played in the …\nAttach an event handler to an audio track. These will …\nAdds an audio source to the queue, to be played in the …\nAdd an existing Track
to the queue, using a known time to …\nReturns a handle to the currently playing track.\nReturns a list of currently queued tracks.\nAttempts to remove a track from the specified index.\nSet an audio track to no longer loop.\nSet an audio track to loop indefinitely.\nList of events attached to this audio track.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nRequest playback information and state from the audio …\nClones the inner handle\nThe live or lazily-initialised audio stream to be played.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the track has irreversibly stopped.\nReturns whether there are no tracks currently in the queue.\nReturns true
if the operation instantly failed due to the …\nReturns the number of tracks currently in the queue.\nSet an audio track to loop a set number of times.\nSet an audio track to loop a set number of times.\nThe number of remaning loops on this track.\nCount of remaining loops.\nRemaining loops on this track.\nReadies the track to be playable, if this is not already …\nReady a track for playing if it is lazily initialised.\nReady a track for playing if it is lazily initialised.\nIn-stream metadata for this track, if it is fully readied.\nAllows modification of the inner queue (i.e., deletion, …\nCreate a new track directly from an Input
and a random Uuid
…\nCreate a new, empty, track queue.\nCreate a new track directly from an Input
with a custom …\nPre-emptively pauses a track, preventing it from being …\nPauses an audio track.\nPause the track at the head of the queue.\nSets a track to playing if it is paused.\nUnpauses an audio track.\nThe total time a track has been played for.\nTotal playback time, increasing monotonically.\nThe current play status of this track.\nWhether or not this sound is currently playing.\nPlay status (e.g., active, paused, stopped) of this track.\nThe current position within this track.\nCurrent playback position in the source.\nWhether this track has been made live, is being processed, …\nWhether this track has been made live, is being processed, …\nConsumes this handle to await a reply from the driver, …\nConsumes this handle to await a reply from the driver …\nResume the track at the head of the queue.\nRequests a seek to the given time for this track.\nSeeks along the track to the specified position.\nSeeks along the track to the specified position.\nSets the volume of an audio track.\nSkip to the next track in the queue, if it exists.\nManually stops a track.\nStops an audio track.\nStop the currently playing track, and clears the queue.\nAllows access to this track’s attached TypeMap
.\nReturns this track’s unique identifier.\nReturns this handle’s (and track’s) unique identifier.\nUnique identifier for this track.\nSets volume
in a manner that allows method chaining.\nThe current mixing volume of this track.\nThe volume for playback.\nCurrent volume of this track.")
\ No newline at end of file
+searchState.loadedDescShard("songbird", 0, "project logo\nThe Call handler is responsible for a single voice …\nConfiguration for drivers and calls.\nParameters and information needed to start communicating …\nAn iterator over all Call
s currently stored in the manager …\nA shard-aware struct responsible for managing Call
s.\nID of the voice channel being joined, if it is known.\nSets this Config
’s symphonia codec registry.\nRegistry of the inner codecs supported by the driver, …\nConstants affecting driver function and API handling.\nSets this Config
’s chosen cryptographic tagging scheme.\nSelected tagging mode for voice packet encryption.\nReturns id
of the channel, if connected or connecting to …\nReturns the current voice connection details for this Call,\nSets whether the current connection is to be deafened.\nSets this Config
’s channel layout for output audio when …\nConfigures the channel layout for output audio when using …\nSets this Config
’s received packet decryption/decoding …\nConfigures whether decoding and decryption occur for all …\nSets this Config
’s sample rate for output audio when …\nConfigures the sample rate for output audio when using …\nSets this Config
’s received packet decoder cleanup timer.\nConfigures the amount of time after a user/SSRC is …\nSets this Config
’s channel for sending disposal messages.\nThe Sender for a channel that will run the destructor of …\nRunner for a voice connection.\nSets this Config
’s voice connection retry configuration.\nConnection retry logic for the Driver
.\nSets this Config
’s timeout for establishing a voice …\nConfigures the maximum amount of time to wait for an …\nURL of the voice websocket gateway server assigned to this …\nDriver and gateway error handling.\nEvents relating to tracks, timing, and other callers.\nSets this Config
’s symphonia format registry/probe set.\nRegistry of the muxers and container formats supported by …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCreates a new Call, configuring the driver as specified.\nSets this Config
’s timeout for joining a voice channel.\nConfigures the amount of time to wait for Discord to reply …\nRetrieves a Call
for the given guild, if one already …\nRetrieves a Call
for the given guild, creating a new one if\nReturns a lightweight reference to the audio scheduler …\nID of the target voice channel’s parent guild.\nNewtypes around Discord IDs for library …\nSet the bot’s user, and the number of shards in use.\nRaw audio input data streams and sources.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the current connection is self-deafened in …\nReturns whether the current connection is self-muted in …\nCreates an iterator for all Call
s currently managed.\nFuture types for gateway interactions.\nConnect or switch to the given voice channel by its Id.\nConnects to a target by retrieving its relevant Call
and …\nJoin the selected voice channel, without running/starting …\nPartially connects to a target by retrieving its relevant …\nLeaves the current voice channel, disconnecting from it.\nRetrieves the handler for the given target and leaves the …\nSets this Config
’s audio mixing channel count.\nConfigures whether the driver will mix and output stereo …\nSets whether the current connection is to be muted.\nCreates a new Call, which will send out WebSocket messages …\nSets this Config
’s playout buffer length, in packets.\nConfigures the number of audio packets to buffer for each …\nSets this Config
’s additional pre-allocated space to …\nConfigures the initial amount of extra space allocated to …\nSets this Config
’s number of tracks to preallocate.\nNumber of concurrently active tracks to allocate memory …\nHandle events received on the cluster.\nRetrieves the Call
for the given target and leaves the …\nSets this Config
’s mixer scheduler.\nThe scheduler is responsible for mapping idle and active …\nCompatibility and convenience methods for working with …\nCreate a new Songbird instance for serenity.\nCreate a new Songbird instance for serenity, using the …\nUnique string describing this session for …\nSets a shared configuration for all drivers created from …\nHandlers for sending packets over sharded connections.\nCreates a new, standalone Call which is not connected via …\nCreates a new standalone Call from the given configuration …\nEphemeral secret used to validate the above session.\nLive, controllable audio instances.\nCreate a new Songbird instance for twilight.\nCreate a new Songbird instance for twilight.\nUpdates the voice server data.\nUpdates the internal voice state of the current user.\nSets this Config
’s number to enable/disable …\nConfigures whether or not each mixed audio packet is …\nUserID of this bot.\nNumber of audio frames/packets to be sent per second.\nMaximum number of audio frames/packets to be sent per …\nDefault bitrate for audio.\nLength (in milliseconds) of any audio frame.\nNumber of bytes in one complete frame of raw f32
-encoded …\nNumber of samples in one complete frame of audio per …\nProfile type used by Discord’s Opus audio traffic.\nThe one (and only) RTP version.\nSample rate of audio to be sent to Discord.\nSample rate of audio to be sent to Discord.\nOpus silent frame, used to signal speech start and end …\nNumber of bytes in one complete frame of raw f32
-encoded …\nNumber of individual samples in one complete frame of …\nLength of time between any two audio frames.\nType-converted delay between sends of UDP keepalive frames.\nDelay between sends of UDP keepalive frames.\nThe voice gateway version used by the library.\nMaximum packet size for a voice packet.\nDiscord’s currently preferred non-E2EE encryption scheme.\nDefault bitrate decided by the encoder (not recommended).\nOpus encoder bitrate settings.\nExplicit bitrate choice (in bits/second).\nThe channel layout of output audio when using …\nFuture for a call to Driver::connect
.\nVariants of the XSalsa20Poly1305
encryption scheme.\nThe default shared scheduler instance.\nDecrypts and decodes each received packet, correctly …\nDecode behaviour for received RTP packets within the …\nDecrypts the body of each received packet.\nThe scheduler exited or crashed while awating the request.\nThe control object for a Discord voice connection, …\nDecode to a sample rate of 12kHz.\nDecode to a sample rate of 16kHz.\nDecode to a sample rate of 24kHz.\nDecode to a sample rate of 48kHz.\nDecode to a sample rate of 8kHz.\nAn additional random 4B suffix is used as the source of …\nRuntime statistics for an individual worker.\nMaximum bitrate allowed (up to maximum number of bytes for …\nAllows at most n
tasks to run per thread.\nMixing behaviour for sent audio sources processed within …\nDecode received audio packets into a single channel.\nAudio sources will be downmixed into a mono buffer.\nThe RTP header is used as the source of nonce bytes for …\nPackets received from Discord are handed over to events …\nThe sample rate of output audio when using …\nA reference to a shared group of threads used for running …\nConfiguration for how a Scheduler
handles tasks.\nErrors encountered when communicating with the internals …\nStrategies for mapping live mixer tasks to individual …\nDecode received audio packets into two interleaved …\nAudio sources will be mixed into into a stereo buffer, …\nAn additional random 24B suffix is used as the source of …\nA fallback non-E2EE encryption scheme.\nAttach a global event handler to an audio context. Global …\nReturns the nonce length in bytes required by algorithm.\nReturns a view of this driver’s configuration.\nConnects to a voice channel using the specified server.\nLeaves the current connected voice channel, if connected …\nEncrypts a Discord RT(C)P packet using the given …\nAdds an existing Track
to this driver’s built-in queue.\nAdds an audio Input
to this driver’s built-in queue.\nAdd an existing Track
to the queue, using a known time to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the driver is muted (i.e., processes audio …\nReturns the number of nanoseconds required to process all …\nLeaves the current voice channel, disconnecting from it.\nReturns the number of mixer tasks scheduled on this worker …\nReturns the total number of active calls scheduled and …\nMove costly mixers to another thread if their parent …\nSets whether the current connection is to be muted.\nCreate a new mixer scheduler from the allocation strategy …\nCreates a new voice driver.\nReturns the number of bytes each nonce is stored as within …\nOpus encoder bitrate settings.\nCalculates the number of additional bytes required compared\nReturns the number of bytes occupied by the …\nReturns the number of bytes occupied by the encryption …\nPlays audio from a Track
object.\nPlays audio from an input, returning a handle for further …\nExclusively plays audio from a Track
object.\nPlays audio from an input, returning a handle for further …\nReturns a reference to this driver’s built-in queue.\nRemoves all global event handlers from an audio context.\nConfiguration for connection retries.\nSets the bitrate for encoding Opus packets sent along the …\nSets the configuration for this driver (and parent Call
, …\nReturns whether this mode will decrypt received packets.\nStops playing audio from all sources, if any are set.\nHow Live mixer tasks will be mapped to individual threads.\nReturns the number of bytes occupied by an encryption …\nReturns the name of a mode as it will appear during …\nReturns the total number of calls (idle and active) …\nRequest a list of handles to statistics for currently live …\nRequest a list of handles to statistics for currently live …\nReturns the total number of threads spawned to process …\nExponential backoff waiting strategy, where the duration …\nThe driver will wait for the same amount of time between …\nExponential backoff waiting strategy.\nConfiguration to be used for retrying driver connection …\nLogic used to determine how long to wait between retry …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nAmount of uniform random jitter to apply to generated wait …\nMaximum amount of time to wait between retries.\nMinimum amount of time to wait between retries.\nThe maximum number of retries to attempt.\nStrategy used to determine how long to wait between retry …\nThe driver hung up an internal signaller, either due to …\nErrors encountered while connecting to a Discord voice …\nConvenience type for Discord voice/driver connection error …\nAn error occurred during [en/de]cryption of voice packets.\nThe symmetric key supplied by Discord had the wrong size.\nServer did not return the expected crypto mode during …\nSelected crypto mode was not offered by server.\nThe driver failed to establish a voice connection.\nRequest to join was dropped, cancelled, or replaced.\nAn indicator that an endpoint URL was invalid.\nContains the error value\nContains the error value\nDiscord failed to correctly respond to IP discovery.\nCould not parse Discord’s view of our IP.\nFailed to message other background tasks after connection …\nMiscellaneous I/O error.\nError returned when a manager or call handler is unable to …\nConvenience type for Discord gateway error handling.\nJSON (de)serialization error.\nThis type represents all possible errors that can occur …\nTried to leave a Call
which was not found.\nNo available gateway connection was provided to send voice …\nContains the success value\nContains the success value\nSerenity-specific WebSocket send error.\nConnection attempt timed out.\nConnection details were not received from Discord in the …\nTwilight-specific WebSocket send error when a message …\nError communicating with gateway server over WebSocket.\nCategorizes the cause of this error.\nOne-based column number at which the error was detected.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nThe kind reported by the underlying standard library I/O …\nReturns true if this error was caused by input data that …\nReturns true if this error was caused by prematurely …\nReturns true if this error was caused by a failure to read …\nReturns true if this error was caused by input that was not\nOne-based line number at which the error was detected.\nIndicates whether this failure may have left (or been …\nIndicates whether this failure can be reattempted via …\nCancels the event, if it was intended to persist.\nFired whenever a client disconnects.\nFires whenever a user disconnects from the same stream as …\nUntimed events belonging to the global context, such as …\nCore events\nVoice core events occur on receipt of voice packets and …\nDelayed events rely upon a delay parameter, and fire one …\nFires when this driver successfully connects to a voice …\nFires when this driver successfully connects to a voice …\nFires when this driver fails to connect to, or drops from, …\nFires when this driver fails to connect to, or drops from, …\nFires when this driver successfully reconnects after a …\nFires when this driver successfully reconnects after a …\nThe attached track has ended.\nThe attached track has encountered a runtime or …\nClasses of event which may occur, triggering a handler at …\nInformation about which tracks or data fired an event.\nInternal representation of an event, as handled by the …\nTrait to handle an event which can be fired per-track, or …\nStorage for EventData
, designed to be used for both local …\nThe attached track has looped.\nThe attached track has been paused.\nPeriodic events rely upon two parameters: a period and an …\nThe attached track has resumed playing.\nThe attached track has become playable.\nThe attached track is being readied or recreated.\nTelemetry/statistics packet, received from another stream.\nFires on receipt of an RTCP packet, containing various …\nOpus audio packet, received from another stream.\nFires on receipt of a voice packet from another stream in …\nSpeaking state update, typically describing how another …\nSpeaking state update from the WS gateway, typically …\nTrack event context, passed to events created via …\nUntimed events belonging to a track, such as state …\nTrack events correspond to certain actions or changes of …\nTrack events correspond to certain actions or changes of …\nTrack and voice core events.\nReordered and decoded audio packets, received every 20ms.\nFires every 20ms, containing the scheduled voice packet …\nRespond to one received event.\nAdd an event to this store.\nComputes the next firing time for a timer event.\nTypes containing the main body of an EventContext
.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCreate a representation of an event and its associated …\nCreates a new event store to be used globally.\nCreates a new event store to be used within a Track
.\nRetreive the event class for an event (i.e., when matching)\nThis (re)connection attempt was dropped due to another …\nThe voice driver failed to connect to the server.\nVoice connection details gathered at setup/reinstantiation.\nVoice connection details gathered at termination or …\nThe location that a voice connection was terminated.\nThe reason that a voice connection failed.\nSongbird had an internal error.\nA host-specific I/O error caused the fault; this is likely …\nSongbird and Discord disagreed on the protocol used to …\nThe voice driver failed to reconnect to the server.\nThe call was manually disconnected by a user command, e.g. …\nTelemetry/statistics packet, received from another stream\nOpus audio packet, received from another stream\nThe voice connection was terminated mid-session by either …\nA voice connection was not established in the specified …\nVoice packet and audio data for a single user, from a …\nAudio data from all users in a voice channel, fired every …\nThe Websocket connection was closed by Discord.\nID of the voice channel being joined, if it is known.\nID of the voice channel being joined, if it is known.\nPCM audio obtained from a user.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nID of the target voice channel’s parent guild.\nID of the target voice channel’s parent guild.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nThe location that a voice connection was terminated.\nRaw RTCP packet data.\nRaw RTP packet data.\nRTP packet clocked out for this tick.\nNumber of bytes at the end of the packet to discard.\nNumber of bytes at the end of the packet to discard.\nByte index into the packet body (after headers) for where …\nByte index into the packet body (after headers) for where …\nThe cause of any connection failure.\nCreate a zero-copy view of the inner RTCP packet.\nCreate a zero-copy view of the inner RTP packet.\nThe domain name of Discord’s voice/TURN server.\nUnique string describing this session for …\nUnique string describing this session for …\nSet of all SSRCs currently known in the call who aren’t …\nDecoded voice data and source packets sent by each user.\nThe RTP SSRC (“Synchronisation source”) assigned by …\nID of a Discord voice/text channel.\nID of a Discord guild (colloquially, “server”).\nID of a Discord user.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nAn adapter for converting an async media source into a …\nAn async port of symphonia’s MediaSource
.\nAsyncReadOnlySource
wraps any source implementing …\nAn unread byte stream for an audio file.\nErrors encountered when creating an AudioStream
or …\nExtra information about an Input
which is acquired without …\nErrors encountered when trying to access out-of-band …\nHandle for a child process which ensures that any …\nData and behaviour required to instantiate a lazy audio …\nFailed to create a LiveInput
from the lazy Compose
.\nThe operation failed, and should not be retried.\nA lazily instantiated local file.\nLazy HLS stream\nA lazily instantiated HTTP request.\nAn audio source, which can be live or lazily initialised.\nA byte source which is not yet initialised.\nAn initialised byte source.\nAn initialised audio source.\nErrors encountered when readying or pre-processing an Input
…\nIn-stream information about an Input
acquired by parsing …\nErrors encountered when trying to access in-stream Metadata
…\nThis input has no lazy Compose
initialiser, which is …\nThis input is currently lazily initialised, and must be …\nThis input is ready, but has not had its headers parsed.\nA blocking thread panicked or failed to return a parsed …\nFailed to read headers, codecs, or a valid stream from a …\nAn audio file which has had its headers parsed and decoder …\nAn audio file which has had its headers parsed and decoder …\nAn unread, raw file stream.\nAdapter around a raw, interleaved, f32
PCM byte stream.\nThere was an error when trying to access auxiliary …\nThe operation failed, and should be retried after a given …\nThe operation was not supported, and will never succeed.\nAn unread file which has been wrapped with a large …\nA lazily instantiated call to download a file, finding its …\nThe album name of this stream.\nThe main artist of this stream.\nRequests auxiliary metadata which can be accessed without …\nRequests auxiliary metadata which can be accessed without …\nRequests auxiliary metadata which can be accessed without …\nReturns the length in bytes, if available. This may be an …\nIn-memory, shared input sources for reuse between calls, …\nThe YouTube channel of this stream.\nThe number of audio channels in this stream.\nA reqwest client instance used to send the HTTP GET …\nCodec registries extending Symphonia’s probe and …\nContent length, used as an upper bound in range requests …\nCreate a source synchronously.\nCreate a source asynchronously.\nThe date of creation of this stream.\nDecoder state for the chosen track.\nThe reported duration of this stream.\nMetadata found inside the format/container of an audio …\nAudio packet, seeking, and state access for all tracks in …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nExtract metadata and details from the output of …\nGets a reference to the underlying reader.\nHTTP header fields to add to any created requests.\nExtension and MIME type information which may help guide …\nThe wrapped file stream.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nUnwraps this AsyncReadOnlySource
, returning the underlying …\nReturns whether this stream’s headers have been fully …\nReturns whether this audio stream is full initialised, …\nReturns if the source is seekable. This may be an …\nReturns a reference to the live input, if it has been …\nReturns a mutable reference to the live input, if it been …\nInitialises (but does not parse) an Input::Lazy
into an …\nInitialises (but does not parse) an Input::Lazy
into an …\nInitialises and parses an Input::Lazy
into an Input::Live
, …\nInitialises and parses an Input::Lazy
into an Input::Live
, …\nMetadata extracted by symphonia while detecting a file’s …\nTries to get any information about this audio stream …\nTries to get any information about this audio stream …\nWrap and pull from an async file stream, with an …\nWrap an input PCM byte source to be readable by symphonia.\nCreate a new ChildContainer
from a child process\nCreates a lazy file object, which will open the target …\nCreate a lazy HLS request.\nCreate a lazy HTTP request.\nCreates a lazy request to select an audio stream from url
, …\nInstantiates a new AsyncReadOnlySource
by taking ownership …\nCreates a request to search youtube for an optionally …\nCreates a request to search youtube for an optionally …\nCreate a lazy HTTP request.\nCreate a lazy HTTP request.\nCreates a lazy request to select an audio stream from url
…\nReturns a reference to the data parsed from this input …\nReturns a reference to the data parsed from this input …\nReturns a mutable reference to the data parsed from this …\nReturns a mutable reference to the data parsed from this …\nMetadata found while probing for the format of an Input
…\nConverts this audio source into a Parsed
object using the …\nThe target URL of the required resource.\nThe sample rate of this stream.\nRuns a search for the given query, returning a list of up …\nDetermines whether this source will be instantiated using …\nThe source url of this stream.\nThe time at which the first true sample is played back.\nWhether the contained format supports arbitrary seeking.\nMove all fields from an AuxMetadata
object into a new one.\nThe thumbnail url of this stream.\nThe YouTube title of this stream.\nThe track name of this stream.\nThe chosen track’s ID.\nTries to recreate this stream in event of an error, …\nTries to recreate this stream in event of an error, …\nSets additional arguments for the “yt-dlp” process\nUtility methods for seeking or decoding.\nEstimate of a source’s length in bytes.\nErrors encountered using a Compressed
or Decompressed
…\nA wrapper around an existing Input
which compresses the …\nConfiguration for a cached source.\nThe audio stream could not be created.\nThe audio stream could not be created.\nThe audio stream failed to be created due to a panic in …\nThe audio stream failed to be created due to a panic in …\nA wrapper around an existing Input
which caches the …\nErrors encountered using a Memory
cached source.\nExpected amount of time that an input should last.\nA wrapper around an existing Input
which caches its data …\nThe file’s metadata could not be converted to JSON.\nThe input’s metadata was too large after conversion to …\nThe Opus encoder could not be created.\nTransform applied inside Compressed
, converting a …\nSymphonia failed to parse the container or decode the …\nThe input stream had already been read (i.e., Parsed
) and …\nThe input stream had already been read (i.e., Parsed
) and …\nStreamcatcher’s configuration was illegal, and the cache …\nStreamcatcher’s configuration was illegal, and the cache …\nEstimate of a source’s length in time.\nThe audio stream’s channel count could not be determined.\nModify the given cache configuration to initially allocate …\nRegistry of audio codecs supported by the driver.\nEstimates the cost, in B/s, of audio data compressed at …\nProvides the default config used by a cached source.\nGenerate a storage configuration given an estimated …\nRegistry of the muxers and container formats supported by …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nWrap an existing Input
with an in-memory store, compressed …\nWrap an existing Input
with an in-memory store, …\nWrap an existing Input
with an in-memory store with the …\nAcquire a new handle to this object, creating a new view …\nAcquire a new handle to this object, creating a new view …\nAcquire a new handle to this object, creating a new view …\nInner shared bytestore.\nInner shared bytestore.\nInner shared bytestore.\nCalculates the cost, in B/s, of raw floating-point audio …\nConfiguration for the inner streamcatcher instance.\nWrap an existing Input
with an in-memory store, compressed …\nWrap an existing Input
with an in-memory store, …\nWrap an existing Input
with an in-memory store with the …\nDefault Symphonia CodecRegistry
, including the …\nDCA[0/1] Format reader for Symphonia.\nOpus decoder for symphonia, based on libopus v1.3 (via …\nDefault Symphonia Probe, including DCA format support.\nSymphonia support for a simple container for raw f32-PCM …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalculates the time position in a FloatPCM
stream from a …\nCreate an Opus decoder outputting at a sample rate of …\nCalculates the time position in a FloatPCM
stream from a …\nCalculates the byte position in a FloatPCM
stream from a …\nCalculates the sample position in a FloatPCM
stream from a …\nFuture for a call to Call::join
.\nFuture for a call to Call::join_gateway
.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self)
.\nCalls U::from(self)
.\nHelper trait to add installation/creation methods to …\nZero-size type used to retrieve the registered Songbird
…\nReturns the argument unchanged.\nRetrieve the Songbird voice client from a serenity context…\nCalls U::from(self)
.\nInstalls a new songbird instance into the serenity client.\nInstalls a given songbird instance into the serenity …\nRegisters a new Songbird voice system with serenity, …\nRegisters a Songbird voice system serenity, based on the …\nRegisters a given Songbird voice system with serenity, as …\nInstalls a given songbird instance into the serenity …\nA generic shard handle source.\nHandle to a generic shard instance.\nTrait for a generic shard cluster or other handle source.\nSerenity-specific wrapper for sharder state initialised by …\nHandle to one of serenity’s shard runners.\nHandle to an individual shard designed to buffer unsent …\nSerenity-specific wrapper for sharder state initialised by …\nA reference to an individual websocket connection.\nSource of individual shard connection handles.\nTwilight-specific wrapper for a map of command senders.\nHandle to a map of twilight command senders.\nMap containing MessageSender
s for Twilight.\nTrait for a generic shard handle to send voice state …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nGet the message sender for shard_id
.\nGet access to a new shard\nReturns a new handle to the required inner shard.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nConstruct a map of shards and command senders to those …\nGet the total number of shards in the map.\nSend a voice update message to the inner shard handle.\nActions for the mixer to take after inspecting track state …\nErrors associated with control and manipulation of tracks.\nFailed to create a live bytestream from the lazy Compose
.\nFailed to decode a frame received from an Input
.\nAnother seek
/make_playable
request was made, and so this …\nThe track has naturally ended, and cannot be restarted.\nContains the error value\nThe track has encountered a runtime or initialisation …\nThe operation failed because the track has ended, has been …\nTrack will loop n
more times.\nTrack will loop endlessly until loop state is changed or …\nThe supplied event listener can never be fired by a track, …\nLooping behaviour for a Track
.\nContains the success value\nFailed to read headers, codecs, or a valid stream from an …\nThe track is currently paused, and may be resumed.\nA command to seek or ready the target track failed when …\nThe track is currently playing.\nErrors reported by the mixer while attempting to play (or …\nPlayback status of a track.\nThis track is fully initialised and usable.\nThe mixer is currently creating and parsing this track’s …\nReference to a track which is known to be part of a queue.\nWhether this track has been made live, is being processed, …\nFailed to seek to the requested location.\nThe track has been manually stopped, and cannot be …\nInitial state for audio playback.\nAsynchronous reply for an operation applied to a …\nHandle for safe control of a Track
from other threads, …\nA simple queue for several audio sources, designed to play …\nAlias for most calls to a TrackHandle
.\nState of an Track
object, designed to be passed to event …\nThis track is still a lazy Compose
object, and hasn’t …\nLive track and input state exposed during …\nPerform an arbitrary synchronous action on a raw Track
…\nAdds a Track
object to the queue, to be played in the …\nAttach an event handler to an audio track. These will …\nAdds an audio source to the queue, to be played in the …\nAdd an existing Track
to the queue, using a known time to …\nReturns a handle to the currently playing track.\nReturns a list of currently queued tracks.\nAttempts to remove a track from the specified index.\nSet an audio track to no longer loop.\nSet an audio track to loop indefinitely.\nList of events attached to this audio track.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nRequest playback information and state from the audio …\nClones the inner handle\nThe live or lazily-initialised audio stream to be played.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nCalls U::from(self)
.\nReturns whether the track has irreversibly stopped.\nReturns whether there are no tracks currently in the queue.\nReturns true
if the operation instantly failed due to the …\nReturns the number of tracks currently in the queue.\nSet an audio track to loop a set number of times.\nSet an audio track to loop a set number of times.\nThe number of remaning loops on this track.\nCount of remaining loops.\nRemaining loops on this track.\nReadies the track to be playable, if this is not already …\nReady a track for playing if it is lazily initialised.\nReady a track for playing if it is lazily initialised.\nIn-stream metadata for this track, if it is fully readied.\nAllows modification of the inner queue (i.e., deletion, …\nCreate a new track directly from an Input
and a random Uuid
…\nCreate a new, empty, track queue.\nCreate a new track directly from an Input
with a custom …\nPre-emptively pauses a track, preventing it from being …\nPauses an audio track.\nPause the track at the head of the queue.\nSets a track to playing if it is paused.\nUnpauses an audio track.\nThe total time a track has been played for.\nTotal playback time, increasing monotonically.\nThe current play status of this track.\nWhether or not this sound is currently playing.\nPlay status (e.g., active, paused, stopped) of this track.\nThe current position within this track.\nCurrent playback position in the source.\nWhether this track has been made live, is being processed, …\nWhether this track has been made live, is being processed, …\nConsumes this handle to await a reply from the driver, …\nConsumes this handle to await a reply from the driver …\nResume the track at the head of the queue.\nRequests a seek to the given time for this track.\nSeeks along the track to the specified position.\nSeeks along the track to the specified position.\nSets the volume of an audio track.\nSkip to the next track in the queue, if it exists.\nManually stops a track.\nStops an audio track.\nStop the currently playing track, and clears the queue.\nAllows access to this track’s attached TypeMap
.\nReturns this track’s unique identifier.\nReturns this handle’s (and track’s) unique identifier.\nUnique identifier for this track.\nSets volume
in a manner that allows method chaining.\nThe current mixing volume of this track.\nThe volume for playback.\nCurrent volume of this track.")
\ No newline at end of file
diff --git a/current/settings.html b/current/settings.html
index c769704df..8482fbf74 100644
--- a/current/settings.html
+++ b/current/settings.html
@@ -1 +1 @@
-pub const AUDIO_FRAME_RATE: usize = 50;
Number of audio frames/packets to be sent per second.
+pub const CHILD_BUFFER_LEN: usize = _; // 25usize
Maximum number of audio frames/packets to be sent per second to be buffered.
+pub const DEFAULT_BITRATE: Bitrate;
Default bitrate for audio.
+pub const FRAME_LEN_MS: usize = _; // 20usize
Length (in milliseconds) of any audio frame.
+pub const MONO_FRAME_BYTE_SIZE: usize = _; // 3_840usize
Number of bytes in one complete frame of raw f32
-encoded mono audio.
pub const MONO_FRAME_SIZE: usize = _; // 960usize
Number of samples in one complete frame of audio per channel.
+pub const RTP_PROFILE_TYPE: RtpType;
Profile type used by Discord’s Opus audio traffic.
+pub const RTP_PROFILE_TYPE: RtpType;
Profile type used by Discord’s Opus audio traffic.
pub const RTP_VERSION: u8 = 2;
The one (and only) RTP version.
+pub const SAMPLE_RATE: SampleRate;
Sample rate of audio to be sent to Discord.
+pub const SAMPLE_RATE: SampleRate;
Sample rate of audio to be sent to Discord.
pub const SAMPLE_RATE_RAW: usize = 48_000;
Sample rate of audio to be sent to Discord.
+pub const SILENT_FRAME: [u8; 3];
Opus silent frame, used to signal speech start and end (and prevent audio glitching).
+pub const STEREO_FRAME_BYTE_SIZE: usize = _; // 7_680usize
Number of bytes in one complete frame of raw f32
-encoded stereo audio.
pub const STEREO_FRAME_SIZE: usize = _; // 1_920usize
Number of individual samples in one complete frame of stereo audio.
+pub const TIMESTEP_LENGTH: Duration;
Length of time between any two audio frames.
+pub const UDP_KEEPALIVE_GAP: Duration;
Type-converted delay between sends of UDP keepalive frames.
+pub const UDP_KEEPALIVE_GAP_MS: u64 = 5_000;
Delay between sends of UDP keepalive frames.
+pub const VOICE_GATEWAY_VERSION: u8 = crate::model::constants::GATEWAY_VERSION; // 4u8
The voice gateway version used by the library.
+pub const VOICE_PACKET_MAX: usize = 1460;
Maximum packet size for a voice packet.
+Constants affecting driver function and API handling.
+Constants affecting driver function and API handling.
f32
-encoded mono audio.f32
-encoded stereo audio.pub enum Bitrate {
+Bitrate in songbird::driver - Rust Enum Bitrate
pub enum Bitrate {
BitsPerSecond(i32),
Max,
Auto,
diff --git a/current/songbird/driver/enum.Channels.html b/current/songbird/driver/enum.Channels.html
index a04736852..e4fbd8e32 100644
--- a/current/songbird/driver/enum.Channels.html
+++ b/current/songbird/driver/enum.Channels.html
@@ -1,4 +1,4 @@
-Channels in songbird::driver - Rust #[non_exhaustive]pub enum Channels {
+Channels in songbird::driver - Rust #[non_exhaustive]pub enum Channels {
Mono,
Stereo,
}
Expand description
The channel layout of output audio when using DecodeMode::Decode
.
diff --git a/current/songbird/driver/enum.CryptoMode.html b/current/songbird/driver/enum.CryptoMode.html
index 4416cc96c..7682d56d8 100644
--- a/current/songbird/driver/enum.CryptoMode.html
+++ b/current/songbird/driver/enum.CryptoMode.html
@@ -1,4 +1,4 @@
-CryptoMode in songbird::driver - Rust #[non_exhaustive]pub enum CryptoMode {
+CryptoMode in songbird::driver - Rust #[non_exhaustive]pub enum CryptoMode {
Aes256Gcm,
XChaCha20Poly1305,
Normal,
diff --git a/current/songbird/driver/enum.DecodeMode.html b/current/songbird/driver/enum.DecodeMode.html
index 52dbbacc6..1dfe30b08 100644
--- a/current/songbird/driver/enum.DecodeMode.html
+++ b/current/songbird/driver/enum.DecodeMode.html
@@ -1,4 +1,4 @@
-DecodeMode in songbird::driver - Rust #[non_exhaustive]pub enum DecodeMode {
+DecodeMode in songbird::driver - Rust #[non_exhaustive]pub enum DecodeMode {
Pass,
Decrypt,
Decode,
diff --git a/current/songbird/driver/enum.MixMode.html b/current/songbird/driver/enum.MixMode.html
index eae69a8a8..977d3814f 100644
--- a/current/songbird/driver/enum.MixMode.html
+++ b/current/songbird/driver/enum.MixMode.html
@@ -1,4 +1,4 @@
-MixMode in songbird::driver - Rust pub enum MixMode {
+MixMode in songbird::driver - Rust pub enum MixMode {
Mono,
Stereo,
}
Expand description
Mixing behaviour for sent audio sources processed within the driver.
diff --git a/current/songbird/driver/enum.SampleRate.html b/current/songbird/driver/enum.SampleRate.html
index bda8decc3..55bcdc026 100644
--- a/current/songbird/driver/enum.SampleRate.html
+++ b/current/songbird/driver/enum.SampleRate.html
@@ -1,4 +1,4 @@
-SampleRate in songbird::driver - Rust #[non_exhaustive]pub enum SampleRate {
+SampleRate in songbird::driver - Rust #[non_exhaustive]pub enum SampleRate {
Hz8000,
Hz12000,
Hz16000,
diff --git a/current/songbird/driver/enum.SchedulerError.html b/current/songbird/driver/enum.SchedulerError.html
index 455b86bc3..433c4d244 100644
--- a/current/songbird/driver/enum.SchedulerError.html
+++ b/current/songbird/driver/enum.SchedulerError.html
@@ -1,4 +1,4 @@
-SchedulerError in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerError {
+SchedulerError in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerError {
Disconnected,
}
Expand description
Errors encountered when communicating with the internals of a Scheduler
.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.§Disconnected
The scheduler exited or crashed while awating the request.
diff --git a/current/songbird/driver/enum.SchedulerMode.html b/current/songbird/driver/enum.SchedulerMode.html
index a4342f566..8026a39bc 100644
--- a/current/songbird/driver/enum.SchedulerMode.html
+++ b/current/songbird/driver/enum.SchedulerMode.html
@@ -1,4 +1,4 @@
-SchedulerMode in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerMode {
+SchedulerMode in songbird::driver - Rust #[non_exhaustive]pub enum SchedulerMode {
MaxPerThread(NonZeroUsize),
}
Expand description
Strategies for mapping live mixer tasks to individual threads.
Defaults to MaxPerThread(16)
.
diff --git a/current/songbird/driver/index.html b/current/songbird/driver/index.html
index f8a0c944b..915f2330e 100644
--- a/current/songbird/driver/index.html
+++ b/current/songbird/driver/index.html
@@ -1,4 +1,4 @@
-songbird::driver - Rust Expand description
Runner for a voice connection.
+songbird::driver - Rust Expand description
Runner for a voice connection.
Songbird’s driver is a mixed-sync system, using:
- Asynchronous connection management, event-handling, and gateway integration.
diff --git a/current/songbird/driver/retry/enum.Strategy.html b/current/songbird/driver/retry/enum.Strategy.html
index c99696474..e0fd65d6f 100644
--- a/current/songbird/driver/retry/enum.Strategy.html
+++ b/current/songbird/driver/retry/enum.Strategy.html
@@ -1,4 +1,4 @@
-Strategy in songbird::driver::retry - Rust #[non_exhaustive]pub enum Strategy {
+Strategy in songbird::driver::retry - Rust #[non_exhaustive]pub enum Strategy {
Every(Duration),
Backoff(ExponentialBackoff),
}
Expand description
Logic used to determine how long to wait between retry attempts.
diff --git a/current/songbird/driver/retry/index.html b/current/songbird/driver/retry/index.html
index 93118d733..7e80c2405 100644
--- a/current/songbird/driver/retry/index.html
+++ b/current/songbird/driver/retry/index.html
@@ -1,2 +1,2 @@
-songbird::driver::retry - Rust Expand description
Configuration for connection retries.
+songbird::driver::retry - Rust
\ No newline at end of file
diff --git a/current/songbird/driver/retry/struct.ExponentialBackoff.html b/current/songbird/driver/retry/struct.ExponentialBackoff.html
index ccbc271c9..4566d1748 100644
--- a/current/songbird/driver/retry/struct.ExponentialBackoff.html
+++ b/current/songbird/driver/retry/struct.ExponentialBackoff.html
@@ -1,4 +1,4 @@
-ExponentialBackoff in songbird::driver::retry - Rust pub struct ExponentialBackoff {
+ExponentialBackoff in songbird::driver::retry - Rust pub struct ExponentialBackoff {
pub min: Duration,
pub max: Duration,
pub jitter: f32,
diff --git a/current/songbird/driver/retry/struct.Retry.html b/current/songbird/driver/retry/struct.Retry.html
index 5e845cee5..4aff364f9 100644
--- a/current/songbird/driver/retry/struct.Retry.html
+++ b/current/songbird/driver/retry/struct.Retry.html
@@ -1,4 +1,4 @@
-Retry in songbird::driver::retry - Rust pub struct Retry {
+Retry in songbird::driver::retry - Rust pub struct Retry {
pub strategy: Strategy,
pub retry_limit: Option<usize>,
}
Expand description
Configuration to be used for retrying driver connection attempts.
diff --git a/current/songbird/driver/static.DEFAULT_SCHEDULER.html b/current/songbird/driver/static.DEFAULT_SCHEDULER.html
index 960f69913..556ceee59 100644
--- a/current/songbird/driver/static.DEFAULT_SCHEDULER.html
+++ b/current/songbird/driver/static.DEFAULT_SCHEDULER.html
@@ -1,4 +1,4 @@
-DEFAULT_SCHEDULER in songbird::driver - Rust pub static DEFAULT_SCHEDULER: Lazy<Scheduler>
Expand description
The default shared scheduler instance.
+DEFAULT_SCHEDULER in songbird::driver - Rust pub static DEFAULT_SCHEDULER: Lazy<Scheduler>
Expand description
The default shared scheduler instance.
This is built using the default value of ScheduleMode
. Users desiring
a custom strategy should avoid calling Config::default
.
\ No newline at end of file
diff --git a/current/songbird/driver/struct.Connect.html b/current/songbird/driver/struct.Connect.html
index 98365739e..6f9e3622b 100644
--- a/current/songbird/driver/struct.Connect.html
+++ b/current/songbird/driver/struct.Connect.html
@@ -1,4 +1,4 @@
-Connect in songbird::driver - Rust pub struct Connect { /* private fields */ }
Expand description
Future for a call to Driver::connect
.
+Connect in songbird::driver - Rust pub struct Connect { /* private fields */ }
Expand description
Future for a call to Driver::connect
.
This future awaits the result of a connection; the driver
is messaged at the time of the call.
Trait Implementations§
Source§impl Future for Connect
Source§fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>
Attempts to resolve the future to a final value, registering
diff --git a/current/songbird/driver/struct.DisposalThread.html b/current/songbird/driver/struct.DisposalThread.html
index 950691cd7..cad2c3601 100644
--- a/current/songbird/driver/struct.DisposalThread.html
+++ b/current/songbird/driver/struct.DisposalThread.html
@@ -1,4 +1,4 @@
-DisposalThread in songbird::driver - Rust pub struct DisposalThread(/* private fields */);
Implementations§
Trait Implementations§
Source§impl Clone for DisposalThread
Source§fn clone(&self) -> DisposalThread
Returns a copy of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moreSource§impl Debug for DisposalThread
Auto Trait Implementations§
§impl Freeze for DisposalThread
§impl RefUnwindSafe for DisposalThread
§impl Send for DisposalThread
§impl Sync for DisposalThread
§impl Unpin for DisposalThread
§impl UnwindSafe for DisposalThread
Blanket Implementations§