virtualcam

Documentation

Index

• type Client
  • func (c *Client) GetVirtualCamStatus(paramss ...*GetVirtualCamStatusParams) (*GetVirtualCamStatusResponse, error)
  • func (c *Client) StartStopVirtualCam(paramss ...*StartStopVirtualCamParams) (*StartStopVirtualCamResponse, error)
  • func (c *Client) StartVirtualCam(paramss ...*StartVirtualCamParams) (*StartVirtualCamResponse, error)
  • func (c *Client) StopVirtualCam(paramss ...*StopVirtualCamParams) (*StopVirtualCamResponse, error)
• type GetVirtualCamStatusParams
  • func (o *GetVirtualCamStatusParams) GetSelfName() string
• type GetVirtualCamStatusResponse
• type StartStopVirtualCamParams
  • func (o *StartStopVirtualCamParams) GetSelfName() string
• type StartStopVirtualCamResponse
• type StartVirtualCamParams
  • func (o *StartVirtualCamParams) GetSelfName() string
• type StartVirtualCamResponse
• type StopVirtualCamParams
  • func (o *StopVirtualCamParams) GetSelfName() string
• type StopVirtualCamResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'virtual cam' requests.

func (*Client) GetVirtualCamStatus

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

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

func (*Client) StartStopVirtualCam

func (c *Client) StartStopVirtualCam(paramss ...*StartStopVirtualCamParams) (*StartStopVirtualCamResponse, error)

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

func (*Client) StartVirtualCam

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

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

func (*Client) StopVirtualCam

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

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

type GetVirtualCamStatusParams

type GetVirtualCamStatusParams struct {
	requests.ParamsBasic
}

GetVirtualCamStatusParams represents the params body for the "GetVirtualCamStatus" request. Get current virtual cam status. Since 4.9.1.

func (*GetVirtualCamStatusParams) GetSelfName

func (o *GetVirtualCamStatusParams) GetSelfName() string

GetSelfName just returns "GetVirtualCamStatus".

type GetVirtualCamStatusResponse

type GetVirtualCamStatusResponse struct {
	requests.ResponseBasic

	// Current virtual camera status.
	IsVirtualCam bool `json:"isVirtualCam"`

	// Time elapsed since virtual cam started (only present if virtual cam currently active).
	VirtualCamTimecode string `json:"virtualCamTimecode,omitempty"`
}

GetVirtualCamStatusResponse represents the response body for the "GetVirtualCamStatus" request. Get current virtual cam status. Since v4.9.1.

type StartStopVirtualCamParams

type StartStopVirtualCamParams struct {
	requests.ParamsBasic
}

StartStopVirtualCamParams represents the params body for the "StartStopVirtualCam" request. Toggle virtual cam on or off (depending on the current virtual cam state). Since 4.9.1.

func (*StartStopVirtualCamParams) GetSelfName

func (o *StartStopVirtualCamParams) GetSelfName() string

GetSelfName just returns "StartStopVirtualCam".

type StartStopVirtualCamResponse

type StartStopVirtualCamResponse struct {
	requests.ResponseBasic
}

StartStopVirtualCamResponse represents the response body for the "StartStopVirtualCam" request. Toggle virtual cam on or off (depending on the current virtual cam state). Since v4.9.1.

type StartVirtualCamParams

type StartVirtualCamParams struct {
	requests.ParamsBasic
}

StartVirtualCamParams represents the params body for the "StartVirtualCam" request. Start virtual cam. Will return an `error` if virtual cam is already active. Since 4.9.1.

func (*StartVirtualCamParams) GetSelfName

func (o *StartVirtualCamParams) GetSelfName() string

GetSelfName just returns "StartVirtualCam".

type StartVirtualCamResponse

type StartVirtualCamResponse struct {
	requests.ResponseBasic
}

StartVirtualCamResponse represents the response body for the "StartVirtualCam" request. Start virtual cam. Will return an `error` if virtual cam is already active. Since v4.9.1.

type StopVirtualCamParams

type StopVirtualCamParams struct {
	requests.ParamsBasic
}

StopVirtualCamParams represents the params body for the "StopVirtualCam" request. Stop virtual cam. Will return an `error` if virtual cam is not active. Since 4.9.1.

func (*StopVirtualCamParams) GetSelfName

func (o *StopVirtualCamParams) GetSelfName() string

GetSelfName just returns "StopVirtualCam".

type StopVirtualCamResponse

type StopVirtualCamResponse struct {
	requests.ResponseBasic
}

StopVirtualCamResponse represents the response body for the "StopVirtualCam" request. Stop virtual cam. Will return an `error` if virtual cam is not active. Since v4.9.1.