vmixhttp

package
v0.2.3 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 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 Client 

type Client struct {

	// 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 []models.Input `xml:"input"`
	} `xml:"inputs"`
	// Overlays slice
	Overlays struct {
		Overlay []models.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 []models.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 []models.Audio `xml:"master"`
	} `xml:"audio"`
	// contains filtered or unexported fields
}

Client vMix HTTP API main object

func NewClient 

func NewClient(host string, port int) (*Client, error)

NewClient Creates new vMix HTTP API instance

func (*Client) ActivatorRefresh 

func (v *Client) ActivatorRefresh() error

ActivatorRefresh Refresh all activator device lights and controls

func (*Client) BrowserBack 

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

BrowserBack ?

func (*Client) BrowserForward 

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

BrowserForward ?

func (*Client) BrowserKeyboardDisabled 

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

BrowserKeyboardDisabled ?

func (*Client) BrowserKeyboardEnabled 

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

BrowserKeyboardEnabled ?

func (*Client) BrowserMouseDisabled 

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

BrowserMouseDisabled ?

func (*Client) BrowserMouseEnabled 

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

BrowserMouseEnabled ?

func (*Client) BrowserNavigate 

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

BrowserNavigate ?

func (*Client) BrowserReload 

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

BrowserReload ?

func (*Client) CallManagerShowHide 

func (v *Client) CallManagerShowHide() error

CallManagerShowHide ?

func (*Client) CrossZoom 

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

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

func (*Client) Cube 

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

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

func (*Client) CubeZoom 

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

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

func (*Client) Cut 

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

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

func (*Client) CutDirect 

func (v *Client) 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 (*Client) DataSourceAutoNextOff 

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

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

func (*Client) DataSourceAutoNextOn 

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

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

func (*Client) DataSourceAutoNextOnOff 

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

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

func (*Client) DataSourceNextRow 

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

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

func (*Client) DataSourcePreviousRow 

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

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

func (*Client) DataSourceSelectRow 

func (v *Client) 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 (*Client) Fade 

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

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

func (*Client) FadeToBlack 

func (v *Client) FadeToBlack() error

FadeToBlack Toggle FTB On/Off

func (*Client) Fly 

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

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

func (*Client) FlyRotate 

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

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

func (*Client) Fullscreen 

func (v *Client) Fullscreen() error

Fullscreen Toggles Fullscreen On or Off

func (*Client) FullscreenOff 

func (v *Client) FullscreenOff() error

FullscreenOff ?

func (*Client) FullscreenOn 

func (v *Client) FullscreenOn() error

FullscreenOn ?

func (*Client) KeyPress 

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

KeyPress ?

func (*Client) LastPreset 

func (v *Client) LastPreset() error

LastPreset Load the last preset

func (*Client) Merge 

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

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

func (*Client) NDICommand 

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

NDICommand Send specified command to NDI source

func (*Client) NDISelectSourceByIndex 

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

NDISelectSourceByIndex Index 0~100

func (*Client) NDISelectSourceByName 

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

NDISelectSourceByName ?

func (*Client) NDIStartRecording 

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

NDIStartRecording ?

func (*Client) NDIStopRecording 

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

NDIStopRecording ?

func (*Client) OpenPreset 

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

OpenPreset Load preset from the specified Filename

func (*Client) QuickPlay 

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

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

func (*Client) Refresh 

func (v *Client) Refresh() error

Refresh Inputs

func (*Client) SavePreset 

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

SavePreset Save preset to the specified FIlename

func (*Client) ScriptStart 

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

ScriptStart ?

func (*Client) ScriptStartDynamic 

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

ScriptStartDynamic Start a dynamic script using code specified as the Value

func (*Client) ScriptStop 

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

ScriptStop ?

func (*Client) ScriptStopAll 

func (v *Client) ScriptStopAll() error

ScriptStopAll ?

func (*Client) ScriptStopDynamic 

func (v *Client) ScriptStopDynamic() error

ScriptStopDynamic ?

