scenes

package
v0.7.1 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2021 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 {
	*requests.Client
}

Client represents a client for 'scenes' requests.

func (*Client) CreateScene added in v0.5.0 

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

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

func (*Client) GetCurrentScene 

func (c *Client) GetCurrentScene(paramss ...*GetCurrentSceneParams) (*GetCurrentSceneResponse, error)

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

func (*Client) GetSceneList 

func (c *Client) GetSceneList(paramss ...*GetSceneListParams) (*GetSceneListResponse, error)

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

func (*Client) GetSceneTransitionOverride added in v0.4.0 

func (c *Client) GetSceneTransitionOverride(
	params *GetSceneTransitionOverrideParams,
) (*GetSceneTransitionOverrideResponse, error)

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

func (*Client) RemoveSceneTransitionOverride added in v0.4.0 

func (c *Client) RemoveSceneTransitionOverride(
	params *RemoveSceneTransitionOverrideParams,
) (*RemoveSceneTransitionOverrideResponse, error)

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

func (*Client) ReorderSceneItems 

func (c *Client) ReorderSceneItems(params *ReorderSceneItemsParams) (*ReorderSceneItemsResponse, error)

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

func (*Client) SetCurrentScene 

func (c *Client) SetCurrentScene(params *SetCurrentSceneParams) (*SetCurrentSceneResponse, error)

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

func (*Client) SetSceneTransitionOverride added in v0.4.0 

func (c *Client) SetSceneTransitionOverride(
	params *SetSceneTransitionOverrideParams,
) (*SetSceneTransitionOverrideResponse, error)

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

type CreateSceneParams added in v0.5.0 

type CreateSceneParams struct {
	requests.ParamsBasic

	// Name of the scene to create.
	SceneName string `json:"sceneName,omitempty"`
}

CreateSceneParams represents the params body for the "CreateScene" request. Create a new scene scene. Since 4.9.0.

func (*CreateSceneParams) GetSelfName added in v0.5.0 

func (o *CreateSceneParams) GetSelfName() string

GetSelfName just returns "CreateScene".

type CreateSceneResponse added in v0.5.0 

type CreateSceneResponse struct {
	requests.ResponseBasic
}

CreateSceneResponse represents the response body for the "CreateScene" request. Create a new scene scene. Since v4.9.0.

type GetCurrentSceneParams 

type GetCurrentSceneParams struct {
	requests.ParamsBasic
}

GetCurrentSceneParams represents the params body for the "GetCurrentScene" request. Get the current scene's name and source items. Since 0.3.

func (*GetCurrentSceneParams) GetSelfName added in v0.5.0 

func (o *GetCurrentSceneParams) GetSelfName() string

GetSelfName just returns "GetCurrentScene".

type GetCurrentSceneResponse 

type GetCurrentSceneResponse struct {
	requests.ResponseBasic

	// Name of the currently active scene.
	Name string `json:"name,omitempty"`

	// Ordered list of the current scene's source items.
	Sources []typedefs.SceneItem `json:"sources,omitempty"`
}

GetCurrentSceneResponse represents the response body for the "GetCurrentScene" request. Get the current scene's name and source items. Since v0.3.

type GetSceneListParams 

type GetSceneListParams struct {
	requests.ParamsBasic
}

GetSceneListParams represents the params body for the "GetSceneList" request. Get a list of scenes in the currently active profile. Since 0.3.

func (*GetSceneListParams) GetSelfName added in v0.5.0 

func (o *GetSceneListParams) GetSelfName() string

GetSelfName just returns "GetSceneList".

type GetSceneListResponse 

type GetSceneListResponse struct {
	requests.ResponseBasic

	// Name of the currently active scene.
	CurrentScene string `json:"current-scene,omitempty"`

	// Ordered list of the current profile's scenes (See [GetCurrentScene](#getcurrentscene) for more information).
	Scenes []typedefs.Scene `json:"scenes,omitempty"`
}

GetSceneListResponse represents the response body for the "GetSceneList" request. Get a list of scenes in the currently active profile. Since v0.3.

type GetSceneTransitionOverrideParams added in v0.4.0 

type GetSceneTransitionOverrideParams struct {
	requests.ParamsBasic

	// Name of the scene to switch to.
	SceneName string `json:"sceneName,omitempty"`
}

GetSceneTransitionOverrideParams represents the params body for the "GetSceneTransitionOverride" request. Get the current scene transition override. Since 4.8.0.

func (*GetSceneTransitionOverrideParams) GetSelfName added in v0.5.0 

func (o *GetSceneTransitionOverrideParams) GetSelfName() string

GetSelfName just returns "GetSceneTransitionOverride".

type GetSceneTransitionOverrideResponse added in v0.4.0 

type GetSceneTransitionOverrideResponse struct {
	requests.ResponseBasic

	// Transition duration. `-1` if no override is set.
	TransitionDuration int `json:"transitionDuration,omitempty"`

	// Name of the current overriding transition. Empty string if no override is set.
	TransitionName string `json:"transitionName,omitempty"`
}

GetSceneTransitionOverrideResponse represents the response body for the "GetSceneTransitionOverride" request. Get the current scene transition override. Since v4.8.0.

type RemoveSceneTransitionOverrideParams added in v0.4.0 

type RemoveSceneTransitionOverrideParams struct {
	requests.ParamsBasic

	// Name of the scene to switch to.
	SceneName string `json:"sceneName,omitempty"`
}

RemoveSceneTransitionOverrideParams represents the params body for the "RemoveSceneTransitionOverride" request. Remove any transition override on a scene. Since 4.8.0.

func (*RemoveSceneTransitionOverrideParams) GetSelfName added in v0.5.0 

func (o *RemoveSceneTransitionOverrideParams) GetSelfName() string

GetSelfName just returns "RemoveSceneTransitionOverride".

type RemoveSceneTransitionOverrideResponse added in v0.4.0 

type RemoveSceneTransitionOverrideResponse struct {
	requests.ResponseBasic
}

RemoveSceneTransitionOverrideResponse represents the response body for the "RemoveSceneTransitionOverride" request. Remove any transition override on a scene. Since v4.8.0.

type ReorderSceneItemsParams 

type ReorderSceneItemsParams struct {
	requests.ParamsBasic

	// The items for this object.
	Items []*typedefs.Item `json:"items,omitempty"`

	// Name of the scene to reorder (defaults to current).
	Scene string `json:"scene,omitempty"`
}

ReorderSceneItemsParams represents the params body for the "ReorderSceneItems" request. Changes the order of scene items in the requested scene. Since 4.5.0.

func (*ReorderSceneItemsParams) GetSelfName added in v0.5.0 

func (o *ReorderSceneItemsParams) GetSelfName() string

GetSelfName just returns "ReorderSceneItems".

type ReorderSceneItemsResponse 

type ReorderSceneItemsResponse struct {
	requests.ResponseBasic
}

ReorderSceneItemsResponse represents the response body for the "ReorderSceneItems" request. Changes the order of scene items in the requested scene. Since v4.5.0.

type SetCurrentSceneParams 

type SetCurrentSceneParams struct {
	requests.ParamsBasic

	// Name of the scene to switch to.
	SceneName string `json:"scene-name,omitempty"`
}

SetCurrentSceneParams represents the params body for the "SetCurrentScene" request. Switch to the specified scene. Since 0.3.

func (*SetCurrentSceneParams) GetSelfName added in v0.5.0 

func (o *SetCurrentSceneParams) GetSelfName() string

GetSelfName just returns "SetCurrentScene".

type SetCurrentSceneResponse 

type SetCurrentSceneResponse struct {
	requests.ResponseBasic
}

SetCurrentSceneResponse represents the response body for the "SetCurrentScene" request. Switch to the specified scene. Since v0.3.

type SetSceneTransitionOverrideParams added in v0.4.0 

type SetSceneTransitionOverrideParams struct {
	requests.ParamsBasic

	// Name of the scene to switch to.
	SceneName string `json:"sceneName,omitempty"`

	// Duration in milliseconds of the transition if transition is not fixed. Defaults to the current duration specified
	// in the UI if there is no current override and this value is not given.
	TransitionDuration int `json:"transitionDuration,omitempty"`

	// Name of the transition to use.
	TransitionName string `json:"transitionName,omitempty"`
}

SetSceneTransitionOverrideParams represents the params body for the "SetSceneTransitionOverride" request. Set a scene to use a specific transition override. Since 4.8.0.

func (*SetSceneTransitionOverrideParams) GetSelfName added in v0.5.0 

func (o *SetSceneTransitionOverrideParams) GetSelfName() string

GetSelfName just returns "SetSceneTransitionOverride".

type SetSceneTransitionOverrideResponse added in v0.4.0 

type SetSceneTransitionOverrideResponse struct {
	requests.ResponseBasic
}

SetSceneTransitionOverrideResponse represents the response body for the "SetSceneTransitionOverride" request. Set a scene to use a specific transition override. Since v4.8.0.

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.