scenes

Documentation

Index

• type Client
  • func (c *Client) GetCurrentScene(paramss ...*GetCurrentSceneParams) (*GetCurrentSceneResponse, error)
  • func (c *Client) GetSceneList(paramss ...*GetSceneListParams) (*GetSceneListResponse, error)
  • func (c *Client) ReorderSceneItems(params *ReorderSceneItemsParams) (*ReorderSceneItemsResponse, error)
  • func (c *Client) SetCurrentScene(params *SetCurrentSceneParams) (*SetCurrentSceneResponse, error)
• type GetCurrentSceneParams
  • func (o *GetCurrentSceneParams) Name() string
• type GetCurrentSceneResponse
• type GetSceneListParams
  • func (o *GetSceneListParams) Name() string
• type GetSceneListResponse
• type ReorderSceneItemsParams
  • func (o *ReorderSceneItemsParams) Name() string
• type ReorderSceneItemsResponse
• type SetCurrentSceneParams
  • func (o *SetCurrentSceneParams) Name() string
• type SetCurrentSceneResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'scenes' requests

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) 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.

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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#GetCurrentScene.

func (*GetCurrentSceneParams) Name

func (o *GetCurrentSceneParams) Name() string

Name just returns "GetCurrentScene".

type GetCurrentSceneResponse

type GetCurrentSceneResponse struct {
	requests.ResponseBasic

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

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#GetCurrentScene.

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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#GetSceneList.

func (*GetSceneListParams) Name

func (o *GetSceneListParams) Name() string

Name just returns "GetSceneList".

type GetSceneListResponse

type GetSceneListResponse struct {
	requests.ResponseBasic

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

	// Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for
	// more information).
	Scenes []map[string]interface{} `json:"scenes"`
}

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#GetSceneList.

type ReorderSceneItemsParams

type ReorderSceneItemsParams struct {
	requests.ParamsBasic

	Items []struct {
		// Id of a specific scene item. Unique on a scene by scene basis.
		Id int `json:"id"`

		// Name of a scene item. Sufficiently unique if no scene items share sources within the
		// scene.
		Name string `json:"name"`
	} `json:"items"`

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#ReorderSceneItems.

func (*ReorderSceneItemsParams) Name

func (o *ReorderSceneItemsParams) Name() string

Name 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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#ReorderSceneItems.

type SetCurrentSceneParams

type SetCurrentSceneParams struct {
	requests.ParamsBasic

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#SetCurrentScene.

func (*SetCurrentSceneParams) Name

func (o *SetCurrentSceneParams) Name() string

Name just returns "SetCurrentScene".

type SetCurrentSceneResponse

type SetCurrentSceneResponse struct {
	requests.ResponseBasic
}

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.7.0/docs/generated/protocol.md#SetCurrentScene.