Documentation
¶
Index ¶
- type Client
- func (c *Client) GetLastReplayBufferReplay(paramss ...*GetLastReplayBufferReplayParams) (*GetLastReplayBufferReplayResponse, error)
- func (c *Client) GetOutputList(paramss ...*GetOutputListParams) (*GetOutputListResponse, error)
- func (c *Client) GetOutputSettings(params *GetOutputSettingsParams) (*GetOutputSettingsResponse, error)
- func (c *Client) GetOutputStatus(params *GetOutputStatusParams) (*GetOutputStatusResponse, error)
- func (c *Client) GetReplayBufferStatus(paramss ...*GetReplayBufferStatusParams) (*GetReplayBufferStatusResponse, error)
- func (c *Client) GetVirtualCamStatus(paramss ...*GetVirtualCamStatusParams) (*GetVirtualCamStatusResponse, error)
- func (c *Client) SaveReplayBuffer(paramss ...*SaveReplayBufferParams) (*SaveReplayBufferResponse, error)
- func (c *Client) SetOutputSettings(params *SetOutputSettingsParams) (*SetOutputSettingsResponse, error)
- func (c *Client) StartOutput(params *StartOutputParams) (*StartOutputResponse, error)
- func (c *Client) StartReplayBuffer(paramss ...*StartReplayBufferParams) (*StartReplayBufferResponse, error)
- func (c *Client) StartVirtualCam(paramss ...*StartVirtualCamParams) (*StartVirtualCamResponse, error)
- func (c *Client) StopOutput(params *StopOutputParams) (*StopOutputResponse, error)
- func (c *Client) StopReplayBuffer(paramss ...*StopReplayBufferParams) (*StopReplayBufferResponse, error)
- func (c *Client) StopVirtualCam(paramss ...*StopVirtualCamParams) (*StopVirtualCamResponse, error)
- func (c *Client) ToggleOutput(params *ToggleOutputParams) (*ToggleOutputResponse, error)
- func (c *Client) ToggleReplayBuffer(paramss ...*ToggleReplayBufferParams) (*ToggleReplayBufferResponse, error)
- func (c *Client) ToggleVirtualCam(paramss ...*ToggleVirtualCamParams) (*ToggleVirtualCamResponse, error)
- type GetLastReplayBufferReplayParams
- type GetLastReplayBufferReplayResponse
- type GetOutputListParams
- type GetOutputListResponse
- type GetOutputSettingsParams
- type GetOutputSettingsResponse
- type GetOutputStatusParams
- type GetOutputStatusResponse
- type GetReplayBufferStatusParams
- type GetReplayBufferStatusResponse
- type GetVirtualCamStatusParams
- type GetVirtualCamStatusResponse
- type SaveReplayBufferParams
- type SaveReplayBufferResponse
- type SetOutputSettingsParams
- type SetOutputSettingsResponse
- type StartOutputParams
- type StartOutputResponse
- type StartReplayBufferParams
- type StartReplayBufferResponse
- type StartVirtualCamParams
- type StartVirtualCamResponse
- type StopOutputParams
- type StopOutputResponse
- type StopReplayBufferParams
- type StopReplayBufferResponse
- type StopVirtualCamParams
- type StopVirtualCamResponse
- type ToggleOutputParams
- type ToggleOutputResponse
- type ToggleReplayBufferParams
- type ToggleReplayBufferResponse
- type ToggleVirtualCamParams
- type ToggleVirtualCamResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client represents a client for 'outputs' requests.
func (*Client) GetLastReplayBufferReplay ¶
func (c *Client) GetLastReplayBufferReplay( paramss ...*GetLastReplayBufferReplayParams, ) (*GetLastReplayBufferReplayResponse, error)
Gets the filename of the last replay buffer save file.
func (*Client) GetOutputList ¶
func (c *Client) GetOutputList(paramss ...*GetOutputListParams) (*GetOutputListResponse, error)
Gets the list of available outputs.
func (*Client) GetOutputSettings ¶
func (c *Client) GetOutputSettings(params *GetOutputSettingsParams) (*GetOutputSettingsResponse, error)
Gets the settings of an output.
func (*Client) GetOutputStatus ¶
func (c *Client) GetOutputStatus(params *GetOutputStatusParams) (*GetOutputStatusResponse, error)
Gets the status of an output.
func (*Client) GetReplayBufferStatus ¶
func (c *Client) GetReplayBufferStatus( paramss ...*GetReplayBufferStatusParams, ) (*GetReplayBufferStatusResponse, error)
Gets the status of the replay buffer output.
func (*Client) GetVirtualCamStatus ¶
func (c *Client) GetVirtualCamStatus(paramss ...*GetVirtualCamStatusParams) (*GetVirtualCamStatusResponse, error)
Gets the status of the virtualcam output.
func (*Client) SaveReplayBuffer ¶
func (c *Client) SaveReplayBuffer(paramss ...*SaveReplayBufferParams) (*SaveReplayBufferResponse, error)
Saves the contents of the replay buffer output.
func (*Client) SetOutputSettings ¶
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 ¶
func (c *Client) StartReplayBuffer(paramss ...*StartReplayBufferParams) (*StartReplayBufferResponse, error)
Starts the replay buffer output.
func (*Client) StartVirtualCam ¶
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 ¶
func (c *Client) StopReplayBuffer(paramss ...*StopReplayBufferParams) (*StopReplayBufferResponse, error)
Stops the replay buffer output.
func (*Client) StopVirtualCam ¶
func (c *Client) StopVirtualCam(paramss ...*StopVirtualCamParams) (*StopVirtualCamResponse, error)
Stops the virtualcam output.
func (*Client) ToggleOutput ¶
func (c *Client) ToggleOutput(params *ToggleOutputParams) (*ToggleOutputResponse, error)
Toggles the status of an output.
func (*Client) ToggleReplayBuffer ¶
func (c *Client) ToggleReplayBuffer(paramss ...*ToggleReplayBufferParams) (*ToggleReplayBufferResponse, error)
Toggles the state of the replay buffer output.
func (*Client) ToggleVirtualCam ¶
func (c *Client) ToggleVirtualCam(paramss ...*ToggleVirtualCamParams) (*ToggleVirtualCamResponse, error)
Toggles the state of the virtualcam output.
type GetLastReplayBufferReplayParams ¶
type GetLastReplayBufferReplayParams struct{}
Represents the request body for the GetLastReplayBufferReplay request.
func (*GetLastReplayBufferReplayParams) GetRequestName ¶
func (o *GetLastReplayBufferReplayParams) GetRequestName() string
Returns the associated request.
type GetLastReplayBufferReplayResponse ¶
type GetLastReplayBufferReplayResponse struct {
// File path
SavedReplayPath string `json:"savedReplayPath,omitempty"`
}
Represents the response body for the GetLastReplayBufferReplay request.
type GetOutputListParams ¶
type GetOutputListParams struct{}
Represents the request body for the GetOutputList request.
func (*GetOutputListParams) GetRequestName ¶
func (o *GetOutputListParams) GetRequestName() string
Returns the associated request.
type GetOutputListResponse ¶
type GetOutputListResponse struct {
// Array of outputs
Outputs []interface{} `json:"outputs,omitempty"`
}
Represents the response body for the GetOutputList request.
type GetOutputSettingsParams ¶
type GetOutputSettingsParams struct {
// Output name
OutputName string `json:"outputName,omitempty"`
}
Represents the request body for the GetOutputSettings request.
func (*GetOutputSettingsParams) GetRequestName ¶
func (o *GetOutputSettingsParams) GetRequestName() string
Returns the associated request.
type GetOutputSettingsResponse ¶
type GetOutputSettingsResponse struct {
// Output settings
OutputSettings interface{} `json:"outputSettings,omitempty"`
}
Represents the response body for the GetOutputSettings request.
type GetOutputStatusParams ¶
type GetOutputStatusParams struct {
// Output name
OutputName string `json:"outputName,omitempty"`
}
Represents the request body for the GetOutputStatus request.
func (*GetOutputStatusParams) GetRequestName ¶
func (o *GetOutputStatusParams) GetRequestName() string
Returns the associated request.
type GetOutputStatusResponse ¶
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"`
}
Represents the response body for the GetOutputStatus request.
type GetReplayBufferStatusParams ¶
type GetReplayBufferStatusParams struct{}
Represents the request body for the GetReplayBufferStatus request.
func (*GetReplayBufferStatusParams) GetRequestName ¶
func (o *GetReplayBufferStatusParams) GetRequestName() string
Returns the associated request.
type GetReplayBufferStatusResponse ¶
type GetReplayBufferStatusResponse struct {
// Whether the output is active
OutputActive bool `json:"outputActive,omitempty"`
}
Represents the response body for the GetReplayBufferStatus request.
type GetVirtualCamStatusParams ¶
type GetVirtualCamStatusParams struct{}
Represents the request body for the GetVirtualCamStatus request.
func (*GetVirtualCamStatusParams) GetRequestName ¶
func (o *GetVirtualCamStatusParams) GetRequestName() string
Returns the associated request.
type GetVirtualCamStatusResponse ¶
type GetVirtualCamStatusResponse struct {
// Whether the output is active
OutputActive bool `json:"outputActive,omitempty"`
}
Represents the response body for the GetVirtualCamStatus request.
type SaveReplayBufferParams ¶
type SaveReplayBufferParams struct{}
Represents the request body for the SaveReplayBuffer request.
func (*SaveReplayBufferParams) GetRequestName ¶
func (o *SaveReplayBufferParams) GetRequestName() string
Returns the associated request.
type SaveReplayBufferResponse ¶
type SaveReplayBufferResponse struct{}
Represents the response body for the SaveReplayBuffer request.
type SetOutputSettingsParams ¶
type SetOutputSettingsParams struct {
// Output name
OutputName string `json:"outputName,omitempty"`
// Output settings
OutputSettings interface{} `json:"outputSettings,omitempty"`
}
Represents the request body for the SetOutputSettings request.
func (*SetOutputSettingsParams) GetRequestName ¶
func (o *SetOutputSettingsParams) GetRequestName() string
Returns the associated request.
type SetOutputSettingsResponse ¶
type SetOutputSettingsResponse struct{}
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 (*StartOutputParams) GetRequestName ¶
func (o *StartOutputParams) GetRequestName() string
Returns the associated request.
type StartOutputResponse ¶
type StartOutputResponse struct{}
Represents the response body for the StartOutput request.
type StartReplayBufferParams ¶
type StartReplayBufferParams struct{}
Represents the request body for the StartReplayBuffer request.
func (*StartReplayBufferParams) GetRequestName ¶
func (o *StartReplayBufferParams) GetRequestName() string
Returns the associated request.
type StartReplayBufferResponse ¶
type StartReplayBufferResponse struct{}
Represents the response body for the StartReplayBuffer request.
type StartVirtualCamParams ¶
type StartVirtualCamParams struct{}
Represents the request body for the StartVirtualCam request.
func (*StartVirtualCamParams) GetRequestName ¶
func (o *StartVirtualCamParams) GetRequestName() string
Returns the associated request.
type StartVirtualCamResponse ¶
type StartVirtualCamResponse struct{}
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 (*StopOutputParams) GetRequestName ¶
func (o *StopOutputParams) GetRequestName() string
Returns the associated request.
type StopOutputResponse ¶
type StopOutputResponse struct{}
Represents the response body for the StopOutput request.
type StopReplayBufferParams ¶
type StopReplayBufferParams struct{}
Represents the request body for the StopReplayBuffer request.
func (*StopReplayBufferParams) GetRequestName ¶
func (o *StopReplayBufferParams) GetRequestName() string
Returns the associated request.
type StopReplayBufferResponse ¶
type StopReplayBufferResponse struct{}
Represents the response body for the StopReplayBuffer request.
type StopVirtualCamParams ¶
type StopVirtualCamParams struct{}
Represents the request body for the StopVirtualCam request.
func (*StopVirtualCamParams) GetRequestName ¶
func (o *StopVirtualCamParams) GetRequestName() string
Returns the associated request.
type StopVirtualCamResponse ¶
type StopVirtualCamResponse struct{}
Represents the response body for the StopVirtualCam request.
type ToggleOutputParams ¶
type ToggleOutputParams struct {
// Output name
OutputName string `json:"outputName,omitempty"`
}
Represents the request body for the ToggleOutput request.
func (*ToggleOutputParams) GetRequestName ¶
func (o *ToggleOutputParams) GetRequestName() string
Returns the associated request.
type ToggleOutputResponse ¶
type ToggleOutputResponse struct {
// Whether the output is active
OutputActive bool `json:"outputActive,omitempty"`
}
Represents the response body for the ToggleOutput request.
type ToggleReplayBufferParams ¶
type ToggleReplayBufferParams struct{}
Represents the request body for the ToggleReplayBuffer request.
func (*ToggleReplayBufferParams) GetRequestName ¶
func (o *ToggleReplayBufferParams) GetRequestName() string
Returns the associated request.
type ToggleReplayBufferResponse ¶
type ToggleReplayBufferResponse struct {
// Whether the output is active
OutputActive bool `json:"outputActive,omitempty"`
}
Represents the response body for the ToggleReplayBuffer request.
type ToggleVirtualCamParams ¶
type ToggleVirtualCamParams struct{}
Represents the request body for the ToggleVirtualCam request.
func (*ToggleVirtualCamParams) GetRequestName ¶
func (o *ToggleVirtualCamParams) GetRequestName() string
Returns the associated request.
type ToggleVirtualCamResponse ¶
type ToggleVirtualCamResponse struct {
// Whether the output is active
OutputActive bool `json:"outputActive,omitempty"`
}
Represents the response body for the ToggleVirtualCam request.
Source Files
¶
- xx_generated.getlastreplaybufferreplay.go
- xx_generated.getoutputlist.go
- xx_generated.getoutputsettings.go
- xx_generated.getoutputstatus.go
- xx_generated.getreplaybufferstatus.go
- xx_generated.getvirtualcamstatus.go
- xx_generated.savereplaybuffer.go
- xx_generated.setoutputsettings.go
- xx_generated.startoutput.go
- xx_generated.startreplaybuffer.go
- xx_generated.startvirtualcam.go
- xx_generated.stopoutput.go
- xx_generated.stopreplaybuffer.go
- xx_generated.stopvirtualcam.go
- xx_generated.toggleoutput.go
- xx_generated.togglereplaybuffer.go
- xx_generated.togglevirtualcam.go
- zz_generated.client.go