spatiussdkgo

package module

Go to main page

Versions in this module

v1

v1.1.0

Sep 6, 2026

Changes in this version

+ const DefaultRegionRequest

+ const DefaultSessionTokenTTL

+ const DefaultTelemetryEndpoint

+ func ConfigureTelemetry(endpoint string) error

+ func ForceFlushTelemetry()

+ func ShutdownTelemetry()

type AvatarSDKErrorCode

+ const ErrorCodeConnectionFailed

+ type BootstrapError struct

+ Message string

+ func (e *BootstrapError) Error() string

+ type PrewarmOption func(*prewarmConfig)

+ func WithPrewarmAPIKey(apiKey string) PrewarmOption

+ func WithPrewarmEndpointURLs(consoleEndpointURL, ingressEndpointURL string) PrewarmOption

+ func WithPrewarmRegion(region string) PrewarmOption

+ func WithPrewarmSessionExpireAt(expireAt time.Time) PrewarmOption

+ func WithPrewarmSessionTokenPrefetch(enabled bool) PrewarmOption

+ func WithPrewarmTLSWarmup(enabled bool) PrewarmOption

+ func WithPrewarmTimeout(timeout time.Duration) PrewarmOption

+ type PrewarmResult struct

+ ConsoleEndpointURL string

+ IngressEndpointURL string

+ Region string

+ SessionTokenPrefetched bool

+ TLSWarmed []string

+ func Prewarm(ctx context.Context, appID string, opts ...PrewarmOption) (result PrewarmResult)

type SessionConfig

+ ExtraParams map[string]string

type SessionOption

+ func WithExtraParams(extraParams map[string]string) SessionOption

v1.0.3

Jul 21, 2026

v1.0.2

Jul 7, 2026

v1.0.1

May 31, 2026

v1.0.0

May 13, 2026

Changes in this version

+ func GenerateLogID() (string, error)

+ type AgoraEgressConfig struct

+ ChannelName string

+ PublisherID string

+ Token string

+ UID uint32

+ type AudioFormat string

+ const AudioFormatOggOpus

+ const AudioFormatPCMS16LE

+ const DefaultRegion

+ type AvatarSDKError struct

+ Code AvatarSDKErrorCode

+ ConnectionID string

+ Message string

+ Phase string

+ ReqID string

+ ServerCode string

+ func NewAvatarSDKError(code AvatarSDKErrorCode, message string) *AvatarSDKError

+ func (e *AvatarSDKError) Error() string

+ type AvatarSDKErrorCode string

+ const ErrorCodeAppIDUnrecognized

+ const ErrorCodeEgressUnavailable

+ const ErrorCodeInvalidEgressConfig

+ const ErrorCodeInvalidRequest

+ const ErrorCodeProtocolError

+ const ErrorCodeSessionTokenExpired

+ const ErrorCodeSessionTokenInvalid

+ const ErrorCodeUnknown

+ type AvatarSession struct

+ func NewAvatarSession(opts ...SessionOption) *AvatarSession

+ func (s *AvatarSession) Close() error

+ func (s *AvatarSession) Config() SessionConfig

+ func (s *AvatarSession) Init(ctx context.Context) error

+ func (s *AvatarSession) Interrupt() (string, error)

+ func (s *AvatarSession) SendAudio(audio []byte, end bool) (string, error)

+ func (s *AvatarSession) Start(ctx context.Context) (string, error)

+ type EncodedAudioChunk struct

+ CompletedStream []byte

+ Payload []byte

+ type LiveKitEgressConfig struct

+ APIKey string

+ APISecret string

+ APIToken string

+ ExtraAttributes map[string]string

+ IdleTimeout int32

+ PublisherID string

+ RoomName string

+ URL string

+ type OggOpusApplication string

+ const OggOpusApplicationAudio

+ const OggOpusApplicationRestrictedLowdelay

+ const OggOpusApplicationVoIP

+ type OggOpusEncoderConfig struct

+ Application OggOpusApplication

+ FrameDurationMS int

+ type OggOpusStreamEncoder struct

+ func NewOggOpusStreamEncoder(sampleRate int, bitrate int, config *OggOpusEncoderConfig, ...) (*OggOpusStreamEncoder, error)

+ func (e *OggOpusStreamEncoder) Encode(pcmData []byte, end bool) (EncodedAudioChunk, error)

+ type SessionConfig struct

+ APIKey string

+ AgoraEgress *AgoraEgressConfig

+ AppID string

+ AudioFormat AudioFormat

+ AvatarID string

+ Bitrate int

+ ConsoleEndpointURL string

+ ExpireAt time.Time

+ IngressEndpointURL string

+ LiveKitEgress *LiveKitEgressConfig

+ OggOpusEncoder *OggOpusEncoderConfig

+ OnClose func()

+ OnEncodedAudio func(string, []byte)

+ OnError func(error)

+ Region string

+ SampleRate int

+ TransportFrames func([]byte, bool)

+ UseQueryAuth bool

+ type SessionOption func(*SessionConfig)

+ func WithAPIKey(apiKey string) SessionOption

+ func WithAgoraEgress(config *AgoraEgressConfig) SessionOption

+ func WithAppID(appID string) SessionOption

+ func WithAudioFormat(audioFormat AudioFormat) SessionOption

+ func WithAvatarID(avatarID string) SessionOption

+ func WithBitrate(bitrate int) SessionOption

+ func WithConsoleEndpointURL(endpointURL string) SessionOption

+ func WithExpireAt(expireAt time.Time) SessionOption

+ func WithIngressEndpointURL(endpointURL string) SessionOption

+ func WithLiveKitEgress(config *LiveKitEgressConfig) SessionOption

+ func WithOggOpusEncoder(config *OggOpusEncoderConfig) SessionOption

+ func WithOnClose(handler func()) SessionOption

+ func WithOnEncodedAudio(handler func(string, []byte)) SessionOption

+ func WithOnError(handler func(error)) SessionOption

+ func WithRegion(region string) SessionOption

+ func WithSampleRate(sampleRate int) SessionOption

+ func WithTransportFrames(handler func([]byte, bool)) SessionOption

+ func WithUseQueryAuth(useQueryAuth bool) SessionOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL