scenecollections

Documentation

Index

• type Client
  • func (c *Client) GetCurrentSceneCollection(paramss ...*GetCurrentSceneCollectionParams) (*GetCurrentSceneCollectionResponse, error)
  • func (c *Client) ListSceneCollections(paramss ...*ListSceneCollectionsParams) (*ListSceneCollectionsResponse, error)
  • func (c *Client) SetCurrentSceneCollection(params *SetCurrentSceneCollectionParams) (*SetCurrentSceneCollectionResponse, error)
• type GetCurrentSceneCollectionParams
  • func (o *GetCurrentSceneCollectionParams) Name() string
• type GetCurrentSceneCollectionResponse
• type ListSceneCollectionsParams
  • func (o *ListSceneCollectionsParams) Name() string
• type ListSceneCollectionsResponse
• type SetCurrentSceneCollectionParams
  • func (o *SetCurrentSceneCollectionParams) Name() string
• type SetCurrentSceneCollectionResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'scene collections' requests

func (*Client) GetCurrentSceneCollection

func (c *Client) GetCurrentSceneCollection(
	paramss ...*GetCurrentSceneCollectionParams,
) (*GetCurrentSceneCollectionResponse, error)

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

func (*Client) ListSceneCollections

func (c *Client) ListSceneCollections(
	paramss ...*ListSceneCollectionsParams,
) (*ListSceneCollectionsResponse, error)

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

func (*Client) SetCurrentSceneCollection

func (c *Client) SetCurrentSceneCollection(
	params *SetCurrentSceneCollectionParams,
) (*SetCurrentSceneCollectionResponse, error)

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

type GetCurrentSceneCollectionParams

type GetCurrentSceneCollectionParams struct {
	requests.ParamsBasic
}

GetCurrentSceneCollectionParams represents the params body for the "GetCurrentSceneCollection" request. Get the name of the current scene collection.

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

func (*GetCurrentSceneCollectionParams) Name

func (o *GetCurrentSceneCollectionParams) Name() string

Name just returns "GetCurrentSceneCollection".

type GetCurrentSceneCollectionResponse

type GetCurrentSceneCollectionResponse struct {
	requests.ResponseBasic

	// Name of the currently active scene collection.
	ScName string `json:"sc-name"`
}

GetCurrentSceneCollectionResponse represents the response body for the "GetCurrentSceneCollection" request. Get the name of the current scene collection.

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

type ListSceneCollectionsParams

type ListSceneCollectionsParams struct {
	requests.ParamsBasic
}

ListSceneCollectionsParams represents the params body for the "ListSceneCollections" request. List available scene collections

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

func (*ListSceneCollectionsParams) Name

func (o *ListSceneCollectionsParams) Name() string

Name just returns "ListSceneCollections".

type ListSceneCollectionsResponse

type ListSceneCollectionsResponse struct {
	requests.ResponseBasic

	// Scene collections list
	SceneCollections []string `json:"scene-collections"`
}

ListSceneCollectionsResponse represents the response body for the "ListSceneCollections" request. List available scene collections

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

type SetCurrentSceneCollectionParams

type SetCurrentSceneCollectionParams struct {
	requests.ParamsBasic

	// Name of the desired scene collection.
	ScName string `json:"sc-name"`
}

SetCurrentSceneCollectionParams represents the params body for the "SetCurrentSceneCollection" request. Change the active scene collection.

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

func (*SetCurrentSceneCollectionParams) Name

func (o *SetCurrentSceneCollectionParams) Name() string

Name just returns "SetCurrentSceneCollection".

type SetCurrentSceneCollectionResponse

type SetCurrentSceneCollectionResponse struct {
	requests.ResponseBasic
}

SetCurrentSceneCollectionResponse represents the response body for the "SetCurrentSceneCollection" request. Change the active scene collection.

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