vmixgo

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 4, 2021 License: MIT Imports: 8 Imported by: 0

README

vmix-go

vmix RESTful API library for Go.(WIP)
Examples

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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"`
}

type Vmix 

type Vmix struct {
	Addr *url.URL `xml:"-"` // vmix API destination.

	// Available informations in /api endpoint (XML).
	XMLName xml.Name `xml:"vmix"`
	Version string   `xml:"version"` // vmix Version. e.g. "23.0.0.31"
	Edition string   `xml:"edition"` // vmix Edition. e.g. "4K"
	Preset  string   `xml:"preset"`  // vmix profile directory. e.g. "C:\my-profile.vmix"
	// Scenes slice
	Inputs struct {
		Input []Input `xml:"input"`
	} `xml:"inputs"`
	// Overlays slice
	Overlays struct {
		Overlay []Overlay `xml:"overlay"`
	} `xml:"overlays"`
	Preview       uint `xml:"preview"`     // Preview scene number
	Active        uint `xml:"active"`      // Active scene number
	IsFadeToBlack bool `xml:"fadeToBlack"` // FTB activated or not
	// vmix transition
	Transitions struct {
		Transition []Transition `xml:"transition"`
	} `xml:"transitions"`
	Recording   bool `xml:"recording"`   // Recording enabled
	External    bool `xml:"external"`    // External output enabled
	Streaming   bool `xml:"streaming"`   // RTMP Streaming enabled
	PlayList    bool `xml:"playList"`    // Playlist enabled
	MultiCorder bool `xml:"multiCorder"` // MultiCorder enabled
	FullScreen  bool `xml:"fullscreen"`  // FullScreen enabled
	// Audio?
	Audios struct {
		Master []Audio `xml:"master"`
	} `xml:"audio"`
}

Vmix main object

func NewVmix 

func NewVmix(addr string) (*Vmix, error)

NewVmix Creates Vmix instance

func (*Vmix) ActivatorRefresh 

func (v *Vmix) ActivatorRefresh() error

ActivatorRefresh Refresh all activator device lights and controls

func (*Vmix) BrowserBack 

func (v *Vmix) BrowserBack(input interface{}) error

BrowserBack ?

func (*Vmix) BrowserForward 

func (v *Vmix) BrowserForward(input interface{}) error

BrowserForward ?

func (*Vmix) BrowserKeyboardDisabled 

func (v *Vmix) BrowserKeyboardDisabled(input interface{}) error

BrowserKeyboardDisabled ?

func (*Vmix) BrowserKeyboardEnabled 

func (v *Vmix) BrowserKeyboardEnabled(input interface{}) error

BrowserKeyboardEnabled ?

func (*Vmix) BrowserMouseDisabled 

func (v *Vmix) BrowserMouseDisabled(input interface{}) error

BrowserMouseDisabled ?

func (*Vmix) BrowserMouseEnabled 

func (v *Vmix) BrowserMouseEnabled(input interface{}) error

BrowserMouseEnabled ?

func (*Vmix) BrowserNavigate 

func (v *Vmix) BrowserNavigate(input interface{}, url string) error

BrowserNavigate ?

func (*Vmix) BrowserReload 

func (v *Vmix) BrowserReload(input interface{}) error

BrowserReload ?

func (*Vmix) CallManagerShowHide 

func (v *Vmix) CallManagerShowHide() error

CallManagerShowHide ?

func (*Vmix) CrossZoom 

func (v *Vmix) CrossZoom(scene interface{}, duration uint) error

CrossZoom transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Cube 

func (v *Vmix) Cube(scene interface{}, duration uint) error

Cube transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) CubeZoom 

func (v *Vmix) CubeZoom(scene interface{}, duration uint) error

CubeZoom transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Cut 

func (v *Vmix) Cut(scene interface{}) error

Cut You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) CutDirect 

func (v *Vmix) CutDirect(scene interface{}, duration uint) error

CutDirect Cuts the input directly to Output without changing Preview. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) DataSourceAutoNextOff 

func (v *Vmix) DataSourceAutoNextOff(nametable string) error

DataSourceAutoNextOff Name of the Data Source, Table Name(optional) 2args or comma separated??

