scenes

package
v1.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 22, 2024 License: Apache-2.0 Imports: 2 Imported by: 24

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

func NewClient added in v1.0.0 

func NewClient(c *api.Client) *Client

NewScenes returns a new 'scenes' client.

func (*Client) CreateScene added in v0.5.0 

func (c *Client) CreateScene(params *CreateSceneParams) (*CreateSceneResponse, error)

Creates a new scene in OBS.

func (*Client) GetCurrentPreviewScene added in v0.9.0 

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 added in v0.9.0 

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 added in v0.9.0 

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 added in v0.9.0 

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 added in v0.9.0 

func (c *Client) RemoveScene(paramss ...*RemoveSceneParams) (*RemoveSceneResponse, error)

Removes a scene from OBS.

func (*Client) SetCurrentPreviewScene added in v0.9.0 

func (c *Client) SetCurrentPreviewScene(
	paramss ...*SetCurrentPreviewSceneParams,
) (*SetCurrentPreviewSceneResponse, error)

Sets the current preview scene.

Only available when studio mode is enabled.

func (*Client) SetCurrentProgramScene added in v0.9.0 

func (c *Client) SetCurrentProgramScene(
	paramss ...*SetCurrentProgramSceneParams,
) (*SetCurrentProgramSceneResponse, error)

Sets the current program scene.

func (*Client) SetSceneName added in v0.9.0 

func (c *Client) SetSceneName(params *SetSceneNameParams) (*SetSceneNameResponse, error)

Sets the name of a scene (rename).

func (*Client) SetSceneSceneTransitionOverride added in v0.9.0 

func (c *Client) SetSceneSceneTransitionOverride(
	paramss ...*SetSceneSceneTransitionOverrideParams,
) (*SetSceneSceneTransitionOverrideResponse, error)

Sets the scene transition overridden for a scene.

type CreateSceneParams added in v0.5.0 

type CreateSceneParams struct {
	// Name for the new scene
	SceneName *string `json:"sceneName,omitempty"`
}

Represents the request body for the CreateScene request.

func NewCreateSceneParams added in v1.0.0 

func NewCreateSceneParams() *CreateSceneParams

func (*CreateSceneParams) GetRequestName added in v0.9.0 

func (o *CreateSceneParams) GetRequestName() string

Returns the associated request.

func (*CreateSceneParams) WithSceneName added in v1.0.0 

func (o *CreateSceneParams) WithSceneName(x string) *CreateSceneParams

type CreateSceneResponse added in v0.5.0 

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 added in v0.9.0 

type GetCurrentPreviewSceneParams struct{}

Represents the request body for the GetCurrentPreviewScene request.

func (*GetCurrentPreviewSceneParams) GetRequestName added in v0.9.0 

func (o *GetCurrentPreviewSceneParams) GetRequestName() string

Returns the associated request.

type GetCurrentPreviewSceneResponse added in v0.9.0 

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 added in v0.9.0 

type GetCurrentProgramSceneParams struct{}

Represents the request body for the GetCurrentProgramScene request.

func (*GetCurrentProgramSceneParams) GetRequestName added in v0.9.0 

func (o *GetCurrentProgramSceneParams) GetRequestName() string

Returns the associated request.

type GetCurrentProgramSceneResponse added in v0.9.0 

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 added in v0.9.0 

type GetGroupListParams struct{}

Represents the request body for the GetGroupList request.

func (*GetGroupListParams) GetRequestName added in v0.9.0 

func (o *GetGroupListParams) GetRequestName() string

Returns the associated request.

type GetGroupListResponse added in v0.9.0 

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 added in v0.9.0 

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 added in v0.9.0 

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 added in v1.0.0 

func NewGetSceneSceneTransitionOverrideParams() *GetSceneSceneTransitionOverrideParams

func (*GetSceneSceneTransitionOverrideParams) GetRequestName added in v0.9.0 

func (o *GetSceneSceneTransitionOverrideParams) GetRequestName() string

Returns the associated request.

func (*GetSceneSceneTransitionOverrideParams) WithSceneName added in v1.0.0 

func (o *GetSceneSceneTransitionOverrideParams) WithSceneName(x string) *GetSceneSceneTransitionOverrideParams

func (*GetSceneSceneTransitionOverrideParams) WithSceneUuid added in v1.2.0 

func (o *GetSceneSceneTransitionOverrideParams) WithSceneUuid(x string) *GetSceneSceneTransitionOverrideParams

type GetSceneSceneTransitionOverrideResponse added in v0.9.0 

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 added in v0.9.0 

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 added in v1.0.0 

func NewRemoveSceneParams() *RemoveSceneParams

func (*RemoveSceneParams) GetRequestName added in v0.9.0 

