outputs

package
v1.5.3 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2024 License: Apache-2.0 Imports: 2 Imported by: 2

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 'outputs' requests.

func NewClient added in v1.0.0 

func NewClient(c *api.Client) *Client

NewOutputs returns a new 'outputs' client.

func (*Client) GetLastReplayBufferReplay added in v0.9.0 

func (c *Client) GetLastReplayBufferReplay(
	paramss ...*GetLastReplayBufferReplayParams,
) (*GetLastReplayBufferReplayResponse, error)

Gets the filename of the last replay buffer save file.

func (*Client) GetOutputList added in v0.11.0 

func (c *Client) GetOutputList(paramss ...*GetOutputListParams) (*GetOutputListResponse, error)

Gets the list of available outputs.

func (*Client) GetOutputSettings added in v0.11.0 

func (c *Client) GetOutputSettings(params *GetOutputSettingsParams) (*GetOutputSettingsResponse, error)

Gets the settings of an output.

func (*Client) GetOutputStatus added in v0.11.0 

func (c *Client) GetOutputStatus(params *GetOutputStatusParams) (*GetOutputStatusResponse, error)

Gets the status of an output.

func (*Client) GetReplayBufferStatus added in v0.9.0 

func (c *Client) GetReplayBufferStatus(
	paramss ...*GetReplayBufferStatusParams,
) (*GetReplayBufferStatusResponse, error)

Gets the status of the replay buffer output.

func (*Client) GetVirtualCamStatus added in v0.9.0 

func (c *Client) GetVirtualCamStatus(paramss ...*GetVirtualCamStatusParams) (*GetVirtualCamStatusResponse, error)

Gets the status of the virtualcam output.

func (*Client) SaveReplayBuffer added in v0.9.0 

func (c *Client) SaveReplayBuffer(paramss ...*SaveReplayBufferParams) (*SaveReplayBufferResponse, error)

Saves the contents of the replay buffer output.

func (*Client) SetOutputSettings added in v0.11.0 

func (c *Client) SetOutputSettings(params *SetOutputSettingsParams) (*SetOutputSettingsResponse, error)

Sets the settings of an output.

func (*Client) StartOutput 

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

Starts an output.

func (*Client) StartReplayBuffer added in v0.9.0 

func (c *Client) StartReplayBuffer(paramss ...*StartReplayBufferParams) (*StartReplayBufferResponse, error)

Starts the replay buffer output.

func (*Client) StartVirtualCam added in v0.9.0 

func (c *Client) StartVirtualCam(paramss ...*StartVirtualCamParams) (*StartVirtualCamResponse, error)

Starts the virtualcam output.

func (*Client) StopOutput 

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

Stops an output.

func (*Client) StopReplayBuffer added in v0.9.0 

func (c *Client) StopReplayBuffer(paramss ...*StopReplayBufferParams) (*StopReplayBufferResponse, error)

Stops the replay buffer output.

func (*Client) StopVirtualCam added in v0.9.0 

func (c *Client) StopVirtualCam(paramss ...*StopVirtualCamParams) (*StopVirtualCamResponse, error)

Stops the virtualcam output.

func (*Client) ToggleOutput added in v0.11.0 

func (c *Client) ToggleOutput(params *ToggleOutputParams) (*ToggleOutputResponse, error)

Toggles the status of an output.

func (*Client) ToggleReplayBuffer added in v0.9.0 

func (c *Client) ToggleReplayBuffer(paramss ...*ToggleReplayBufferParams) (*ToggleReplayBufferResponse, error)

Toggles the state of the replay buffer output.

func (*Client) ToggleVirtualCam added in v0.9.0 

func (c *Client) ToggleVirtualCam(paramss ...*ToggleVirtualCamParams) (*ToggleVirtualCamResponse, error)

Toggles the state of the virtualcam output.

type GetLastReplayBufferReplayParams added in v0.9.0 

type GetLastReplayBufferReplayParams struct{}

Represents the request body for the GetLastReplayBufferReplay request.

func (*GetLastReplayBufferReplayParams) GetRequestName added in v0.9.0 

func (o *GetLastReplayBufferReplayParams) GetRequestName() string

Returns the associated request.

type GetLastReplayBufferReplayResponse added in v0.9.0 