func (*Vmix) DataSourceAutoNextOn 

func (v *Vmix) DataSourceAutoNextOn(nametable string) error

DataSourceAutoNextOn Name of the Data Source, Table Name(optional) 2args or comma separated??

func (*Vmix) DataSourceAutoNextOnOff 

func (v *Vmix) DataSourceAutoNextOnOff(nametable string) error

DataSourceAutoNextOnOff Name of the Data Source, Table Name(optional) 2args or comma separated??

func (*Vmix) DataSourceNextRow 

func (v *Vmix) DataSourceNextRow(nametable string) error

DataSourceNextRow Name of the Data Source, Table Name(optional) eg 'Excel/CSV,Shee1'

func (*Vmix) DataSourcePreviousRow 

func (v *Vmix) DataSourcePreviousRow(nametable string) error

DataSourcePreviousRow Name of the Data Source, Table Name(optional) eg 'Excel/CSV,Shee1'

func (*Vmix) DataSourceSelectRow 

func (v *Vmix) DataSourceSelectRow(nametableindex string) error

DataSourceSelectRow Name of the Data Source, Table Name(optional) and Row Index starting from 0 eg 'Excel/CSV,Sheet1,5'

func (*Vmix) Fade 

func (v *Vmix) Fade(scene interface{}, duration uint) error

Fade transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) FadeToBlack 

func (v *Vmix) FadeToBlack() error

FadeToBlack Toggle FTB On/Off

func (*Vmix) Fly 

func (v *Vmix) Fly(scene interface{}, duration uint) error

Fly transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) FlyRotate 

func (v *Vmix) FlyRotate(scene interface{}, duration uint) error

FlyRotate transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Fullscreen 

func (v *Vmix) Fullscreen() error

Fullscreen Toggles Fullscreen On or Off

func (*Vmix) FullscreenOff 

func (v *Vmix) FullscreenOff() error

FullscreenOff ?

func (*Vmix) FullscreenOn 

func (v *Vmix) FullscreenOn() error

FullscreenOn ?

func (*Vmix) KeyPress 

func (v *Vmix) KeyPress(key string) error

KeyPress ?

func (*Vmix) LastPreset 

func (v *Vmix) LastPreset() error

LastPreset Load the last preset

func (*Vmix) Merge 

func (v *Vmix) Merge(scene interface{}, duration uint) error

Merge transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) NDICommand 

func (v *Vmix) NDICommand(input interface{}, command string) error

NDICommand Send specified command to NDI source

func (*Vmix) NDISelectSourceByIndex 

func (v *Vmix) NDISelectSourceByIndex(input interface{}, index uint) error

NDISelectSourceByIndex Index 0~100

func (*Vmix) NDISelectSourceByName 

func (v *Vmix) NDISelectSourceByName(input interface{}, name string) error

NDISelectSourceByName ?

func (*Vmix) NDIStartRecording 

func (v *Vmix) NDIStartRecording(input interface{}) error

NDIStartRecording ?

func (*Vmix) NDIStopRecording 

func (v *Vmix) NDIStopRecording(input interface{}) error

NDIStopRecording ?

func (*Vmix) OpenPreset 

func (v *Vmix) OpenPreset(filename string) error

OpenPreset Load preset from the specified Filename

func (*Vmix) QuickPlay 

func (v *Vmix) QuickPlay(scene interface{}) error

QuickPlay You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Refresh 

func (v *Vmix) Refresh() (*Vmix, error)

Refresh Inputs

func (*Vmix) SavePreset 

func (v *Vmix) SavePreset(filename string) error

SavePreset Save preset to the specified FIlename

func (*Vmix) ScriptStart 

func (v *Vmix) ScriptStart(scriptname string) error

ScriptStart ?

func (*Vmix) ScriptStartDynamic 

func (v *Vmix) ScriptStartDynamic(code string) error

ScriptStartDynamic Start a dynamic script using code specified as the Value

func (*Vmix) ScriptStop 

func (v *Vmix) ScriptStop(scriptname string) error

ScriptStop ?

func (*Vmix) ScriptStopAll 