func (o *RemoveSceneParams) GetRequestName() string

Returns the associated request.

func (*RemoveSceneParams) WithSceneName added in v1.0.0 

func (o *RemoveSceneParams) WithSceneName(x string) *RemoveSceneParams

func (*RemoveSceneParams) WithSceneUuid added in v1.2.0 

func (o *RemoveSceneParams) WithSceneUuid(x string) *RemoveSceneParams

type RemoveSceneResponse added in v0.9.0 

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

Represents the response body for the RemoveScene request.

type SetCurrentPreviewSceneParams added in v0.9.0 

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 added in v1.0.0 

func NewSetCurrentPreviewSceneParams() *SetCurrentPreviewSceneParams

func (*SetCurrentPreviewSceneParams) GetRequestName added in v0.9.0 

func (o *SetCurrentPreviewSceneParams) GetRequestName() string

Returns the associated request.

func (*SetCurrentPreviewSceneParams) WithSceneName added in v1.0.0 

func (o *SetCurrentPreviewSceneParams) WithSceneName(x string) *SetCurrentPreviewSceneParams

func (*SetCurrentPreviewSceneParams) WithSceneUuid added in v1.2.0 

func (o *SetCurrentPreviewSceneParams) WithSceneUuid(x string) *SetCurrentPreviewSceneParams

type SetCurrentPreviewSceneResponse added in v0.9.0 

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

Represents the response body for the SetCurrentPreviewScene request.

type SetCurrentProgramSceneParams added in v0.9.0 

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 added in v1.0.0 

func NewSetCurrentProgramSceneParams() *SetCurrentProgramSceneParams

func (*SetCurrentProgramSceneParams) GetRequestName added in v0.9.0 

func (o *SetCurrentProgramSceneParams) GetRequestName() string

Returns the associated request.

func (*SetCurrentProgramSceneParams) WithSceneName added in v1.0.0 

func (o *SetCurrentProgramSceneParams) WithSceneName(x string) *SetCurrentProgramSceneParams

func (*SetCurrentProgramSceneParams) WithSceneUuid added in v1.2.0 

func (o *SetCurrentProgramSceneParams) WithSceneUuid(x string) *SetCurrentProgramSceneParams

type SetCurrentProgramSceneResponse added in v0.9.0 

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

Represents the response body for the SetCurrentProgramScene request.

type SetSceneNameParams added in v0.9.0 

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 added in v1.0.0 

func NewSetSceneNameParams() *SetSceneNameParams

func (*SetSceneNameParams) GetRequestName added in v0.9.0 

func (o *SetSceneNameParams) GetRequestName() string

Returns the associated request.

func (*SetSceneNameParams) WithNewSceneName added in v1.0.0 

func (o *SetSceneNameParams) WithNewSceneName(x string) *SetSceneNameParams

func (*SetSceneNameParams) WithSceneName added in v1.0.0 

func (o *SetSceneNameParams) WithSceneName(x string) *SetSceneNameParams

func (*SetSceneNameParams) WithSceneUuid added in v1.2.0 

func (o *SetSceneNameParams) WithSceneUuid(x string) *SetSceneNameParams

type SetSceneNameResponse added in v0.9.0 

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

Represents the response body for the SetSceneName request.

type SetSceneSceneTransitionOverrideParams added in v0.9.0 

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 added in v1.0.0 

func NewSetSceneSceneTransitionOverrideParams() *SetSceneSceneTransitionOverrideParams

func (*SetSceneSceneTransitionOverrideParams) GetRequestName added in v0.9.0 

func (o *SetSceneSceneTransitionOverrideParams) GetRequestName() string

Returns the associated request.

func (*SetSceneSceneTransitionOverrideParams) WithSceneName added in v1.0.0 

func (o *SetSceneSceneTransitionOverrideParams) WithSceneName(x string) *SetSceneSceneTransitionOverrideParams

func (*SetSceneSceneTransitionOverrideParams) WithSceneUuid added in v1.2.0 

func (o *SetSceneSceneTransitionOverrideParams) WithSceneUuid(x string) *SetSceneSceneTransitionOverrideParams

func (*SetSceneSceneTransitionOverrideParams) WithTransitionDuration added in v1.0.0 

func (o *SetSceneSceneTransitionOverrideParams) WithTransitionDuration(
	x float64,
) *SetSceneSceneTransitionOverrideParams

func (*SetSceneSceneTransitionOverrideParams) WithTransitionName added in v1.0.0 

func (o *SetSceneSceneTransitionOverrideParams) WithTransitionName(x string) *SetSceneSceneTransitionOverrideParams

type SetSceneSceneTransitionOverrideResponse added in v0.9.0 

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

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