ui

package
v1.4.2 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2024 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 {
	// contains filtered or unexported fields
}

Client represents a client for 'ui' requests.

func NewClient added in v1.0.0 

func NewClient(c *api.Client) *Client

NewUi returns a new 'ui' client.

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(
	paramss ...*OpenInputFiltersDialogParams,
) (*OpenInputFiltersDialogResponse, error)

Opens the filters dialog of an input.

func (*Client) OpenInputInteractDialog 

func (c *Client) OpenInputInteractDialog(
	paramss ...*OpenInputInteractDialogParams,
) (*OpenInputInteractDialogResponse, error)

Opens the interact dialog of an input.

func (*Client) OpenInputPropertiesDialog 

func (c *Client) OpenInputPropertiesDialog(
	paramss ...*OpenInputPropertiesDialogParams,
) (*OpenInputPropertiesDialogResponse, error)

Opens the properties dialog of an input.

func (*Client) OpenSourceProjector added in v0.11.0 

func (c *Client) OpenSourceProjector(paramss ...*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 {

	// a list of detected monitors with some information
	Monitors []*typedefs.Monitor `json:"monitors,omitempty"`
	// contains filtered or unexported fields
}

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"`
	// contains filtered or unexported fields
}

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

	// UUID of the input to open the dialog of
	InputUuid *string `json:"inputUuid,omitempty"`
}

Represents the request body for the OpenInputFiltersDialog request.

func NewOpenInputFiltersDialogParams added in v1.0.0 

func NewOpenInputFiltersDialogParams() *OpenInputFiltersDialogParams

func (*OpenInputFiltersDialogParams) GetRequestName 

func (o *OpenInputFiltersDialogParams) GetRequestName() string

Returns the associated request.

func (*OpenInputFiltersDialogParams) WithInputName added in v1.0.0 

func (o *OpenInputFiltersDialogParams) WithInputName(x string) *OpenInputFiltersDialogParams

func (*OpenInputFiltersDialogParams) WithInputUuid added in v1.2.0 

func (o *OpenInputFiltersDialogParams) WithInputUuid(x string) *OpenInputFiltersDialogParams

type OpenInputFiltersDialogResponse 

type OpenInputFiltersDialogResponse struct {
	// contains filtered or unexported fields
}

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

	// UUID of the input to open the dialog of
	InputUuid *string `json:"inputUuid,omitempty"`
}

Represents the request body for the OpenInputInteractDialog request.

func NewOpenInputInteractDialogParams added in v1.0.0 

func NewOpenInputInteractDialogParams() *OpenInputInteractDialogParams

func (*OpenInputInteractDialogParams) GetRequestName 

func (o *OpenInputInteractDialogParams) GetRequestName() string

Returns the associated request.

func (*OpenInputInteractDialogParams) WithInputName added in v1.0.0 

func (o *OpenInputInteractDialogParams) WithInputName(x string) *OpenInputInteractDialogParams

func (*OpenInputInteractDialogParams) WithInputUuid added in v1.2.0 

func (o *OpenInputInteractDialogParams) WithInputUuid(x string) *OpenInputInteractDialogParams

type OpenInputInteractDialogResponse 

type OpenInputInteractDialogResponse struct {
	// contains filtered or unexported fields
}

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

	// UUID of the input to open the dialog of
	InputUuid *string `json:"inputUuid,omitempty"`
}

Represents the request body for the OpenInputPropertiesDialog request.

func NewOpenInputPropertiesDialogParams added in v1.0.0 

func NewOpenInputPropertiesDialogParams() *OpenInputPropertiesDialogParams

func (*OpenInputPropertiesDialogParams) GetRequestName 

func (o *OpenInputPropertiesDialogParams) GetRequestName() string

Returns the associated request.

func (*OpenInputPropertiesDialogParams) WithInputName added in v1.0.0 

func (o *OpenInputPropertiesDialogParams) WithInputName(x string) *OpenInputPropertiesDialogParams

func (*OpenInputPropertiesDialogParams) WithInputUuid added in v1.2.0 

func (o *OpenInputPropertiesDialogParams) WithInputUuid(x string) *OpenInputPropertiesDialogParams

type OpenInputPropertiesDialogResponse 

type OpenInputPropertiesDialogResponse struct {
	// contains filtered or unexported fields
}

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 *int `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"`

	// UUID of the source to open a projector for
	SourceUuid *string `json:"sourceUuid,omitempty"`
}

Represents the request body for the OpenSourceProjector request.

func NewOpenSourceProjectorParams added in v1.0.0 

func NewOpenSourceProjectorParams() *OpenSourceProjectorParams

func (*OpenSourceProjectorParams) GetRequestName added in v0.11.0 

func (o *OpenSourceProjectorParams) GetRequestName() string

Returns the associated request.

func (*OpenSourceProjectorParams) WithMonitorIndex added in v1.0.0 

func (o *OpenSourceProjectorParams) WithMonitorIndex(x int) *OpenSourceProjectorParams

func (*OpenSourceProjectorParams) WithProjectorGeometry added in v1.0.0 

func (o *OpenSourceProjectorParams) WithProjectorGeometry(x string) *OpenSourceProjectorParams

func (*OpenSourceProjectorParams) WithSourceName added in v1.0.0 

func (o *OpenSourceProjectorParams) WithSourceName(x string) *OpenSourceProjectorParams

func (*OpenSourceProjectorParams) WithSourceUuid added in v1.2.0 

func (o *OpenSourceProjectorParams) WithSourceUuid(x string) *OpenSourceProjectorParams

type OpenSourceProjectorResponse added in v0.11.0 

type OpenSourceProjectorResponse struct {
	// contains filtered or unexported fields
}

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 *int `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 NewOpenVideoMixProjectorParams added in v1.0.0 

func NewOpenVideoMixProjectorParams() *OpenVideoMixProjectorParams

func (*OpenVideoMixProjectorParams) GetRequestName added in v0.11.0 

func (o *OpenVideoMixProjectorParams) GetRequestName() string

Returns the associated request.

func (*OpenVideoMixProjectorParams) WithMonitorIndex added in v1.0.0 

func (o *OpenVideoMixProjectorParams) WithMonitorIndex(x int) *OpenVideoMixProjectorParams

func (*OpenVideoMixProjectorParams) WithProjectorGeometry added in v1.0.0 

func (o *OpenVideoMixProjectorParams) WithProjectorGeometry(x string) *OpenVideoMixProjectorParams

func (*OpenVideoMixProjectorParams) WithVideoMixType added in v1.0.0 

func (o *OpenVideoMixProjectorParams) WithVideoMixType(x string) *OpenVideoMixProjectorParams

type OpenVideoMixProjectorResponse added in v0.11.0 

type OpenVideoMixProjectorResponse struct {
	// contains filtered or unexported fields
}

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 NewSetStudioModeEnabledParams added in v1.0.0 

func NewSetStudioModeEnabledParams() *SetStudioModeEnabledParams

func (*SetStudioModeEnabledParams) GetRequestName 

func (o *SetStudioModeEnabledParams) GetRequestName() string

Returns the associated request.

func (*SetStudioModeEnabledParams) WithStudioModeEnabled added in v1.0.0 

func (o *SetStudioModeEnabledParams) WithStudioModeEnabled(x bool) *SetStudioModeEnabledParams

type SetStudioModeEnabledResponse 

type SetStudioModeEnabledResponse struct {
	// contains filtered or unexported fields
}

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.