live

Documentation

Index

• Variables
• func Register(domain string, b Builder)
• type Builder
• type ID
• type Info
  • func (i *Info) MarshalJSON() ([]byte, error)
• type InitializingFinishedParam
• type InitializingLiveBuilder
• type Live
  • func New(url *url.URL, cache gcache.Cache, opts ...Option) (live Live, err error)
• type Option
  • func WithAudioOnly(audioOnly bool) Option
  • func WithKVStringCookies(u *url.URL, cookies string) Option
  • func WithQuality(quality int) Option
• type Options
  • func MustNewOptions(opts ...Option) *Options
  • func NewOptions(opts ...Option) (*Options, error)
• type StreamUrlInfo
• type WrappedLive
  • func (w *WrappedLive) GetInfo() (*Info, error)

Variables

var (
	ErrRoomNotExist     = errors.New("room not exists")
	ErrRoomUrlIncorrect = errors.New("room url incorrect")
	ErrInternalError    = errors.New("internal error")
	ErrNotImplemented   = errors.New("not implemented")
)

var CommonUserAgent = requests.UserAgent(userAgent)

Functions

func Register

func Register(domain string, b Builder)

Types

type Builder

type Builder interface {
	Build(*url.URL, ...Option) (Live, error)
}

type ID

type ID string

type Info

type Info struct {
	Live                 Live
	HostName, RoomName   string
	Status               bool // means isLiving, maybe better to rename it
	Listening, Recording bool
	Initializing         bool
	CustomLiveId         string
	AudioOnly            bool
}

func (*Info) MarshalJSON

func (i *Info) MarshalJSON() ([]byte, error)

type InitializingFinishedParam

type InitializingFinishedParam struct {
	InitializingLive Live
	Live             Live
	Info             *Info
}

type InitializingLiveBuilder

type InitializingLiveBuilder interface {
	Build(Live, *url.URL, ...Option) (Live, error)
}

var (
	InitializingLiveBuilderInstance InitializingLiveBuilder
)

type Live

type Live interface {
	SetLiveIdByString(string)
	GetLiveId() ID
	GetRawUrl() string
	GetInfo() (*Info, error)
	// Deprecated: GetStreamUrls is deprecated, using GetStreamInfos instead
	GetStreamUrls() ([]*url.URL, error)
	GetStreamInfos() ([]*StreamUrlInfo, error)
	GetPlatformCNName() string
	GetLastStartTime() time.Time
	SetLastStartTime(time.Time)
}

func New

func New(url *url.URL, cache gcache.Cache, opts ...Option) (live Live, err error)

type Option

type Option func(*Options)

func WithAudioOnly

func WithAudioOnly(audioOnly bool) Option

func WithKVStringCookies

func WithKVStringCookies(u *url.URL, cookies string) Option

func WithQuality

func WithQuality(quality int) Option

type Options

type Options struct {
	Cookies   *cookiejar.Jar
	Quality   int
	AudioOnly bool
}

func MustNewOptions

func MustNewOptions(opts ...Option) *Options

func NewOptions

func NewOptions(opts ...Option) (*Options, error)

type StreamUrlInfo

type StreamUrlInfo struct {
	Url                  *url.URL
	Name                 string
	Description          string
	Resolution           int
	Vbitrate             int
	HeadersForDownloader map[string]string
}

type WrappedLive

type WrappedLive struct {
	Live
	// contains filtered or unexported fields
}

func (*WrappedLive) GetInfo

func (w *WrappedLive) GetInfo() (*Info, error)