sceneitems

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2022 License: Apache-2.0 Imports: 2 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*api.Client
}

Client represents a client for 'scene items' requests.

func (*Client) CreateSceneItem 

func (c *Client) CreateSceneItem(params *CreateSceneItemParams) (*CreateSceneItemResponse, error)

Creates a new scene item using a source.

Scenes only

func (*Client) DuplicateSceneItem 

func (c *Client) DuplicateSceneItem(params *DuplicateSceneItemParams) (*DuplicateSceneItemResponse, error)

Duplicates a scene item, copying all transform and crop info.

Scenes only

func (*Client) GetGroupSceneItemList added in v0.11.0 

func (c *Client) GetGroupSceneItemList(params *GetGroupSceneItemListParams) (*GetGroupSceneItemListResponse, error)

Basically GetSceneItemList, but for groups.

Using groups at all in OBS is discouraged, as they are very broken under the hood.

Groups only

func (*Client) GetSceneItemBlendMode 

func (c *Client) GetSceneItemBlendMode(params *GetSceneItemBlendModeParams) (*GetSceneItemBlendModeResponse, error)

Gets the blend mode of a scene item.

Blend modes:

- `OBS_BLEND_NORMAL` - `OBS_BLEND_ADDITIVE` - `OBS_BLEND_SUBTRACT` - `OBS_BLEND_SCREEN` - `OBS_BLEND_MULTIPLY` - `OBS_BLEND_LIGHTEN` - `OBS_BLEND_DARKEN`

Scenes and Groups

func (*Client) GetSceneItemEnabled 

func (c *Client) GetSceneItemEnabled(params *GetSceneItemEnabledParams) (*GetSceneItemEnabledResponse, error)

Gets the enable state of a scene item.

Scenes and Groups

func (*Client) GetSceneItemId 

func (c *Client) GetSceneItemId(params *GetSceneItemIdParams) (*GetSceneItemIdResponse, error)

Searches a scene for a source, and returns its id.

Scenes and Groups

func (*Client) GetSceneItemIndex 

func (c *Client) GetSceneItemIndex(params *GetSceneItemIndexParams) (*GetSceneItemIndexResponse, error)

Gets the index position of a scene item in a scene.

An index of 0 is at the bottom of the source list in the UI.

Scenes and Groups

func (*Client) GetSceneItemList 

func (c *Client) GetSceneItemList(params *GetSceneItemListParams) (*GetSceneItemListResponse, error)

Gets a list of all scene items in a scene.

Scenes only

func (*Client) GetSceneItemLocked 

func (c *Client) GetSceneItemLocked(params *GetSceneItemLockedParams) (*GetSceneItemLockedResponse, error)

Gets the lock state of a scene item.

Scenes and Groups

func (*Client) GetSceneItemTransform 

func (c *Client) GetSceneItemTransform(params *GetSceneItemTransformParams) (*GetSceneItemTransformResponse, error)

Gets the transform and crop info of a scene item.

Scenes and Groups

func (*Client) RemoveSceneItem 

func (c *Client) RemoveSceneItem(params *RemoveSceneItemParams) (*RemoveSceneItemResponse, error)

Removes a scene item from a scene.

Scenes only

func (*Client) SetSceneItemBlendMode 

func (c *Client) SetSceneItemBlendMode(params *SetSceneItemBlendModeParams) (*SetSceneItemBlendModeResponse, error)

Sets the blend mode of a scene item.

Scenes and Groups

func (*Client) SetSceneItemEnabled 

func (c *Client) SetSceneItemEnabled(params *SetSceneItemEnabledParams) (*SetSceneItemEnabledResponse, error)

Sets the enable state of a scene item.

Scenes and Groups

func (*Client) SetSceneItemIndex 

func (c *Client) SetSceneItemIndex(params *SetSceneItemIndexParams) (*SetSceneItemIndexResponse, error)

Sets the index position of a scene item in a scene.

Scenes and Groups

func (*Client) SetSceneItemLocked 

func (c *Client) SetSceneItemLocked(params *SetSceneItemLockedParams) (*SetSceneItemLockedResponse, error)

Sets the lock state of a scene item.

Scenes and Group

func (*Client) SetSceneItemTransform 

func (c *Client) SetSceneItemTransform(params *SetSceneItemTransformParams) (*SetSceneItemTransformResponse, error)

Sets the transform and crop info of a scene item.

type CreateSceneItemParams 