func (v *Vmix) ScriptStopAll() error

ScriptStopAll ?

func (*Vmix) ScriptStopDynamic 

func (v *Vmix) ScriptStopDynamic() error

ScriptStopDynamic ?

func (*Vmix) SendFunction 

func (v *Vmix) SendFunction(funcname string, params map[string]string) error

SendFunction sends request to /api?Function=funcname&Key=Value...

func (*Vmix) SendKeys 

func (v *Vmix) SendKeys(keys string) error

SendKeys Send keys to active window

func (*Vmix) SetFader 

func (v *Vmix) SetFader(fader uint8) error

SetFader Set Master Fader T-Bar,255 will cut to Preview

func (*Vmix) SetOutput2 

func (v *Vmix) SetOutput2(input interface{}, value string) error

SetOutput2 Change what is displayed on Output 2 output. Preview,MultiView,Input?

func (*Vmix) SetOutput3 

func (v *Vmix) SetOutput3(input interface{}, value string) error

SetOutput3 Change what is displayed on Output 3 output. Preview,MultiView,Input?

func (*Vmix) SetOutput4 

func (v *Vmix) SetOutput4(input interface{}, value string) error

SetOutput4 Change what is displayed on Output 4 output. Preview,MultiView,Input?

func (*Vmix) SetOutputExternal2 

func (v *Vmix) SetOutputExternal2(input interface{}, value string) error

SetOutputExternal2 Change what is displayed on the External2 output. Preview,MultiView,Input?

func (*Vmix) SetOutputFullscreen 

func (v *Vmix) SetOutputFullscreen(input interface{}, value string) error

SetOutputFullscreen Change what is displayed on the Fullscreen output. Preview,MultiView,Input?

func (*Vmix) SetOutputFullscreen2 

func (v *Vmix) SetOutputFullscreen2(input interface{}, value string) error

SetOutputFullscreen2 Change what is displayed on the Fullscreen2 output. Preview,MultiView,Input?

func (*Vmix) SetTransitionDuration1 

func (v *Vmix) SetTransitionDuration1(duration uint) error

SetTransitionDuration1 Change Transition Duration for Button 1

func (*Vmix) SetTransitionDuration2 

func (v *Vmix) SetTransitionDuration2(duration uint) error

SetTransitionDuration2 Change Transition Duration for Button 2

func (*Vmix) SetTransitionDuration3 

func (v *Vmix) SetTransitionDuration3(duration uint) error

SetTransitionDuration3 Change Transition Duration for Button 3

func (*Vmix) SetTransitionDuration4 

func (v *Vmix) SetTransitionDuration4(duration uint) error

SetTransitionDuration4 Change Transition Duration for Button 4

func (*Vmix) SetTransitionEffect1 

func (v *Vmix) SetTransitionEffect1(transition string) error

SetTransitionEffect1 Change Transition for Button 1

func (*Vmix) SetTransitionEffect2 

func (v *Vmix) SetTransitionEffect2(transition string) error

SetTransitionEffect2 Change Transition for Button 1

func (*Vmix) SetTransitionEffect3 

func (v *Vmix) SetTransitionEffect3(transition string) error

SetTransitionEffect3 Change Transition for Button 1

func (*Vmix) SetTransitionEffect4 

func (v *Vmix) SetTransitionEffect4(transition string) error

SetTransitionEffect4 Change Transition for Button 1

func (*Vmix) Slide 

func (v *Vmix) Slide(scene interface{}, duration uint) error

Slide transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) SlideReverse 

func (v *Vmix) SlideReverse(scene interface{}, duration uint) error

SlideReverse transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Snapshot 

func (v *Vmix) Snapshot(savedir string) error

Snapshot Create a snapshot iamge of the current Output. Optional Value specifies save Filename, otherwise a save file window will appear.

func (*Vmix) SnapshotInput 

func (v *Vmix) SnapshotInput(input interface{}, savedir string) error

SnapshotInput Create a snapshot iamge of the selected Output. Optional Value specifies save Filename, otherwise a save file window will appear.

func (*Vmix) StartExternal 

func (v *Vmix) StartExternal() error

StartExternal ?