type GetLastReplayBufferReplayResponse struct {

	// File path
	SavedReplayPath string `json:"savedReplayPath,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetLastReplayBufferReplay request.

type GetOutputListParams added in v0.11.0 

type GetOutputListParams struct{}

Represents the request body for the GetOutputList request.

func (*GetOutputListParams) GetRequestName added in v0.11.0 

func (o *GetOutputListParams) GetRequestName() string

Returns the associated request.

type GetOutputListResponse added in v0.11.0 

type GetOutputListResponse struct {

	// Array of outputs
	Outputs []*typedefs.Output `json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetOutputList request.

type GetOutputSettingsParams added in v0.11.0 

type GetOutputSettingsParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`
}

Represents the request body for the GetOutputSettings request.

func NewGetOutputSettingsParams added in v1.0.0 

func NewGetOutputSettingsParams() *GetOutputSettingsParams

func (*GetOutputSettingsParams) GetRequestName added in v0.11.0 

func (o *GetOutputSettingsParams) GetRequestName() string

Returns the associated request.

func (*GetOutputSettingsParams) WithOutputName added in v1.0.0 

func (o *GetOutputSettingsParams) WithOutputName(x string) *GetOutputSettingsParams

type GetOutputSettingsResponse added in v0.11.0 

type GetOutputSettingsResponse struct {

	// Output settings
	OutputSettings map[string]any `json:"outputSettings,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetOutputSettings request.

type GetOutputStatusParams added in v0.11.0 

type GetOutputStatusParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`
}

Represents the request body for the GetOutputStatus request.

func NewGetOutputStatusParams added in v1.0.0 

func NewGetOutputStatusParams() *GetOutputStatusParams

func (*GetOutputStatusParams) GetRequestName added in v0.11.0 

func (o *GetOutputStatusParams) GetRequestName() string

Returns the associated request.

func (*GetOutputStatusParams) WithOutputName added in v1.0.0 

func (o *GetOutputStatusParams) WithOutputName(x string) *GetOutputStatusParams

type GetOutputStatusResponse added in v0.11.0 

type GetOutputStatusResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`

	// Number of bytes sent by the output
	OutputBytes float64 `json:"outputBytes,omitempty"`

	// Congestion of the output
	OutputCongestion float64 `json:"outputCongestion,omitempty"`

	// Current duration in milliseconds for the output
	OutputDuration float64 `json:"outputDuration,omitempty"`

	// Whether the output is reconnecting
	OutputReconnecting bool `json:"outputReconnecting,omitempty"`

	// Number of frames skipped by the output's process
	OutputSkippedFrames float64 `json:"outputSkippedFrames,omitempty"`

	// Current formatted timecode string for the output
	OutputTimecode string `json:"outputTimecode,omitempty"`

	// Total number of frames delivered by the output's process
	OutputTotalFrames float64 `json:"outputTotalFrames,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetOutputStatus request.

type GetReplayBufferStatusParams added in v0.9.0 

type GetReplayBufferStatusParams struct{}

Represents the request body for the GetReplayBufferStatus request.

func (*GetReplayBufferStatusParams) GetRequestName added in v0.9.0 

func (o *GetReplayBufferStatusParams) GetRequestName() string

Returns the associated request.

type GetReplayBufferStatusResponse added in v0.9.0 

type GetReplayBufferStatusResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetReplayBufferStatus request.

type GetVirtualCamStatusParams added in v0.9.0 

type GetVirtualCamStatusParams struct{}

Represents the request body for the GetVirtualCamStatus request.

func (*GetVirtualCamStatusParams) GetRequestName added in v0.9.0 

func (o *GetVirtualCamStatusParams) GetRequestName() string

Returns the associated request.

type GetVirtualCamStatusResponse added in v0.9.0 

type GetVirtualCamStatusResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetVirtualCamStatus request.

type SaveReplayBufferParams added in v0.9.0 

type SaveReplayBufferParams struct{}

Represents the request body for the SaveReplayBuffer request.

func (*SaveReplayBufferParams) GetRequestName added in v0.9.0 

func (o *SaveReplayBufferParams) GetRequestName() string

Returns the associated request.

type SaveReplayBufferResponse added in v0.9.0 

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

Represents the response body for the SaveReplayBuffer request.

type SetOutputSettingsParams added in v0.11.0 

type SetOutputSettingsParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`

	// Output settings
	OutputSettings map[string]any `json:"outputSettings,omitempty"`
}

Represents the request body for the SetOutputSettings request.

func NewSetOutputSettingsParams added in v1.0.0 

func NewSetOutputSettingsParams() *SetOutputSettingsParams

func (*SetOutputSettingsParams) GetRequestName added in v0.11.0 

func (o *SetOutputSettingsParams) GetRequestName() string

Returns the associated request.

func (*SetOutputSettingsParams) WithOutputName added in v1.0.0 

func (o *SetOutputSettingsParams) WithOutputName(x string) *SetOutputSettingsParams

func (*SetOutputSettingsParams) WithOutputSettings added in v1.0.0 

func (o *SetOutputSettingsParams) WithOutputSettings(x map[string]any) *SetOutputSettingsParams

