profiles

Documentation

Index

• type Client
  • func (c *Client) GetCurrentProfile(paramss ...*GetCurrentProfileParams) (*GetCurrentProfileResponse, error)
  • func (c *Client) ListProfiles(paramss ...*ListProfilesParams) (*ListProfilesResponse, error)
  • func (c *Client) SetCurrentProfile(params *SetCurrentProfileParams) (*SetCurrentProfileResponse, error)
• type GetCurrentProfileParams
  • func (o *GetCurrentProfileParams) GetSelfName() string
• type GetCurrentProfileResponse
• type ListProfilesParams
  • func (o *ListProfilesParams) GetSelfName() string
• type ListProfilesResponse
• type Profile
• type SetCurrentProfileParams
  • func (o *SetCurrentProfileParams) GetSelfName() string
• type SetCurrentProfileResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'profiles' requests.

func (*Client) GetCurrentProfile

func (c *Client) GetCurrentProfile(paramss ...*GetCurrentProfileParams) (*GetCurrentProfileResponse, error)

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

func (*Client) ListProfiles

func (c *Client) ListProfiles(paramss ...*ListProfilesParams) (*ListProfilesResponse, error)

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

func (*Client) SetCurrentProfile

func (c *Client) SetCurrentProfile(params *SetCurrentProfileParams) (*SetCurrentProfileResponse, error)

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

type GetCurrentProfileParams

type GetCurrentProfileParams struct {
	requests.ParamsBasic
}

GetCurrentProfileParams represents the params body for the "GetCurrentProfile" request. Get the name of the current profile. Since 4.0.0.

func (*GetCurrentProfileParams) GetSelfName

func (o *GetCurrentProfileParams) GetSelfName() string

GetSelfName just returns "GetCurrentProfile".

type GetCurrentProfileResponse

type GetCurrentProfileResponse struct {
	requests.ResponseBasic

	// Name of the currently active profile.
	ProfileName string `json:"profile-name,omitempty"`
}

GetCurrentProfileResponse represents the response body for the "GetCurrentProfile" request. Get the name of the current profile. Since v4.0.0.

type ListProfilesParams

type ListProfilesParams struct {
	requests.ParamsBasic
}

ListProfilesParams represents the params body for the "ListProfiles" request. Get a list of available profiles. Since 4.0.0.

func (*ListProfilesParams) GetSelfName

func (o *ListProfilesParams) GetSelfName() string

GetSelfName just returns "ListProfiles".

type ListProfilesResponse

type ListProfilesResponse struct {
	requests.ResponseBasic

	Profiles []*Profile `json:"profiles,omitempty"`
}

ListProfilesResponse represents the response body for the "ListProfiles" request. Get a list of available profiles. Since v4.0.0.

type Profile

type Profile struct {
	// Filter name
	ProfileName string `json:"profile-name,omitempty"`
}

type SetCurrentProfileParams

type SetCurrentProfileParams struct {
	requests.ParamsBasic

	// Name of the desired profile.
	ProfileName string `json:"profile-name,omitempty"`
}

SetCurrentProfileParams represents the params body for the "SetCurrentProfile" request. Set the currently active profile. Since 4.0.0.

func (*SetCurrentProfileParams) GetSelfName

func (o *SetCurrentProfileParams) GetSelfName() string

GetSelfName just returns "SetCurrentProfile".

type SetCurrentProfileResponse

type SetCurrentProfileResponse struct {
	requests.ResponseBasic
}

SetCurrentProfileResponse represents the response body for the "SetCurrentProfile" request. Set the currently active profile. Since v4.0.0.