Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateScene(params *CreateSceneParams) (*CreateSceneResponse, error)
- func (c *Client) GetCurrentPreviewScene(paramss ...*GetCurrentPreviewSceneParams) (*GetCurrentPreviewSceneResponse, error)
- func (c *Client) GetCurrentProgramScene(paramss ...*GetCurrentProgramSceneParams) (*GetCurrentProgramSceneResponse, error)
- func (c *Client) GetGroupList(paramss ...*GetGroupListParams) (*GetGroupListResponse, error)
- func (c *Client) GetSceneList(paramss ...*GetSceneListParams) (*GetSceneListResponse, error)
- func (c *Client) GetSceneSceneTransitionOverride(paramss ...*GetSceneSceneTransitionOverrideParams) (*GetSceneSceneTransitionOverrideResponse, error)
- func (c *Client) RemoveScene(paramss ...*RemoveSceneParams) (*RemoveSceneResponse, error)
- func (c *Client) SetCurrentPreviewScene(paramss ...*SetCurrentPreviewSceneParams) (*SetCurrentPreviewSceneResponse, error)
- func (c *Client) SetCurrentProgramScene(paramss ...*SetCurrentProgramSceneParams) (*SetCurrentProgramSceneResponse, error)
- func (c *Client) SetSceneName(params *SetSceneNameParams) (*SetSceneNameResponse, error)
- func (c *Client) SetSceneSceneTransitionOverride(paramss ...*SetSceneSceneTransitionOverrideParams) (*SetSceneSceneTransitionOverrideResponse, error)
- type CreateSceneParams
- type CreateSceneResponse
- type GetCurrentPreviewSceneParams
- type GetCurrentPreviewSceneResponse
- type GetCurrentProgramSceneParams
- type GetCurrentProgramSceneResponse
- type GetGroupListParams
- type GetGroupListResponse
- type GetSceneListParams
- type GetSceneListResponse
- type GetSceneSceneTransitionOverrideParams
- type GetSceneSceneTransitionOverrideResponse
- type RemoveSceneParams
- type RemoveSceneResponse
- type SetCurrentPreviewSceneParams
- type SetCurrentPreviewSceneResponse
- type SetCurrentProgramSceneParams
- type SetCurrentProgramSceneResponse
- type SetSceneNameParams
- type SetSceneNameResponse
- type SetSceneSceneTransitionOverrideParams
- func (o *SetSceneSceneTransitionOverrideParams) GetRequestName() string
- func (o *SetSceneSceneTransitionOverrideParams) WithSceneName(x string) *SetSceneSceneTransitionOverrideParams
- func (o *SetSceneSceneTransitionOverrideParams) WithSceneUuid(x string) *SetSceneSceneTransitionOverrideParams
- func (o *SetSceneSceneTransitionOverrideParams) WithTransitionDuration(x float64) *SetSceneSceneTransitionOverrideParams
- func (o *SetSceneSceneTransitionOverrideParams) WithTransitionName(x string) *SetSceneSceneTransitionOverrideParams
- type SetSceneSceneTransitionOverrideResponse
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 'scenes' requests.
func (*Client) CreateScene ¶
func (c *Client) CreateScene(params *CreateSceneParams) (*CreateSceneResponse, error)
Creates a new scene in OBS.
func (*Client) GetCurrentPreviewScene ¶
func (c *Client) GetCurrentPreviewScene( paramss ...*GetCurrentPreviewSceneParams, ) (*GetCurrentPreviewSceneResponse, error)
Gets the current preview scene.
Only available when studio mode is enabled.
Note: This request is slated to have the `currentPreview`-prefixed fields removed from in an upcoming RPC version.
func (*Client) GetCurrentProgramScene ¶
func (c *Client) GetCurrentProgramScene( paramss ...*GetCurrentProgramSceneParams, ) (*GetCurrentProgramSceneResponse, error)
Gets the current program scene.
Note: This request is slated to have the `currentProgram`-prefixed fields removed from in an upcoming RPC version.
func (*Client) GetGroupList ¶
func (c *Client) GetGroupList(paramss ...*GetGroupListParams) (*GetGroupListResponse, error)
Gets an array of all groups in OBS.
Groups in OBS are actually scenes, but renamed and modified. In obs-websocket, we treat them as scenes where we can.
func (*Client) GetSceneList ¶
func (c *Client) GetSceneList(paramss ...*GetSceneListParams) (*GetSceneListResponse, error)
Gets an array of all scenes in OBS.
func (*Client) GetSceneSceneTransitionOverride ¶
func (c *Client) GetSceneSceneTransitionOverride( paramss ...*GetSceneSceneTransitionOverrideParams, ) (*GetSceneSceneTransitionOverrideResponse, error)
Gets the scene transition overridden for a scene.
Note: A transition UUID response field is not currently able to be implemented as of 2024-1-18.
func (*Client) RemoveScene ¶
func (c *Client) RemoveScene(paramss ...*RemoveSceneParams) (*RemoveSceneResponse, error)
Removes a scene from OBS.
func (*Client) SetCurrentPreviewScene ¶
func (c *Client) SetCurrentPreviewScene( paramss ...*SetCurrentPreviewSceneParams, ) (*SetCurrentPreviewSceneResponse, error)
Sets the current preview scene.
Only available when studio mode is enabled.
func (*Client) SetCurrentProgramScene ¶
func (c *Client) SetCurrentProgramScene( paramss ...*SetCurrentProgramSceneParams, ) (*SetCurrentProgramSceneResponse, error)
Sets the current program scene.
func (*Client) SetSceneName ¶
func (c *Client) SetSceneName(params *SetSceneNameParams) (*SetSceneNameResponse, error)
Sets the name of a scene (rename).
func (*Client) SetSceneSceneTransitionOverride ¶
func (c *Client) SetSceneSceneTransitionOverride( paramss ...*SetSceneSceneTransitionOverrideParams, ) (*SetSceneSceneTransitionOverrideResponse, error)
Sets the scene transition overridden for a scene.
type CreateSceneParams ¶
type CreateSceneParams struct {
// Name for the new scene
SceneName *string `json:"sceneName,omitempty"`
}
Represents the request body for the CreateScene request.
func NewCreateSceneParams ¶
func NewCreateSceneParams() *CreateSceneParams
func (*CreateSceneParams) GetRequestName ¶
func (o *CreateSceneParams) GetRequestName() string
Returns the associated request.
func (*CreateSceneParams) WithSceneName ¶
func (o *CreateSceneParams) WithSceneName(x string) *CreateSceneParams
type CreateSceneResponse ¶
type CreateSceneResponse struct {
// UUID of the created scene
SceneUuid string `json:"sceneUuid,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the CreateScene request.
type GetCurrentPreviewSceneParams ¶
type GetCurrentPreviewSceneParams struct{}
Represents the request body for the GetCurrentPreviewScene request.
func (*GetCurrentPreviewSceneParams) GetRequestName ¶
func (o *GetCurrentPreviewSceneParams) GetRequestName() string
Returns the associated request.
type GetCurrentPreviewSceneResponse ¶
type GetCurrentPreviewSceneResponse struct {
// Current preview scene name
CurrentPreviewSceneName string `json:"currentPreviewSceneName,omitempty"`
// Current preview scene UUID
CurrentPreviewSceneUuid string `json:"currentPreviewSceneUuid,omitempty"`
// Current preview scene name
SceneName string `json:"sceneName,omitempty"`
// Current preview scene UUID
SceneUuid string `json:"sceneUuid,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetCurrentPreviewScene request.
type GetCurrentProgramSceneParams ¶
type GetCurrentProgramSceneParams struct{}
Represents the request body for the GetCurrentProgramScene request.
func (*GetCurrentProgramSceneParams) GetRequestName ¶
func (o *GetCurrentProgramSceneParams) GetRequestName() string
Returns the associated request.
type GetCurrentProgramSceneResponse ¶
type GetCurrentProgramSceneResponse struct {
// Current program scene name (Deprecated)
CurrentProgramSceneName string `json:"currentProgramSceneName,omitempty"`
// Current program scene UUID (Deprecated)
CurrentProgramSceneUuid string `json:"currentProgramSceneUuid,omitempty"`
// Current program scene name
SceneName string `json:"sceneName,omitempty"`
// Current program scene UUID
SceneUuid string `json:"sceneUuid,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetCurrentProgramScene request.
type GetGroupListParams ¶
type GetGroupListParams struct{}
Represents the request body for the GetGroupList request.
func (*GetGroupListParams) GetRequestName ¶
func (o *GetGroupListParams) GetRequestName() string
Returns the associated request.
type GetGroupListResponse ¶
type GetGroupListResponse struct {
// Array of group names
Groups []string `json:"groups,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetGroupList request.
type GetSceneListParams ¶
type GetSceneListParams struct{}
Represents the request body for the GetSceneList request.
func (*GetSceneListParams) GetRequestName ¶
func (o *GetSceneListParams) GetRequestName() string
Returns the associated request.
type GetSceneListResponse ¶
type GetSceneListResponse struct {
// Current preview scene name. `null` if not in studio mode
CurrentPreviewSceneName string `json:"currentPreviewSceneName,omitempty"`
// Current preview scene UUID. `null` if not in studio mode
CurrentPreviewSceneUuid string `json:"currentPreviewSceneUuid,omitempty"`
// Current program scene name. Can be `null` if internal state desync
CurrentProgramSceneName string `json:"currentProgramSceneName,omitempty"`
// Current program scene UUID. Can be `null` if internal state desync
CurrentProgramSceneUuid string `json:"currentProgramSceneUuid,omitempty"`
// Array of scenes
Scenes []*typedefs.Scene `json:"scenes,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneList request.
type GetSceneSceneTransitionOverrideParams ¶
type GetSceneSceneTransitionOverrideParams struct {
// Name of the scene
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneSceneTransitionOverride request.
func NewGetSceneSceneTransitionOverrideParams ¶
func NewGetSceneSceneTransitionOverrideParams() *GetSceneSceneTransitionOverrideParams
func (*GetSceneSceneTransitionOverrideParams) GetRequestName ¶
func (o *GetSceneSceneTransitionOverrideParams) GetRequestName() string
Returns the associated request.
func (*GetSceneSceneTransitionOverrideParams) WithSceneName ¶
func (o *GetSceneSceneTransitionOverrideParams) WithSceneName(x string) *GetSceneSceneTransitionOverrideParams
func (*GetSceneSceneTransitionOverrideParams) WithSceneUuid ¶
func (o *GetSceneSceneTransitionOverrideParams) WithSceneUuid(x string) *GetSceneSceneTransitionOverrideParams
type GetSceneSceneTransitionOverrideResponse ¶
type GetSceneSceneTransitionOverrideResponse struct {
// Duration of the overridden scene transition, else `null`
TransitionDuration float64 `json:"transitionDuration,omitempty"`
// Name of the overridden scene transition, else `null`
TransitionName string `json:"transitionName,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneSceneTransitionOverride request.
type RemoveSceneParams ¶
type RemoveSceneParams struct {
// Name of the scene to remove
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene to remove
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the RemoveScene request.
func NewRemoveSceneParams ¶
func NewRemoveSceneParams() *RemoveSceneParams
func (*RemoveSceneParams) GetRequestName ¶
func (o *RemoveSceneParams) GetRequestName() string
Returns the associated request.
func (*RemoveSceneParams) WithSceneName ¶
func (o *RemoveSceneParams) WithSceneName(x string) *RemoveSceneParams
func (*RemoveSceneParams) WithSceneUuid ¶
func (o *RemoveSceneParams) WithSceneUuid(x string) *RemoveSceneParams
type RemoveSceneResponse ¶
type RemoveSceneResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the RemoveScene request.
type SetCurrentPreviewSceneParams ¶
type SetCurrentPreviewSceneParams struct {
// Scene name to set as the current preview scene
SceneName *string `json:"sceneName,omitempty"`
// Scene UUID to set as the current preview scene
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetCurrentPreviewScene request.
func NewSetCurrentPreviewSceneParams ¶
func NewSetCurrentPreviewSceneParams() *SetCurrentPreviewSceneParams
func (*SetCurrentPreviewSceneParams) GetRequestName ¶
func (o *SetCurrentPreviewSceneParams) GetRequestName() string
Returns the associated request.
func (*SetCurrentPreviewSceneParams) WithSceneName ¶
func (o *SetCurrentPreviewSceneParams) WithSceneName(x string) *SetCurrentPreviewSceneParams
func (*SetCurrentPreviewSceneParams) WithSceneUuid ¶
func (o *SetCurrentPreviewSceneParams) WithSceneUuid(x string) *SetCurrentPreviewSceneParams
type SetCurrentPreviewSceneResponse ¶
type SetCurrentPreviewSceneResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetCurrentPreviewScene request.
type SetCurrentProgramSceneParams ¶
type SetCurrentProgramSceneParams struct {
// Scene name to set as the current program scene
SceneName *string `json:"sceneName,omitempty"`
// Scene UUID to set as the current program scene
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetCurrentProgramScene request.
func NewSetCurrentProgramSceneParams ¶
func NewSetCurrentProgramSceneParams() *SetCurrentProgramSceneParams
func (*SetCurrentProgramSceneParams) GetRequestName ¶
func (o *SetCurrentProgramSceneParams) GetRequestName() string
Returns the associated request.
func (*SetCurrentProgramSceneParams) WithSceneName ¶
func (o *SetCurrentProgramSceneParams) WithSceneName(x string) *SetCurrentProgramSceneParams
func (*SetCurrentProgramSceneParams) WithSceneUuid ¶
func (o *SetCurrentProgramSceneParams) WithSceneUuid(x string) *SetCurrentProgramSceneParams
type SetCurrentProgramSceneResponse ¶
type SetCurrentProgramSceneResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetCurrentProgramScene request.
type SetSceneNameParams ¶
type SetSceneNameParams struct {
// New name for the scene
NewSceneName *string `json:"newSceneName,omitempty"`
// Name of the scene to be renamed
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene to be renamed
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneName request.
func NewSetSceneNameParams ¶
func NewSetSceneNameParams() *SetSceneNameParams
func (*SetSceneNameParams) GetRequestName ¶
func (o *SetSceneNameParams) GetRequestName() string
Returns the associated request.
func (*SetSceneNameParams) WithNewSceneName ¶
func (o *SetSceneNameParams) WithNewSceneName(x string) *SetSceneNameParams
func (*SetSceneNameParams) WithSceneName ¶
func (o *SetSceneNameParams) WithSceneName(x string) *SetSceneNameParams
func (*SetSceneNameParams) WithSceneUuid ¶
func (o *SetSceneNameParams) WithSceneUuid(x string) *SetSceneNameParams
type SetSceneNameResponse ¶
type SetSceneNameResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneName request.
type SetSceneSceneTransitionOverrideParams ¶
type SetSceneSceneTransitionOverrideParams struct {
// Name of the scene
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene
SceneUuid *string `json:"sceneUuid,omitempty"`
// Duration to use for any overridden transition. Specify `null` to remove
TransitionDuration *float64 `json:"transitionDuration,omitempty"`
// Name of the scene transition to use as override. Specify `null` to remove
TransitionName *string `json:"transitionName,omitempty"`
}
Represents the request body for the SetSceneSceneTransitionOverride request.
func NewSetSceneSceneTransitionOverrideParams ¶
func NewSetSceneSceneTransitionOverrideParams() *SetSceneSceneTransitionOverrideParams
func (*SetSceneSceneTransitionOverrideParams) GetRequestName ¶
func (o *SetSceneSceneTransitionOverrideParams) GetRequestName() string
Returns the associated request.
func (*SetSceneSceneTransitionOverrideParams) WithSceneName ¶
func (o *SetSceneSceneTransitionOverrideParams) WithSceneName(x string) *SetSceneSceneTransitionOverrideParams
func (*SetSceneSceneTransitionOverrideParams) WithSceneUuid ¶
func (o *SetSceneSceneTransitionOverrideParams) WithSceneUuid(x string) *SetSceneSceneTransitionOverrideParams
func (*SetSceneSceneTransitionOverrideParams) WithTransitionDuration ¶
func (o *SetSceneSceneTransitionOverrideParams) WithTransitionDuration( x float64, ) *SetSceneSceneTransitionOverrideParams
func (*SetSceneSceneTransitionOverrideParams) WithTransitionName ¶
func (o *SetSceneSceneTransitionOverrideParams) WithTransitionName(x string) *SetSceneSceneTransitionOverrideParams
type SetSceneSceneTransitionOverrideResponse ¶
type SetSceneSceneTransitionOverrideResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneSceneTransitionOverride request.
Source Files
¶
- xx_generated.createscene.go
- xx_generated.getcurrentpreviewscene.go
- xx_generated.getcurrentprogramscene.go
- xx_generated.getgrouplist.go
- xx_generated.getscenelist.go
- xx_generated.getscenescenetransitionoverride.go
- xx_generated.removescene.go
- xx_generated.setcurrentpreviewscene.go
- xx_generated.setcurrentprogramscene.go
- xx_generated.setscenename.go
- xx_generated.setscenescenetransitionoverride.go
- zz_generated.client.go