Documentation
¶
Index ¶
- Constants
- type PreviewPI
- type ProgramPI
- type SendFunctionPI
- type StdVmix
- func (s *StdVmix) ApplicationDidLaunchHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) ApplicationDidTerminateHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) PreviewDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) PreviewKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) PreviewWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) ProgramDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) ProgramKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) ProgramWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) Run(ctx context.Context) error
- func (s *StdVmix) SendFuncDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) SendFuncKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) SendFuncWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
- func (s *StdVmix) Update()
Constants ¶
const ( // AppName Streamdeck plugin app name AppName = "dev.flowingspdg.vmix.sdPlugin" // ActionFunction SendFunction action Name ActionFunction = "dev.flowingspdg.vmix.function" // ActionPreview Preview input action Name ActionPreview = "dev.flowingspdg.vmix.preview" // ActionProgram Take input action Name ActionProgram = "dev.flowingspdg.vmix.program" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PreviewPI ¶
type PreviewPI struct { Input string `json:"input"` Inputs []input `json:"inputs"` Mix string `json:"mix"` Tally bool `json:"tally"` }
PreviewPI Property Inspector info for Preview
func (PreviewPI) GenerateFunction ¶
GenerateFunction Generate function query.
type ProgramPI ¶
type ProgramPI struct { Input string `json:"input"` Inputs []input `json:"inputs"` Mix string `json:"mix"` CutDirect bool `json:"cut_direct"` Tally bool `json:"tally"` }
ProgramPI Property Inspector info for PGM(Cut)
func (ProgramPI) GenerateFunction ¶
GenerateFunction Generate function query.
type SendFunctionPI ¶
type SendFunctionPI struct { Input string `json:"input"` Inputs []input `json:"inputs"` Name string `json:"name"` Queries []struct { Key string `json:"key"` Value string `json:"value"` } `json:"queries"` }
SendFunctionPI Settings for each button to save persistantly on action instance
func (SendFunctionPI) GenerateFunction ¶
func (p SendFunctionPI) GenerateFunction() (string, error)
GenerateFunction Generate function query.
type StdVmix ¶
type StdVmix struct {
// contains filtered or unexported fields
}
func NewStdVmix ¶
func NewStdVmix(ctx context.Context, params streamdeck.RegistrationParams) *StdVmix
func (*StdVmix) ApplicationDidLaunchHandler ¶
func (s *StdVmix) ApplicationDidLaunchHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
ApplicationDidLaunchHandler applicationDidLaunch handler
func (*StdVmix) ApplicationDidTerminateHandler ¶
func (s *StdVmix) ApplicationDidTerminateHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
ApplicationDidTerminateHandler applicationDidTerminate handler
func (*StdVmix) PreviewDidReceiveSettingsHandler ¶
func (s *StdVmix) PreviewDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
PreviewDidReceiveSettingsHandler didReceiveSettings Handler
func (*StdVmix) PreviewKeyDownHandler ¶
func (s *StdVmix) PreviewKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
PreviewKeyDownHandler keyDown handler
func (*StdVmix) PreviewWillAppearHandler ¶ added in v0.5.2
func (s *StdVmix) PreviewWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
PreviewWillAppearHandler willAppear handler.
func (*StdVmix) ProgramDidReceiveSettingsHandler ¶
func (s *StdVmix) ProgramDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
ProgramDidReceiveSettingsHandler didReceiveSettings Handler
func (*StdVmix) ProgramKeyDownHandler ¶
func (s *StdVmix) ProgramKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
ProgramKeyDownHandler keyDown handler
func (*StdVmix) ProgramWillAppearHandler ¶ added in v0.5.2
func (s *StdVmix) ProgramWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
PreviewWillAppearHandler willAppear handler.
func (*StdVmix) SendFuncDidReceiveSettingsHandler ¶
func (s *StdVmix) SendFuncDidReceiveSettingsHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
SendFuncDidReceiveSettingsHandler didReceiveSettings Handler
func (*StdVmix) SendFuncKeyDownHandler ¶
func (s *StdVmix) SendFuncKeyDownHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
SendFuncKeyDownHandler keyDown handler
func (*StdVmix) SendFuncWillAppearHandler ¶ added in v0.5.2
func (s *StdVmix) SendFuncWillAppearHandler(ctx context.Context, client *streamdeck.Client, event streamdeck.Event) error
SendFuncWillAppearHandler willAppear handler.