session

Documentation

Index

• type LeaveResult
• type NoOpSessionLifecycleObserver
  • func (NoOpSessionLifecycleObserver) OnCreated(event SessionCreatedEvent)
  • func (NoOpSessionLifecycleObserver) OnDeleted(event SessionDeletedEvent)
• type PersistenceManager
  • func NewPersistenceManager(applicationID snowflake.ID, redisClient *redis.Client, ...) *PersistenceManager
  • func (p *PersistenceManager) OnCreated(e SessionCreatedEvent)
  • func (p *PersistenceManager) OnDeleted(e SessionDeletedEvent)
  • func (p *PersistenceManager) Restore(ctx context.Context, sessionManager SessionManager, ...) error
  • func (p *PersistenceManager) StartHeartbeatLoop()
• type Session
  • func New(engineRegistry *tts.EngineRegistry, presetResolver preset.PresetResolver, ...) (*Session, error)
  • func (s *Session) Close(ctx context.Context)
  • func (s *Session) String() string
• type SessionCreatedEvent
• type SessionDeletedEvent
• type SessionLifecycleObserver
• type SessionManager
  • func NewSessionManager() SessionManager
• type SessionRestoreFunc
• type SpeechTask
  • func NewSpeechTask(segments []string, preset preset.Preset, opts ...SpeechTaskOpt) SpeechTask
• type SpeechTaskOpt
  • func WithSpeaker(speakerName string, speakerID snowflake.ID) SpeechTaskOpt

Types

type LeaveResult

type LeaveResult int

const (
	LeaveResultKeepAlive LeaveResult = iota
	LeaveResultClose
)

LeaveResult indicates which action to take after a user leaves the voice channel. LeaveResultKeepAlive means to keep the session alive, allowing it to continue processing messages. LeaveResultClose means to close the session, as there are no users left in the voice channel.

type NoOpSessionLifecycleObserver

type NoOpSessionLifecycleObserver struct{}

func (NoOpSessionLifecycleObserver) OnCreated

func (NoOpSessionLifecycleObserver) OnCreated(event SessionCreatedEvent)

func (NoOpSessionLifecycleObserver) OnDeleted

func (NoOpSessionLifecycleObserver) OnDeleted(event SessionDeletedEvent)

type PersistenceManager

type PersistenceManager struct {
	NoOpSessionLifecycleObserver
	// contains filtered or unexported fields
}

func NewPersistenceManager

func NewPersistenceManager(applicationID snowflake.ID, redisClient *redis.Client, heatbeatInterval time.Duration) *PersistenceManager

func (*PersistenceManager) OnCreated

func (p *PersistenceManager) OnCreated(e SessionCreatedEvent)

func (*PersistenceManager) OnDeleted

func (p *PersistenceManager) OnDeleted(e SessionDeletedEvent)

func (*PersistenceManager) Restore

func (p *PersistenceManager) Restore(ctx context.Context, sessionManager SessionManager, sessionRestoreFunc SessionRestoreFunc) error

func (*PersistenceManager) StartHeartbeatLoop

func (p *PersistenceManager) StartHeartbeatLoop()

type Session

type Session struct {
	// contains filtered or unexported fields
}

func New

func New(engineRegistry *tts.EngineRegistry, presetResolver preset.PresetResolver, textChannelID snowflake.ID, conn voice.Conn, tr *i18n.TextResource, vrs *i18n.VoiceResources) (*Session, error)

func (*Session) Close

func (s *Session) Close(ctx context.Context)

func (*Session) String

func (s *Session) String() string

type SessionCreatedEvent

type SessionCreatedEvent struct {
	// contains filtered or unexported fields
}

type SessionDeletedEvent

type SessionDeletedEvent struct {
	// contains filtered or unexported fields
}

type SessionLifecycleObserver

type SessionLifecycleObserver interface {
	OnCreated(event SessionCreatedEvent)
	OnDeleted(event SessionDeletedEvent)
}

type SessionManager

type SessionManager interface {
	// GetByVoiceChannel retrieves a session by its voice channel ID.
	GetByVoiceChannel(voiceChannelID snowflake.ID) (*Session, bool)
	// GetByReadingChannel retrieves a session by its reading channel ID.
	GetByReadingChannel(readingChannelID snowflake.ID) (*Session, bool)
	// Add adds a new session with the given voice and reading channel IDs.
	Add(guildID, voiceChannelID, readingChannelID snowflake.ID, session *Session)
	// Delete removes a session by its voice channel ID.
	Delete(guildID, voiceChannelID snowflake.ID)

	// AddObserver adds an observer to listen for session lifecycle events.
	AddObserver(observer SessionLifecycleObserver)
	// RemoveObserver removes an observer from listening for session lifecycle events.
	RemoveObserver(observer SessionLifecycleObserver)

	// CreateMessageHandler creates an event listener for message creation events.
	CreateMessageHandler() bot.EventListener
	// CreateVoiceStateHandler creates an event listener for voice state update events.
	CreateVoiceStateHandler() bot.EventListener
}

func NewSessionManager

func NewSessionManager() SessionManager

type SessionRestoreFunc

type SessionRestoreFunc func(guildID, voiceChannelID, readingChannelID snowflake.ID) (*Session, error)

type SpeechTask

type SpeechTask struct {
	Segments []string
	Preset   preset.Preset

	// option: with speaker?
	ContainsSpeaker bool
	SpeakerName     string
	SpeakerID       snowflake.ID
}

SpeechTask represents a task for text-to-speech processing.

func NewSpeechTask

func NewSpeechTask(segments []string, preset preset.Preset, opts ...SpeechTaskOpt) SpeechTask

type SpeechTaskOpt

type SpeechTaskOpt func(s *SpeechTask)

func WithSpeaker

func WithSpeaker(speakerName string, speakerID snowflake.ID) SpeechTaskOpt