type CreateSceneItemParams struct {
	// Enable state to apply to the scene item on creation
	SceneItemEnabled *bool `json:"sceneItemEnabled,omitempty"`

	// Name of the scene to create the new item in
	SceneName string `json:"sceneName,omitempty"`

	// Name of the source to add to the scene
	SourceName string `json:"sourceName,omitempty"`
}

Represents the request body for the CreateSceneItem request.

func (*CreateSceneItemParams) GetRequestName 

func (o *CreateSceneItemParams) GetRequestName() string

Returns the associated request.

type CreateSceneItemResponse 

type CreateSceneItemResponse struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`
}

Represents the response body for the CreateSceneItem request.

type DuplicateSceneItemParams 

type DuplicateSceneItemParams struct {
	// Name of the scene to create the duplicated item in
	DestinationSceneName string `json:"destinationSceneName,omitempty"`

	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the DuplicateSceneItem request.

func (*DuplicateSceneItemParams) GetRequestName 

func (o *DuplicateSceneItemParams) GetRequestName() string

Returns the associated request.

type DuplicateSceneItemResponse 

type DuplicateSceneItemResponse struct {
	// Numeric ID of the duplicated scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`
}

Represents the response body for the DuplicateSceneItem request.

type GetGroupSceneItemListParams added in v0.11.0 

