vmixtcp

package

v0.2.0 Latest Latest Go to latest Published: Apr 27, 2021 License: MIT Imports: 9 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/FlowingSPDG/vmix-go

Links

Open Source Insights

README ¶

vmix TCP API

vMix TCP API wrapper for Golang.

Author / 開発者

Shugo Kawamura / 河村柊吾
Github : FlowingSPDG
Twitter : @FlowingSPDG / @FlowingSPDG_EN

Documentation ¶

Constants ¶

View Source

const (
	EVENT_TALLY       string = "TALLY"
	EVENT_FUNCTION    string = "FUNCTION"
	EVENT_XML         string = "XML"
	EVENT_XMLTEXT     string = "XMLTEXT"
	EVENT_SUBSCRIBE   string = "SUBSCRIBE"
	EVENT_UNSUBSCRIBE string = "UNSUBSCRIBE"
	EVENT_QUIT        string = "QUIT"
	EVENT_ACTS        string = "ACTS"
)

View Source

const (
	// Terminate letter
	Terminate = "\r\n"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Response ¶

type Response struct {
	Command        string
	StatusOrLength string
	Response       string
	Data           string
}

Response TCP API Response

type TallyResponse ¶

type TallyResponse struct {
	Status string
	Tally  []TallyStatus
}

TallyResponse TALLY Event response

type TallyStatus ¶

type TallyStatus uint

TallyStatus alias to uint

const (
	Off TallyStatus = iota
	Program
	Preview
)

func (TallyStatus) String ¶

func (i TallyStatus) String() string

type Vmix ¶

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

Vmix main object

func New ¶

func New(dest string) (*Vmix, error)

New vmix instance. TODO:Support context

func (*Vmix) Close ¶

func (v *Vmix) Close() error

Close connection

func (*Vmix) FUNCTION ¶

func (v *Vmix) FUNCTION(funcname string) (string, error)

FUNCTION Send function

func (*Vmix) QUIT ¶

func (v *Vmix) QUIT() error

QUIT Sends QUIT sigal

func (*Vmix) Register ¶

func (v *Vmix) Register(command string, cb func(*Response)) error

Register goroutine callback event. Use tally event if it's for TALLY!!

func (*Vmix) Run ¶

func (v *Vmix) Run(ctx context.Context) error

Run start

func (v *Vmix) SUBSCRIBE(command string) (string, error)

SUBSCRIBE Event

func (*Vmix) TALLY ¶

func (v *Vmix) TALLY() (string, error)

TALLY Get tally status

func (*Vmix) UNSUBSCRIBE ¶

func (v *Vmix) UNSUBSCRIBE(command string) (string, error)

UNSUBSCRIBE from event.

func (*Vmix) Write ¶

func (v *Vmix) Write(b []byte) (n int, err error)

func (*Vmix) XML ¶

func (v *Vmix) XML() (string, error)

XML Gets XML data. Same as HTTP API.

func (*Vmix) XMLPATH ¶

func (v *Vmix) XMLPATH(xpath string) (string, error)

XMLPATH Gets XML data from specified XPATH

Source Files ¶

View all Source files

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