obs

Documentation

Index

• Constants
• func InitConfig(cfg streamctl.Config)
• type Config
  • func GetConfig(ctx context.Context, cfg streamcontrol.Config) *Config
• type GetClientOption
• type OBS
  • func New(ctx context.Context, cfg Config) (*OBS, error)
  • func (obs *OBS) ApplyProfile(ctx context.Context, profile StreamProfile, customArgs ...any) error
  • func (obs *OBS) BanUser(ctx context.Context, userID streamcontrol.ChatUserID, reason string, ...) error
  • func (obs *OBS) Close() error
  • func (obs *OBS) EndStream(ctx context.Context) error
  • func (obs *OBS) Flush(ctx context.Context) error
  • func (obs *OBS) GetChatMessagesChan(ctx context.Context) (<-chan streamcontrol.ChatMessage, error)
  • func (obs *OBS) GetClient(clientOpts ...GetClientOption) (*goobs.Client, error)
  • func (obs *OBS) GetSceneList(ctx context.Context) (*scenes.GetSceneListResponse, error)
  • func (obs *OBS) GetStreamStatus(ctx context.Context) (_ret *streamcontrol.StreamStatus, _err error)
  • func (obs *OBS) InsertAdsCuePoint(ctx context.Context, ts time.Time, duration time.Duration) error
  • func (obs *OBS) IsCapable(ctx context.Context, cap streamcontrol.Capability) bool
  • func (obs *OBS) RemoveChatMessage(ctx context.Context, messageID streamcontrol.ChatMessageID) error
  • func (obs *OBS) SendChatMessage(ctx context.Context, message string) error
  • func (obs *OBS) SetCurrentProgramScene(ctx context.Context, req *scenes.SetCurrentProgramSceneParams) error
  • func (obs *OBS) SetDescription(ctx context.Context, description string) error
  • func (obs *OBS) SetTitle(ctx context.Context, title string) error
  • func (obs *OBS) StartStream(ctx context.Context, title string, description string, profile StreamProfile, ...) error
• type PlatformSpecificConfig
• type StreamProfile

Constants

const ID = types.ID

Functions

func InitConfig

func InitConfig(cfg streamctl.Config)

Types

type Config

type Config = types.Config

func GetConfig

func GetConfig(
	ctx context.Context,
	cfg streamcontrol.Config,
) *Config

type GetClientOption

type GetClientOption goobs.Option

type OBS

type OBS struct {
	Config        Config
	CurrentStream struct {
		EnableRecording bool
	}
	IsClosed bool
}

func New

func New(
	ctx context.Context,
	cfg Config,
) (*OBS, error)

func (*OBS) ApplyProfile

func (obs *OBS) ApplyProfile(
	ctx context.Context,
	profile StreamProfile,
	customArgs ...any,
) error

func (*OBS) BanUser

func (obs *OBS) BanUser(
	ctx context.Context,
	userID streamcontrol.ChatUserID,
	reason string,
	deadline time.Time,
) error

func (*OBS) Close

func (obs *OBS) Close() error

func (*OBS) EndStream

func (obs *OBS) EndStream(
	ctx context.Context,
) error

func (*OBS) Flush

func (obs *OBS) Flush(
	ctx context.Context,
) error

func (*OBS) GetChatMessagesChan

func (obs *OBS) GetChatMessagesChan(
	ctx context.Context,
) (<-chan streamcontrol.ChatMessage, error)

func (*OBS) GetClient

func (obs *OBS) GetClient(clientOpts ...GetClientOption) (*goobs.Client, error)

func (*OBS) GetSceneList

func (obs *OBS) GetSceneList(
	ctx context.Context,
) (*scenes.GetSceneListResponse, error)

func (*OBS) GetStreamStatus

func (obs *OBS) GetStreamStatus(
	ctx context.Context,
) (_ret *streamcontrol.StreamStatus, _err error)

func (*OBS) InsertAdsCuePoint

func (obs *OBS) InsertAdsCuePoint(
	ctx context.Context,
	ts time.Time,
	duration time.Duration,
) error

func (*OBS) IsCapable

func (obs *OBS) IsCapable(
	ctx context.Context,
	cap streamcontrol.Capability,
) bool

func (*OBS) RemoveChatMessage

func (obs *OBS) RemoveChatMessage(
	ctx context.Context,
	messageID streamcontrol.ChatMessageID,
) error

func (*OBS) SendChatMessage

func (obs *OBS) SendChatMessage(
	ctx context.Context,
	message string,
) error

func (*OBS) SetCurrentProgramScene

func (obs *OBS) SetCurrentProgramScene(
	ctx context.Context,
	req *scenes.SetCurrentProgramSceneParams,
) error

func (*OBS) SetDescription

func (obs *OBS) SetDescription(
	ctx context.Context,
	description string,
) error

func (*OBS) SetTitle

func (obs *OBS) SetTitle(
	ctx context.Context,
	title string,
) error

func (*OBS) StartStream

func (obs *OBS) StartStream(
	ctx context.Context,
	title string,
	description string,
	profile StreamProfile,
	customArgs ...any,
) error

type PlatformSpecificConfig

type PlatformSpecificConfig = types.PlatformSpecificConfig

type StreamProfile

type StreamProfile = types.StreamProfile