obsws

Documentation

Index

• type Client
  • func NewObsWebSocketClient(host, password string) (Client, error)
• type ClientImpl
  • func (c *ClientImpl) GetHost() string
  • func (c *ClientImpl) GetRemainingTimeOnCurrentScene(ctx context.Context) (*DurationAndCursor, error)
  • func (c *ClientImpl) ListScenes(ctx context.Context) ([]Scene, error)
  • func (c *ClientImpl) MoveSceneToNext(ctx context.Context) error
• type DurationAndCursor
• type Scene

Types

type Client

type Client interface {
	GetHost() string
	ListScenes(ctx context.Context) ([]Scene, error)
	MoveSceneToNext(ctx context.Context) error
	GetRemainingTimeOnCurrentScene(ctx context.Context) (*DurationAndCursor, error)
}

func NewObsWebSocketClient

func NewObsWebSocketClient(host, password string) (Client, error)

type ClientImpl

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

func (*ClientImpl) GetHost

func (c *ClientImpl) GetHost() string

func (*ClientImpl) GetRemainingTimeOnCurrentScene

func (c *ClientImpl) GetRemainingTimeOnCurrentScene(ctx context.Context) (*DurationAndCursor, error)

func (*ClientImpl) ListScenes

func (c *ClientImpl) ListScenes(ctx context.Context) ([]Scene, error)

ListScenes is output list of scenes. It is sorted order by as shown in OBS.

func (*ClientImpl) MoveSceneToNext

func (c *ClientImpl) MoveSceneToNext(ctx context.Context) error

type DurationAndCursor

type DurationAndCursor struct {
	DurationMilliSecond float64
	CursorMilliSecond   float64
}

type Scene

type Scene struct {
	Name             string
	SceneIndex       int
	IsCurrentProgram bool
}