type SetOutputSettingsResponse added in v0.11.0 

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

Represents the response body for the SetOutputSettings request.

type StartOutputParams 

type StartOutputParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`
}

Represents the request body for the StartOutput request.

func NewStartOutputParams added in v1.0.0 

func NewStartOutputParams() *StartOutputParams

func (*StartOutputParams) GetRequestName added in v0.11.0 

func (o *StartOutputParams) GetRequestName() string

Returns the associated request.

func (*StartOutputParams) WithOutputName added in v1.0.0 

func (o *StartOutputParams) WithOutputName(x string) *StartOutputParams

type StartOutputResponse 

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

Represents the response body for the StartOutput request.

type StartReplayBufferParams added in v0.9.0 

type StartReplayBufferParams struct{}

Represents the request body for the StartReplayBuffer request.

func (*StartReplayBufferParams) GetRequestName added in v0.9.0 

func (o *StartReplayBufferParams) GetRequestName() string

Returns the associated request.

type StartReplayBufferResponse added in v0.9.0 

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

Represents the response body for the StartReplayBuffer request.

type StartVirtualCamParams added in v0.9.0 

type StartVirtualCamParams struct{}

Represents the request body for the StartVirtualCam request.

func (*StartVirtualCamParams) GetRequestName added in v0.9.0 

func (o *StartVirtualCamParams) GetRequestName() string

Returns the associated request.

type StartVirtualCamResponse added in v0.9.0 

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

Represents the response body for the StartVirtualCam request.

type StopOutputParams 

type StopOutputParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`
}

Represents the request body for the StopOutput request.

func NewStopOutputParams added in v1.0.0 

func NewStopOutputParams() *StopOutputParams

func (*StopOutputParams) GetRequestName added in v0.11.0 

func (o *StopOutputParams) GetRequestName() string

Returns the associated request.

func (*StopOutputParams) WithOutputName added in v1.0.0 

func (o *StopOutputParams) WithOutputName(x string) *StopOutputParams

type StopOutputResponse 

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

Represents the response body for the StopOutput request.

type StopReplayBufferParams added in v0.9.0 

type StopReplayBufferParams struct{}

Represents the request body for the StopReplayBuffer request.

func (*StopReplayBufferParams) GetRequestName added in v0.9.0 

func (o *StopReplayBufferParams) GetRequestName() string

Returns the associated request.

type StopReplayBufferResponse added in v0.9.0 

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

Represents the response body for the StopReplayBuffer request.

type StopVirtualCamParams added in v0.9.0 

type StopVirtualCamParams struct{}

Represents the request body for the StopVirtualCam request.

func (*StopVirtualCamParams) GetRequestName added in v0.9.0 

func (o *StopVirtualCamParams) GetRequestName() string

Returns the associated request.

type StopVirtualCamResponse added in v0.9.0 

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

Represents the response body for the StopVirtualCam request.

type ToggleOutputParams added in v0.11.0 

type ToggleOutputParams struct {
	// Output name
	OutputName *string `json:"outputName,omitempty"`
}

Represents the request body for the ToggleOutput request.

func NewToggleOutputParams added in v1.0.0 

func NewToggleOutputParams() *ToggleOutputParams

func (*ToggleOutputParams) GetRequestName added in v0.11.0 

func (o *ToggleOutputParams) GetRequestName() string

Returns the associated request.

func (*ToggleOutputParams) WithOutputName added in v1.0.0 

func (o *ToggleOutputParams) WithOutputName(x string) *ToggleOutputParams

type ToggleOutputResponse added in v0.11.0 

type ToggleOutputResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the ToggleOutput request.

type ToggleReplayBufferParams added in v0.9.0 

type ToggleReplayBufferParams struct{}

Represents the request body for the ToggleReplayBuffer request.

func (*ToggleReplayBufferParams) GetRequestName added in v0.9.0 

func (o *ToggleReplayBufferParams) GetRequestName() string

Returns the associated request.

type ToggleReplayBufferResponse added in v0.9.0 

type ToggleReplayBufferResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the ToggleReplayBuffer request.

type ToggleVirtualCamParams added in v0.9.0 

type ToggleVirtualCamParams struct{}

Represents the request body for the ToggleVirtualCam request.

func (*ToggleVirtualCamParams) GetRequestName added in v0.9.0 

func (o *ToggleVirtualCamParams) GetRequestName() string

Returns the associated request.

type ToggleVirtualCamResponse added in v0.9.0 

type ToggleVirtualCamResponse struct {

	// Whether the output is active
	OutputActive bool `json:"outputActive,omitempty"`
	// contains filtered or unexported fields
}

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