func (*Vmix) StartMultiCorder 

func (v *Vmix) StartMultiCorder() error

StartMultiCorder ?

func (*Vmix) StartRecording 

func (v *Vmix) StartRecording() error

StartRecording ?

func (*Vmix) StartStopExternal 

func (v *Vmix) StartStopExternal() error

StartStopExternal ?

func (*Vmix) StartStopMultiCorder 

func (v *Vmix) StartStopMultiCorder() error

StartStopMultiCorder ?

func (*Vmix) StartStopRecording 

func (v *Vmix) StartStopRecording() error

StartStopRecording ?

func (*Vmix) StartStopStreaming 

func (v *Vmix) StartStopStreaming(stream uint) error

StartStopStreaming Optional stream number starting from 0

func (*Vmix) StartStreaming 

func (v *Vmix) StartStreaming(stream uint) error

StartStreaming Optional stream number starting from 0

func (*Vmix) Stinger1 

func (v *Vmix) Stinger1(scene interface{}) error

Stinger1 You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Stinger2 

func (v *Vmix) Stinger2(scene interface{}) error

Stinger2 You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) StopExternal 

func (v *Vmix) StopExternal() error

StopExternal ?

func (*Vmix) StopMultiCorder 

func (v *Vmix) StopMultiCorder() error

StopMultiCorder ?

func (*Vmix) StopRecording 

func (v *Vmix) StopRecording() error

StopRecording ?

func (*Vmix) StopStreaming 

func (v *Vmix) StopStreaming(stream uint) error

StopStreaming Optional stream number starting from 0

func (*Vmix) StreamingSetKey 

func (v *Vmix) StreamingSetKey(stream string) error

StreamingSetKey Set Key on Custom RTMP Stream

func (*Vmix) StreamingSetPassword 

func (v *Vmix) StreamingSetPassword(stream string) error

StreamingSetPassword Set Password on Custom RTMP Stream

func (*Vmix) StreamingSetURL 

func (v *Vmix) StreamingSetURL(stream string) error

StreamingSetURL Set URL on Custom RTMP Stream

func (*Vmix) StreamingSetUsername 

func (v *Vmix) StreamingSetUsername(stream string) error

StreamingSetUsername Set Username on Custom RTMP Stream

func (*Vmix) Transition1 

func (v *Vmix) Transition1() error

Transition1 Clicks one of the four Transition buttons in the main vmix window

func (*Vmix) Transition2 

func (v *Vmix) Transition2() error

Transition2 Clicks one of the four Transition buttons in the main vmix window

func (*Vmix) Transition3 

func (v *Vmix) Transition3() error

Transition3 Clicks one of the four Transition buttons in the main vmix window

func (*Vmix) Transition4 

func (v *Vmix) Transition4() error

Transition4 Clicks one of the four Transition buttons in the main vmix window

func (*Vmix) VerticalSlide 

func (v *Vmix) VerticalSlide(scene interface{}, duration uint) error

VerticalSlide transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) VerticalSlideReverse 

func (v *Vmix) VerticalSlideReverse(scene interface{}, duration uint) error

VerticalSlideReverse transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) VerticalWipe 

func (v *Vmix) VerticalWipe(scene interface{}, duration uint) error

VerticalWipe transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) VerticalWipeReverse 

func (v *Vmix) VerticalWipeReverse(scene interface{}, duration uint) error

VerticalWipeReverse transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) Wipe 

func (v *Vmix) Wipe(scene interface{}, duration uint) error

Wipe transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) WipeReverse 

func (v *Vmix) WipeReverse(scene interface{}, duration uint) error

WipeReverse transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

func (*Vmix) WriteDurationToRecordingLog 

func (v *Vmix) WriteDurationToRecordingLog(tagtext string) error

WriteDurationToRecordingLog Write current recording duration to log file with optional tag text Value

func (*Vmix) Zoom 

func (v *Vmix) Zoom(scene interface{}, duration uint) error

Zoom transition. You can use string scene-key, int scene-number or vmixgo.Scene struct.

Source Files

View all Source files

Directories

Path Synopsis
examples
interactive command
scenes-list command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.