ui

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2022 License: Apache-2.0 Imports: 2 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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) OpenSourceProjector added in v0.11.0 

func (c *Client) OpenSourceProjector(params *OpenSourceProjectorParams) (*OpenSourceProjectorResponse, error)

Opens a projector for a source.

Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.

func (*Client) OpenVideoMixProjector added in v0.11.0 

func (c *Client) OpenVideoMixProjector(params *OpenVideoMixProjectorParams) (*OpenVideoMixProjectorResponse, error)

Opens a projector for a specific output video mix.

Mix types:

- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW` - `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM` - `OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW`

Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.

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 OpenSourceProjectorParams added in v0.11.0 

type OpenSourceProjectorParams struct {
	// Monitor index, use `GetMonitorList` to obtain index
	MonitorIndex float64 `json:"monitorIndex,omitempty"`

	// Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex`
	ProjectorGeometry string `json:"projectorGeometry,omitempty"`

	// Name of the source to open a projector for
	SourceName string `json:"sourceName,omitempty"`
}

Represents the request body for the OpenSourceProjector request.

func (*OpenSourceProjectorParams) GetRequestName added in v0.11.0 

func (o *OpenSourceProjectorParams) GetRequestName() string

Returns the associated request.

type OpenSourceProjectorResponse added in v0.11.0 

type OpenSourceProjectorResponse struct{}

Represents the response body for the OpenSourceProjector request.

type OpenVideoMixProjectorParams added in v0.11.0 

type OpenVideoMixProjectorParams struct {
	// Monitor index, use `GetMonitorList` to obtain index
	MonitorIndex float64 `json:"monitorIndex,omitempty"`

	// Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex`
	ProjectorGeometry string `json:"projectorGeometry,omitempty"`

	// Type of mix to open
	VideoMixType string `json:"videoMixType,omitempty"`
}

Represents the request body for the OpenVideoMixProjector request.

func (*OpenVideoMixProjectorParams) GetRequestName added in v0.11.0 

func (o *OpenVideoMixProjectorParams) GetRequestName() string

Returns the associated request.

type OpenVideoMixProjectorResponse added in v0.11.0 

type OpenVideoMixProjectorResponse struct{}

Represents the response body for the OpenVideoMixProjector 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.

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.