Documentation ¶
Index ¶
- type ConnectOptions
- func (opts *ConnectOptions) WithDialer(dialer *websocket.Dialer) *ConnectOptions
- func (opts *ConnectOptions) WithNumShards(numShards uint) *ConnectOptions
- func (opts *ConnectOptions) WithPassphrase(passphrase string) *ConnectOptions
- func (opts *ConnectOptions) WithResumeKey(resumeKey string) *ConnectOptions
- func (opts *ConnectOptions) WithUserID(userID string) *ConnectOptions
- type Connection
- type MockedConnection
- func (conn *MockedConnection) ConfigureResuming(resumeKey string, timeout uint) error
- func (conn *MockedConnection) Destroy(guildID string) error
- func (conn *MockedConnection) Events() <-chan event.Event
- func (conn *MockedConnection) Play(guildID string, trackID string, opts ...*play.Options) error
- func (conn *MockedConnection) Resumed() bool
- func (conn *MockedConnection) Seek(guildID string, position uint) error
- func (conn *MockedConnection) SetPaused(guildID string, paused bool) error
- func (conn *MockedConnection) Stop(guildID string) error
- func (conn *MockedConnection) UpdateVoice(guildID string, sessionID, token, endpoint string) error
- func (conn *MockedConnection) UpdateVolume(guildID string, volume uint) error
- func (conn *MockedConnection) UseEqualizer(guildID string, bands ...equalize.Band) error
- type MockedRequester
- func (r *MockedRequester) DecodeTracks(trackIDs ...string) ([]*track.Info, error)
- func (r *MockedRequester) LoadTracks(identifier string) (*loadtrack.Response, error)
- func (r *MockedRequester) Status() (*routeplanner.Status, error)
- func (r *MockedRequester) UnmarkAddress(address string) error
- func (r *MockedRequester) UnmarkAddresses() error
- type Requester
- type RequesterOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConnectOptions ¶ added in v1.0.0
type ConnectOptions struct {
// contains filtered or unexported fields
}
ConnectOptions is used to configure further specifications of the Connect method.
func NewConnectOptions ¶ added in v1.0.0
func NewConnectOptions() *ConnectOptions
NewConnectOptions returns a new ConnectOptions.
func (*ConnectOptions) WithDialer ¶ added in v1.0.0
func (opts *ConnectOptions) WithDialer(dialer *websocket.Dialer) *ConnectOptions
WithDialer sets the dialer to the parameter value.
func (*ConnectOptions) WithNumShards ¶ added in v1.0.0
func (opts *ConnectOptions) WithNumShards(numShards uint) *ConnectOptions
WithNumShards sets the number of shards to the parameter value.
func (*ConnectOptions) WithPassphrase ¶ added in v1.0.0
func (opts *ConnectOptions) WithPassphrase(passphrase string) *ConnectOptions
WithPassphrase sets the passphrase to the parameter value.
func (*ConnectOptions) WithResumeKey ¶ added in v1.0.0
func (opts *ConnectOptions) WithResumeKey(resumeKey string) *ConnectOptions
WithResumeKey sets the resume key to the parameter value.
func (*ConnectOptions) WithUserID ¶ added in v1.0.0
func (opts *ConnectOptions) WithUserID(userID string) *ConnectOptions
WithUserID sets the user id to the parameter value.
type Connection ¶ added in v1.0.0
type Connection interface { receiveevent.EventReceiver configureresuming.ResumingConfigurer destroy.Destroyer equalize.Equalizer pause.Pauser play.Player seek.Seeker stop.Stopper updatevoice.VoiceUpdater updatevolume.VolumeUpdater // Resumed returns true whenever the Connection has // been resumed. Resumed() bool }
Connection wraps all connection-oriented use cases.
func Connect ¶ added in v1.0.0
func Connect(ctx context.Context, host url.URL, opts ...*ConnectOptions) (Connection, error)
Connect opens a Connection to the passed host.
type MockedConnection ¶ added in v1.0.0
MockedConnection is the mocking implementation of Connection.
func (*MockedConnection) ConfigureResuming ¶ added in v1.0.0
func (conn *MockedConnection) ConfigureResuming(resumeKey string, timeout uint) error
ConfigureResuming configures the resume key used to resume a connection.
func (*MockedConnection) Destroy ¶ added in v1.0.0
func (conn *MockedConnection) Destroy(guildID string) error
Destroy is used to destroy a guild's audio player.
func (*MockedConnection) Events ¶ added in v1.1.3
func (conn *MockedConnection) Events() <-chan event.Event
Events returns a channel in which all events are streamed.
func (*MockedConnection) Play ¶ added in v1.0.0
Play plays the track with the given id on the guild's audio player. More options can be configured via Options.
func (*MockedConnection) Resumed ¶ added in v1.0.0
func (conn *MockedConnection) Resumed() bool
Resumed returns true whenever the Connection has been resumed.
func (*MockedConnection) Seek ¶ added in v1.0.0
func (conn *MockedConnection) Seek(guildID string, position uint) error
Seek skips the current track of a guild's audio player to the passed position.
func (*MockedConnection) SetPaused ¶ added in v1.0.0
func (conn *MockedConnection) SetPaused(guildID string, paused bool) error
SetPaused sets the paused state of a guild's audio player to the passed parameter value.
func (*MockedConnection) Stop ¶ added in v1.0.0
func (conn *MockedConnection) Stop(guildID string) error
Stop stops the current track of a guild's audio player.
func (*MockedConnection) UpdateVoice ¶ added in v1.0.0
func (conn *MockedConnection) UpdateVoice(guildID string, sessionID, token, endpoint string) error
UpdateVoice is sent when the voice server of a guild has been updated. This method must be performed to play a track. See: https://discord.com/developers/docs/topics/gateway#voice-server-update
func (*MockedConnection) UpdateVolume ¶ added in v1.0.0
func (conn *MockedConnection) UpdateVolume(guildID string, volume uint) error
UpdateVolume changes the volume of a guild's audio player.
func (*MockedConnection) UseEqualizer ¶ added in v1.0.0
func (conn *MockedConnection) UseEqualizer(guildID string, bands ...equalize.Band) error
UseEqualizer applies the passed bands on a guild's audio player.
type MockedRequester ¶ added in v1.0.0
MockedRequester is the mocking implementation of Requester.
func NewMockedRequester ¶ added in v1.0.0
func NewMockedRequester() *MockedRequester
NewMockedRequester returns a new MockedRequester.
func (*MockedRequester) DecodeTracks ¶ added in v1.0.0
func (r *MockedRequester) DecodeTracks(trackIDs ...string) ([]*track.Info, error)
DecodeTracks is used to decode the passed trackIDs to track infos.
func (*MockedRequester) LoadTracks ¶ added in v1.0.0
func (r *MockedRequester) LoadTracks(identifier string) (*loadtrack.Response, error)
LoadTracks loads multiple tracks by the passed identifier.
func (*MockedRequester) Status ¶ added in v1.0.0
func (r *MockedRequester) Status() (*routeplanner.Status, error)
Status returns the routeplanner's status.
func (*MockedRequester) UnmarkAddress ¶ added in v1.0.0
func (r *MockedRequester) UnmarkAddress(address string) error
UnmarkAddress unmarks the passed (failed) address.
func (*MockedRequester) UnmarkAddresses ¶ added in v1.0.0
func (r *MockedRequester) UnmarkAddresses() error
UnmarkAddresses unmarks all failed addresses.
type Requester ¶ added in v1.0.0
type Requester interface { decodetrack.TrackDecoder loadtrack.TrackLoader getstatus.StatusGetter unmarkaddress.AddressUnmarker unmarkaddresses.AddressesUnmarker }
Requester wraps all connectionless use cases.
func NewRequester ¶ added in v1.0.0
func NewRequester(host url.URL, opts ...*RequesterOptions) Requester
NewRequester returns a new Requester which uses the passed host as destination.
type RequesterOptions ¶ added in v1.0.0
type RequesterOptions struct {
// contains filtered or unexported fields
}
RequesterOptions is used to configure further specifications of the Requester.
func NewRequesterOptions ¶ added in v1.0.0
func NewRequesterOptions() *RequesterOptions
NewRequesterOptions returns a new RequesterOptions.
func (*RequesterOptions) WithClient ¶ added in v1.0.0
func (opts *RequesterOptions) WithClient(client *http.Client) *RequesterOptions
WithClient sets the client to the parameter value.
func (*RequesterOptions) WithPassphrase ¶ added in v1.0.0
func (opts *RequesterOptions) WithPassphrase(passphrase string) *RequesterOptions
WithPassphrase sets the passphrase to the parameter value.