type GetGroupSceneItemListParams struct {
	// Name of the group to get the items of
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetGroupSceneItemList request.

func (*GetGroupSceneItemListParams) GetRequestName added in v0.11.0 

func (o *GetGroupSceneItemListParams) GetRequestName() string

Returns the associated request.

type GetGroupSceneItemListResponse added in v0.11.0 

type GetGroupSceneItemListResponse struct {
	SceneItems []*typedefs.SceneItem `json:"sceneItems,omitempty"`
}

Represents the response body for the GetGroupSceneItemList request.

type GetSceneItemBlendModeParams 

type GetSceneItemBlendModeParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemBlendMode request.

func (*GetSceneItemBlendModeParams) GetRequestName 

func (o *GetSceneItemBlendModeParams) GetRequestName() string

Returns the associated request.

type GetSceneItemBlendModeResponse 

type GetSceneItemBlendModeResponse struct {
	// Current blend mode
	SceneItemBlendMode string `json:"sceneItemBlendMode,omitempty"`
}

Represents the response body for the GetSceneItemBlendMode request.

type GetSceneItemEnabledParams 

type GetSceneItemEnabledParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemEnabled request.

func (*GetSceneItemEnabledParams) GetRequestName 

func (o *GetSceneItemEnabledParams) GetRequestName() string

Returns the associated request.

type GetSceneItemEnabledResponse 

type GetSceneItemEnabledResponse struct {
	// Whether the scene item is enabled. `true` for enabled, `false` for disabled
	SceneItemEnabled bool `json:"sceneItemEnabled,omitempty"`
}

Represents the response body for the GetSceneItemEnabled request.

type GetSceneItemIdParams 

type GetSceneItemIdParams struct {
	// Name of the scene or group to search in
	SceneName string `json:"sceneName,omitempty"`

	// Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item
	SearchOffset float64 `json:"searchOffset,omitempty"`

	// Name of the source to find
	SourceName string `json:"sourceName,omitempty"`
}

Represents the request body for the GetSceneItemId request.

func (*GetSceneItemIdParams) GetRequestName 

func (o *GetSceneItemIdParams) GetRequestName() string

Returns the associated request.

type GetSceneItemIdResponse 

type GetSceneItemIdResponse struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`
}

Represents the response body for the GetSceneItemId request.

type GetSceneItemIndexParams 

type GetSceneItemIndexParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemIndex request.

func (*GetSceneItemIndexParams) GetRequestName 

func (o *GetSceneItemIndexParams) GetRequestName() string

Returns the associated request.

type GetSceneItemIndexResponse 

type GetSceneItemIndexResponse struct {
	// Index position of the scene item
	SceneItemIndex float64 `json:"sceneItemIndex,omitempty"`
}

Represents the response body for the GetSceneItemIndex request.

type GetSceneItemListParams 

type GetSceneItemListParams struct {
	// Name of the scene to get the items of
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemList request.

func (*GetSceneItemListParams) GetRequestName 

func (o *GetSceneItemListParams) GetRequestName() string

Returns the associated request.

type GetSceneItemListResponse 

type GetSceneItemListResponse struct {
	SceneItems []*typedefs.SceneItem `json:"sceneItems,omitempty"`
}

Represents the response body for the GetSceneItemList request.

type GetSceneItemLockedParams 

type GetSceneItemLockedParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemLocked request.

func (*GetSceneItemLockedParams) GetRequestName 

func (o *GetSceneItemLockedParams) GetRequestName() string

Returns the associated request.

type GetSceneItemLockedResponse 

type GetSceneItemLockedResponse struct {
	// Whether the scene item is locked. `true` for locked, `false` for unlocked
	SceneItemLocked bool `json:"sceneItemLocked,omitempty"`
}

Represents the response body for the GetSceneItemLocked request.

type GetSceneItemTransformParams 

type GetSceneItemTransformParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the GetSceneItemTransform request.

func (*GetSceneItemTransformParams) GetRequestName 

func (o *GetSceneItemTransformParams) GetRequestName() string

Returns the associated request.

type GetSceneItemTransformResponse 

type GetSceneItemTransformResponse struct {
	// Scene item transform info
	SceneItemTransform *typedefs.SceneItemTransform `json:"sceneItemTransform,omitempty"`
}

Represents the response body for the GetSceneItemTransform request.

type RemoveSceneItemParams 

type RemoveSceneItemParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the RemoveSceneItem request.

func (*RemoveSceneItemParams) GetRequestName 

func (o *RemoveSceneItemParams) GetRequestName() string

Returns the associated request.

type RemoveSceneItemResponse 

type RemoveSceneItemResponse struct{}

Represents the response body for the RemoveSceneItem request.

type SetSceneItemBlendModeParams 

type SetSceneItemBlendModeParams struct {
	// New blend mode
	SceneItemBlendMode string `json:"sceneItemBlendMode,omitempty"`

	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the SetSceneItemBlendMode request.

func (*SetSceneItemBlendModeParams) GetRequestName 

func (o *SetSceneItemBlendModeParams) GetRequestName() string

Returns the associated request.

type SetSceneItemBlendModeResponse 

type SetSceneItemBlendModeResponse struct{}

Represents the response body for the SetSceneItemBlendMode request.

type SetSceneItemEnabledParams 

type SetSceneItemEnabledParams struct {
	// New enable state of the scene item
	SceneItemEnabled *bool `json:"sceneItemEnabled,omitempty"`

	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the SetSceneItemEnabled request.

func (*SetSceneItemEnabledParams) GetRequestName 

func (o *SetSceneItemEnabledParams) GetRequestName() string

Returns the associated request.

type SetSceneItemEnabledResponse 

type SetSceneItemEnabledResponse struct{}

Represents the response body for the SetSceneItemEnabled request.

type SetSceneItemIndexParams 

type SetSceneItemIndexParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// New index position of the scene item
	SceneItemIndex float64 `json:"sceneItemIndex,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the SetSceneItemIndex request.

func (*SetSceneItemIndexParams) GetRequestName 

func (o *SetSceneItemIndexParams) GetRequestName() string

Returns the associated request.

type SetSceneItemIndexResponse 

type SetSceneItemIndexResponse struct{}

Represents the response body for the SetSceneItemIndex request.

type SetSceneItemLockedParams 

type SetSceneItemLockedParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// New lock state of the scene item
	SceneItemLocked *bool `json:"sceneItemLocked,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the SetSceneItemLocked request.

func (*SetSceneItemLockedParams) GetRequestName 

func (o *SetSceneItemLockedParams) GetRequestName() string

Returns the associated request.

type SetSceneItemLockedResponse 

type SetSceneItemLockedResponse struct{}

Represents the response body for the SetSceneItemLocked request.

type SetSceneItemTransformParams 

type SetSceneItemTransformParams struct {
	// Numeric ID of the scene item
	SceneItemId float64 `json:"sceneItemId,omitempty"`

	// Scene item transform info
	SceneItemTransform *typedefs.SceneItemTransform `json:"sceneItemTransform,omitempty"`

	// Name of the scene the item is in
	SceneName string `json:"sceneName,omitempty"`
}

Represents the request body for the SetSceneItemTransform request.

func (*SetSceneItemTransformParams) GetRequestName 

func (o *SetSceneItemTransformParams) GetRequestName() string

Returns the associated request.

type SetSceneItemTransformResponse 

type SetSceneItemTransformResponse struct{}

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