func (*Client) SendFunction 

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

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

func (*Client) SendKeys 

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

SendKeys Send keys to active window

func (*Client) SetFader 

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

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

func (*Client) SetOutput2 

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

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

func (*Client) SetOutput3 

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

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

func (*Client) SetOutput4 

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

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

func (*Client) SetOutputExternal2 

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

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

func (*Client) SetOutputFullscreen 

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

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

func (*Client) SetOutputFullscreen2 

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

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

func (*Client) SetTransitionDuration1 

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

SetTransitionDuration1 Change Transition Duration for Button 1

func (*Client) SetTransitionDuration2 

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

SetTransitionDuration2 Change Transition Duration for Button 2

func (*Client) SetTransitionDuration3 

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

SetTransitionDuration3 Change Transition Duration for Button 3

func (*Client) SetTransitionDuration4 

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

SetTransitionDuration4 Change Transition Duration for Button 4

func (*Client) SetTransitionEffect1 

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

SetTransitionEffect1 Change Transition for Button 1

func (*Client) SetTransitionEffect2 

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

SetTransitionEffect2 Change Transition for Button 1

func (*Client) SetTransitionEffect3 

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

SetTransitionEffect3 Change Transition for Button 1

func (*Client) SetTransitionEffect4 

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

SetTransitionEffect4 Change Transition for Button 1

func (*Client) Slide 

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

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

func (*Client) SlideReverse 

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

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

func (*Client) Snapshot 

func (v *Client) 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 (*Client) SnapshotInput 

func (v *Client) 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 (*Client) StartExternal 

func (v *Client) StartExternal() error

StartExternal ?

func (*Client) StartMultiCorder 

func (v *Client) StartMultiCorder() error

StartMultiCorder ?

func (*Client) StartRecording 

func (v *Client) StartRecording() error

StartRecording ?

func (*Client) StartStopExternal 

func (v *Client) StartStopExternal() error

StartStopExternal ?

func (*Client) StartStopMultiCorder 

func (v *Client) StartStopMultiCorder() error

StartStopMultiCorder ?

func (*Client) StartStopRecording 

func (v *Client) StartStopRecording() error

StartStopRecording ?

func (*Client) StartStopStreaming 

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

StartStopStreaming Optional stream number starting from 0

func (*Client) StartStreaming 

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

StartStreaming Optional stream number starting from 0

func (*Client) Stinger1 

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

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

func (*Client) Stinger2 

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

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

func (*Client) StopExternal 

func (v *Client) StopExternal() error

StopExternal ?

func (*Client) StopMultiCorder 

func (v *Client) StopMultiCorder() error

StopMultiCorder ?

func (*Client) StopRecording 

func (v *Client) StopRecording() error

StopRecording ?

func (*Client) StopStreaming 

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

StopStreaming Optional stream number starting from 0

func (*Client) StreamingSetKey 

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

StreamingSetKey Set Key on Custom RTMP Stream

func (*Client) StreamingSetPassword 

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

StreamingSetPassword Set Password on Custom RTMP Stream

func (*Client) StreamingSetURL 

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

StreamingSetURL Set URL on Custom RTMP Stream

func (*Client) StreamingSetUsername 

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

StreamingSetUsername Set Username on Custom RTMP Stream

func (*Client) Transition1 

func (v *Client) Transition1() error

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

func (*Client) Transition2 

func (v *Client) Transition2() error

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

func (*Client) Transition3 

func (v *Client) Transition3() error

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

func (*Client) Transition4 

func (v *Client) Transition4() error

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

func (*Client) VerticalSlide 

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

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

func (*Client) VerticalSlideReverse 

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

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

func (*Client) VerticalWipe 

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

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

func (*Client) VerticalWipeReverse 

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

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

func (*Client) Wipe 

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

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

func (*Client) WipeReverse 

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

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

func (*Client) WriteDurationToRecordingLog 

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

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

func (*Client) Zoom 

func (v *Client) 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

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.