ui

Documentation

Index

• type Client
  • func (c *Client) GetMonitorList(paramss ...*GetMonitorListParams) (*GetMonitorListResponse, error)
  • func (c *Client) GetStudioModeEnabled(paramss ...*GetStudioModeEnabledParams) (*GetStudioModeEnabledResponse, error)
  • func (c *Client) OpenInputFiltersDialog(params *OpenInputFiltersDialogParams) (*OpenInputFiltersDialogResponse, error)
  • func (c *Client) OpenInputInteractDialog(params *OpenInputInteractDialogParams) (*OpenInputInteractDialogResponse, error)
  • func (c *Client) OpenInputPropertiesDialog(params *OpenInputPropertiesDialogParams) (*OpenInputPropertiesDialogResponse, error)
  • func (c *Client) SetStudioModeEnabled(params *SetStudioModeEnabledParams) (*SetStudioModeEnabledResponse, error)
• type GetMonitorListParams
  • func (o *GetMonitorListParams) GetRequestName() string
• type GetMonitorListResponse
• type GetStudioModeEnabledParams
  • func (o *GetStudioModeEnabledParams) GetRequestName() string
• type GetStudioModeEnabledResponse
• type OpenInputFiltersDialogParams
  • func (o *OpenInputFiltersDialogParams) GetRequestName() string
• type OpenInputFiltersDialogResponse
• type OpenInputInteractDialogParams
  • func (o *OpenInputInteractDialogParams) GetRequestName() string
• type OpenInputInteractDialogResponse
• type OpenInputPropertiesDialogParams
  • func (o *OpenInputPropertiesDialogParams) GetRequestName() string
• type OpenInputPropertiesDialogResponse
• type SetStudioModeEnabledParams
  • func (o *SetStudioModeEnabledParams) GetRequestName() string
• type SetStudioModeEnabledResponse

Types

type Client

type Client struct {
	*api.Client
}

Client represents a client for 'ui' requests.

func (*Client) GetMonitorList

func (c *Client) GetMonitorList(paramss ...*GetMonitorListParams) (*GetMonitorListResponse, error)

Gets a list of connected monitors and information about them.

func (*Client) GetStudioModeEnabled

func (c *Client) GetStudioModeEnabled(paramss ...*GetStudioModeEnabledParams) (*GetStudioModeEnabledResponse, error)

Gets whether studio is enabled.

func (*Client) OpenInputFiltersDialog

func (c *Client) OpenInputFiltersDialog(params *OpenInputFiltersDialogParams) (*OpenInputFiltersDialogResponse, error)

Opens the filters dialog of an input.

func (*Client) OpenInputInteractDialog

func (c *Client) OpenInputInteractDialog(
	params *OpenInputInteractDialogParams,
) (*OpenInputInteractDialogResponse, error)

Opens the interact dialog of an input.

func (*Client) OpenInputPropertiesDialog

func (c *Client) OpenInputPropertiesDialog(
	params *OpenInputPropertiesDialogParams,
) (*OpenInputPropertiesDialogResponse, error)

Opens the properties dialog of an input.

func (*Client) SetStudioModeEnabled

func (c *Client) SetStudioModeEnabled(params *SetStudioModeEnabledParams) (*SetStudioModeEnabledResponse, error)

Enables or disables studio mode

type GetMonitorListParams

type GetMonitorListParams struct{}

Represents the request body for the GetMonitorList request.

func (*GetMonitorListParams) GetRequestName

func (o *GetMonitorListParams) GetRequestName() string

Returns the associated request.

type GetMonitorListResponse

type GetMonitorListResponse struct {
	// List of detected monitors
	Monitors []*typedefs.Monitor `json:"monitors,omitempty"`
}

Represents the response body for the GetMonitorList request.

type GetStudioModeEnabledParams

type GetStudioModeEnabledParams struct{}

Represents the request body for the GetStudioModeEnabled request.

func (*GetStudioModeEnabledParams) GetRequestName

func (o *GetStudioModeEnabledParams) GetRequestName() string

Returns the associated request.

type GetStudioModeEnabledResponse

type GetStudioModeEnabledResponse struct {
	// Whether studio mode is enabled
	StudioModeEnabled bool `json:"studioModeEnabled,omitempty"`
}

Represents the response body for the GetStudioModeEnabled request.

type OpenInputFiltersDialogParams

type OpenInputFiltersDialogParams struct {
	// Name of the input to open the dialog of
	InputName string `json:"inputName,omitempty"`
}

Represents the request body for the OpenInputFiltersDialog request.

func (*OpenInputFiltersDialogParams) GetRequestName

func (o *OpenInputFiltersDialogParams) GetRequestName() string

Returns the associated request.

type OpenInputFiltersDialogResponse

type OpenInputFiltersDialogResponse struct{}

Represents the response body for the OpenInputFiltersDialog request.

type OpenInputInteractDialogParams

type OpenInputInteractDialogParams struct {
	// Name of the input to open the dialog of
	InputName string `json:"inputName,omitempty"`
}

Represents the request body for the OpenInputInteractDialog request.

func (*OpenInputInteractDialogParams) GetRequestName

func (o *OpenInputInteractDialogParams) GetRequestName() string

Returns the associated request.

type OpenInputInteractDialogResponse

type OpenInputInteractDialogResponse struct{}

Represents the response body for the OpenInputInteractDialog request.

type OpenInputPropertiesDialogParams

type OpenInputPropertiesDialogParams struct {
	// Name of the input to open the dialog of
	InputName string `json:"inputName,omitempty"`
}

Represents the request body for the OpenInputPropertiesDialog request.

func (*OpenInputPropertiesDialogParams) GetRequestName

func (o *OpenInputPropertiesDialogParams) GetRequestName() string

Returns the associated request.

type OpenInputPropertiesDialogResponse

type OpenInputPropertiesDialogResponse struct{}

Represents the response body for the OpenInputPropertiesDialog request.

type SetStudioModeEnabledParams

type SetStudioModeEnabledParams struct {
	// True == Enabled, False == Disabled
	StudioModeEnabled *bool `json:"studioModeEnabled,omitempty"`
}

Represents the request body for the SetStudioModeEnabled request.

func (*SetStudioModeEnabledParams) GetRequestName

func (o *SetStudioModeEnabledParams) GetRequestName() string

Returns the associated request.

type SetStudioModeEnabledResponse

type SetStudioModeEnabledResponse struct{}

Represents the response body for the SetStudioModeEnabled request.