outputs

Documentation

Index

• type Client
  • func (c *Client) GetOutputInfo(params *GetOutputInfoParams) (*GetOutputInfoResponse, error)
  • func (c *Client) ListOutputs(paramss ...*ListOutputsParams) (*ListOutputsResponse, error)
  • func (c *Client) StartOutput(params *StartOutputParams) (*StartOutputResponse, error)
  • func (c *Client) StopOutput(params *StopOutputParams) (*StopOutputResponse, error)
• type GetOutputInfoParams
  • func (o *GetOutputInfoParams) GetSelfName() string
• type GetOutputInfoResponse
• type ListOutputsParams
  • func (o *ListOutputsParams) GetSelfName() string
• type ListOutputsResponse
• type StartOutputParams
  • func (o *StartOutputParams) GetSelfName() string
• type StartOutputResponse
• type StopOutputParams
  • func (o *StopOutputParams) GetSelfName() string
• type StopOutputResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'outputs' requests

func (*Client) GetOutputInfo

func (c *Client) GetOutputInfo(params *GetOutputInfoParams) (*GetOutputInfoResponse, error)

GetOutputInfo sends the corresponding request to the connected OBS WebSockets server.

func (*Client) ListOutputs

func (c *Client) ListOutputs(paramss ...*ListOutputsParams) (*ListOutputsResponse, error)

ListOutputs sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) StartOutput

func (c *Client) StartOutput(params *StartOutputParams) (*StartOutputResponse, error)

StartOutput sends the corresponding request to the connected OBS WebSockets server.

func (*Client) StopOutput

func (c *Client) StopOutput(params *StopOutputParams) (*StopOutputResponse, error)

StopOutput sends the corresponding request to the connected OBS WebSockets server.

type GetOutputInfoParams

type GetOutputInfoParams struct {
	requests.ParamsBasic

	// Output name
	OutputName string `json:"outputName,omitempty"`
}

GetOutputInfoParams represents the params body for the "GetOutputInfo" request. Get information about a single output Since 4.7.0.

func (*GetOutputInfoParams) GetSelfName

func (o *GetOutputInfoParams) GetSelfName() string

GetSelfName just returns "GetOutputInfo".

type GetOutputInfoResponse

type GetOutputInfoResponse struct {
	requests.ResponseBasic

	// Output info
	OutputInfo typedefs.Output `json:"outputInfo,omitempty"`
}

GetOutputInfoResponse represents the response body for the "GetOutputInfo" request. Get information about a single output Since v4.7.0.

type ListOutputsParams

type ListOutputsParams struct {
	requests.ParamsBasic
}

ListOutputsParams represents the params body for the "ListOutputs" request. List existing outputs Since 4.7.0.

func (*ListOutputsParams) GetSelfName

func (o *ListOutputsParams) GetSelfName() string

GetSelfName just returns "ListOutputs".

type ListOutputsResponse

type ListOutputsResponse struct {
	requests.ResponseBasic

	// Outputs list
	Outputs []typedefs.Output `json:"outputs,omitempty"`
}

ListOutputsResponse represents the response body for the "ListOutputs" request. List existing outputs Since v4.7.0.

type StartOutputParams

type StartOutputParams struct {
	requests.ParamsBasic

	// Output name
	OutputName string `json:"outputName,omitempty"`
}

StartOutputParams represents the params body for the "StartOutput" request. Start an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way. Since 4.7.0.

func (*StartOutputParams) GetSelfName

func (o *StartOutputParams) GetSelfName() string

GetSelfName just returns "StartOutput".

type StartOutputResponse

type StartOutputResponse struct {
	requests.ResponseBasic
}

StartOutputResponse represents the response body for the "StartOutput" request. Start an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way. Since v4.7.0.

type StopOutputParams

type StopOutputParams struct {
	requests.ParamsBasic

	// Force stop (default: false)
	Force bool `json:"force"`

	// Output name
	OutputName string `json:"outputName,omitempty"`
}

StopOutputParams represents the params body for the "StopOutput" request. Stop an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way. Since 4.7.0.

func (*StopOutputParams) GetSelfName

func (o *StopOutputParams) GetSelfName() string

GetSelfName just returns "StopOutput".

type StopOutputResponse

type StopOutputResponse struct {
	requests.ResponseBasic
}

StopOutputResponse represents the response body for the "StopOutput" request. Stop an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way. Since v4.7.0.