models

Documentation

Index

• type APIXML
• type Audio
• type Input
• type Overlay
• type Transition

Types

type APIXML

type APIXML struct {
	XMLName xml.Name `xml:"vmix"`
	Text    string   `xml:",chardata"`
	Version string   `xml:"version"`
	Edition string   `xml:"edition"`
	Inputs  struct {
		Text  string `xml:",chardata"`
		Input []struct {
			Text       string `xml:",chardata"`
			Key        string `xml:"key,attr"`
			Number     string `xml:"number,attr"`
			Type       string `xml:"type,attr"`
			Title      string `xml:"title,attr"`
			ShortTitle string `xml:"shortTitle,attr"`
			State      string `xml:"state,attr"`
			Position   string `xml:"position,attr"`
			Duration   string `xml:"duration,attr"`
			Loop       string `xml:"loop,attr"`
		} `xml:"input"`
	} `xml:"inputs"`
	Overlays struct {
		Text    string `xml:",chardata"`
		Overlay []struct {
			Text   string `xml:",chardata"`
			Number string `xml:"number,attr"`
		} `xml:"overlay"`
	} `xml:"overlays"`
	Preview     string `xml:"preview"`
	Active      string `xml:"active"`
	FadeToBlack string `xml:"fadeToBlack"`
	Transitions struct {
		Text       string `xml:",chardata"`
		Transition []struct {
			Text     string `xml:",chardata"`
			Number   string `xml:"number,attr"`
			Effect   string `xml:"effect,attr"`
			Duration string `xml:"duration,attr"`
		} `xml:"transition"`
	} `xml:"transitions"`
	Recording   string `xml:"recording"`
	External    string `xml:"external"`
	Streaming   string `xml:"streaming"`
	PlayList    string `xml:"playList"`
	MultiCorder string `xml:"multiCorder"`
	Fullscreen  string `xml:"fullscreen"`
	Audio       struct {
		Text   string `xml:",chardata"`
		Master struct {
			Text             string `xml:",chardata"`
			Volume           string `xml:"volume,attr"`
			Muted            string `xml:"muted,attr"`
			MeterF1          string `xml:"meterF1,attr"`
			MeterF2          string `xml:"meterF2,attr"`
			HeadphonesVolume string `xml:"headphonesVolume,attr"`
		} `xml:"master"`
	} `xml:"audio"`
	Dynamic struct {
		Text   string `xml:",chardata"`
		Input1 string `xml:"input1"`
		Input2 string `xml:"input2"`
		Input3 string `xml:"input3"`
		Input4 string `xml:"input4"`
		Value1 string `xml:"value1"`
		Value2 string `xml:"value2"`
		Value3 string `xml:"value3"`
		Value4 string `xml:"value4"`
	} `xml:"dynamic"`
}

APIXML vMix XML API Response

type Audio

type Audio struct {
	Volume           float64 `xml:"volume,attr"`
	Muted            bool    `xml:"muted,attr"`
	MeterF1          float64 `xml:"meterF1,attr"`
	MeterF2          float64 `xml:"meterF2,attr"`
	HeadphonesVolume float64 `xml:"headphonesVolume,attr"`
}

type Input

type Input struct {
	// Common properties
	Name         string `xml:",chardata"`
	Key          string `xml:"key,attr"`
	Number       uint   `xml:"number,attr"`
	SceneType    string `xml:"type,attr"`
	Title        string `xml:"title,attr"` // same as Name??
	ShortTitle   string `xml:"shorttite,attr"`
	State        string `xml:"state,attr"` // Paused | Running
	AttrPosition int    `xml:"position,attr"`
	Duration     int    `xml:"duration,attr"`
	Loop         bool   `xml:"loop,attr"`

	// Sound related
	Muted       bool    `xml:"muted,attr"`
	Volume      float64 `xml:"volume,attr"`
	Balance     float64 `xml:"balance,attr"`
	Solo        bool    `xml:"solo,attr"`
	AudioBusses string  `xml:"audiobusses,attr"`
	MeterF1     float64 `xml:"meterF1,attr"`
	MeterF2     float64 `xml:"meterF2,attr"`
	GainDb      string  `xml:"gainDb,attr"`
	Position    struct {
		Text  string `xml:",chardata"`
		PanX  string `xml:"panX,attr"`
		PanY  string `xml:"panY,attr"`
		ZoomX string `xml:"zoomX,attr"`
		ZoomY string `xml:"zoomY,attr"`
	} `xml:"position"`

	// vMix Instant Replay
	Replay struct {
		Text      string  `xml:",chardata"`
		Live      bool    `xml:"live,attr"`
		Recording bool    `xml:"recording,attr"`
		Events    int     `xml:"events,attr"`
		CameraA   string  `xml:"cameraA,attr"`
		CameraB   string  `xml:"cameraB,attr"`
		Speed     float64 `xml:"speed,attr"`
		Timecode  string  `xml:"timecode"` // time.Time - e.g. 2020-08-14T16:23:13.832
	} `xml:"replay"`

	// Multi view
	Overlay []struct {
		Text     string `xml:",chardata"`
		Index    int    `xml:"index,attr"`
		Key      string `xml:"key,attr"`
		Position struct {
			Text  string  `xml:",chardata"`
			PanX  float64 `xml:"panX,attr"`
			PanY  float64 `xml:"panY,attr"`
			ZoomX float64 `xml:"zoomX,attr"`
			ZoomY float64 `xml:"zoomY,attr"`
		} `xml:"position"`
	} `xml:"overlay"`
}

type Overlay

type Overlay struct {
	Number uint `xml:"number,attr"`
}

type Transition

type Transition struct {
	Number   uint   `xml:"number,attr"`
	Effect   string `xml:"effect,attr"`
	Duration uint   `xml:"duration,attr"`
}