Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateSceneItem(paramss ...*CreateSceneItemParams) (*CreateSceneItemResponse, error)
- func (c *Client) DuplicateSceneItem(params *DuplicateSceneItemParams) (*DuplicateSceneItemResponse, error)
- func (c *Client) GetGroupSceneItemList(paramss ...*GetGroupSceneItemListParams) (*GetGroupSceneItemListResponse, error)
- func (c *Client) GetSceneItemBlendMode(params *GetSceneItemBlendModeParams) (*GetSceneItemBlendModeResponse, error)
- func (c *Client) GetSceneItemEnabled(params *GetSceneItemEnabledParams) (*GetSceneItemEnabledResponse, error)
- func (c *Client) GetSceneItemId(params *GetSceneItemIdParams) (*GetSceneItemIdResponse, error)
- func (c *Client) GetSceneItemIndex(params *GetSceneItemIndexParams) (*GetSceneItemIndexResponse, error)
- func (c *Client) GetSceneItemList(paramss ...*GetSceneItemListParams) (*GetSceneItemListResponse, error)
- func (c *Client) GetSceneItemLocked(params *GetSceneItemLockedParams) (*GetSceneItemLockedResponse, error)
- func (c *Client) GetSceneItemSource(params *GetSceneItemSourceParams) (*GetSceneItemSourceResponse, error)
- func (c *Client) GetSceneItemTransform(params *GetSceneItemTransformParams) (*GetSceneItemTransformResponse, error)
- func (c *Client) RemoveSceneItem(params *RemoveSceneItemParams) (*RemoveSceneItemResponse, error)
- func (c *Client) SetSceneItemBlendMode(params *SetSceneItemBlendModeParams) (*SetSceneItemBlendModeResponse, error)
- func (c *Client) SetSceneItemEnabled(params *SetSceneItemEnabledParams) (*SetSceneItemEnabledResponse, error)
- func (c *Client) SetSceneItemIndex(params *SetSceneItemIndexParams) (*SetSceneItemIndexResponse, error)
- func (c *Client) SetSceneItemLocked(params *SetSceneItemLockedParams) (*SetSceneItemLockedResponse, error)
- func (c *Client) SetSceneItemTransform(params *SetSceneItemTransformParams) (*SetSceneItemTransformResponse, error)
- type CreateSceneItemParams
- func (o *CreateSceneItemParams) GetRequestName() string
- func (o *CreateSceneItemParams) WithSceneItemEnabled(x bool) *CreateSceneItemParams
- func (o *CreateSceneItemParams) WithSceneName(x string) *CreateSceneItemParams
- func (o *CreateSceneItemParams) WithSceneUuid(x string) *CreateSceneItemParams
- func (o *CreateSceneItemParams) WithSourceName(x string) *CreateSceneItemParams
- func (o *CreateSceneItemParams) WithSourceUuid(x string) *CreateSceneItemParams
- type CreateSceneItemResponse
- type DuplicateSceneItemParams
- func (o *DuplicateSceneItemParams) GetRequestName() string
- func (o *DuplicateSceneItemParams) WithDestinationSceneName(x string) *DuplicateSceneItemParams
- func (o *DuplicateSceneItemParams) WithDestinationSceneUuid(x string) *DuplicateSceneItemParams
- func (o *DuplicateSceneItemParams) WithSceneItemId(x int) *DuplicateSceneItemParams
- func (o *DuplicateSceneItemParams) WithSceneName(x string) *DuplicateSceneItemParams
- func (o *DuplicateSceneItemParams) WithSceneUuid(x string) *DuplicateSceneItemParams
- type DuplicateSceneItemResponse
- type GetGroupSceneItemListParams
- type GetGroupSceneItemListResponse
- type GetSceneItemBlendModeParams
- func (o *GetSceneItemBlendModeParams) GetRequestName() string
- func (o *GetSceneItemBlendModeParams) WithSceneItemId(x int) *GetSceneItemBlendModeParams
- func (o *GetSceneItemBlendModeParams) WithSceneName(x string) *GetSceneItemBlendModeParams
- func (o *GetSceneItemBlendModeParams) WithSceneUuid(x string) *GetSceneItemBlendModeParams
- type GetSceneItemBlendModeResponse
- type GetSceneItemEnabledParams
- func (o *GetSceneItemEnabledParams) GetRequestName() string
- func (o *GetSceneItemEnabledParams) WithSceneItemId(x int) *GetSceneItemEnabledParams
- func (o *GetSceneItemEnabledParams) WithSceneName(x string) *GetSceneItemEnabledParams
- func (o *GetSceneItemEnabledParams) WithSceneUuid(x string) *GetSceneItemEnabledParams
- type GetSceneItemEnabledResponse
- type GetSceneItemIdParams
- func (o *GetSceneItemIdParams) GetRequestName() string
- func (o *GetSceneItemIdParams) WithSceneName(x string) *GetSceneItemIdParams
- func (o *GetSceneItemIdParams) WithSceneUuid(x string) *GetSceneItemIdParams
- func (o *GetSceneItemIdParams) WithSearchOffset(x float64) *GetSceneItemIdParams
- func (o *GetSceneItemIdParams) WithSourceName(x string) *GetSceneItemIdParams
- type GetSceneItemIdResponse
- type GetSceneItemIndexParams
- func (o *GetSceneItemIndexParams) GetRequestName() string
- func (o *GetSceneItemIndexParams) WithSceneItemId(x int) *GetSceneItemIndexParams
- func (o *GetSceneItemIndexParams) WithSceneName(x string) *GetSceneItemIndexParams
- func (o *GetSceneItemIndexParams) WithSceneUuid(x string) *GetSceneItemIndexParams
- type GetSceneItemIndexResponse
- type GetSceneItemListParams
- type GetSceneItemListResponse
- type GetSceneItemLockedParams
- func (o *GetSceneItemLockedParams) GetRequestName() string
- func (o *GetSceneItemLockedParams) WithSceneItemId(x int) *GetSceneItemLockedParams
- func (o *GetSceneItemLockedParams) WithSceneName(x string) *GetSceneItemLockedParams
- func (o *GetSceneItemLockedParams) WithSceneUuid(x string) *GetSceneItemLockedParams
- type GetSceneItemLockedResponse
- type GetSceneItemSourceParams
- func (o *GetSceneItemSourceParams) GetRequestName() string
- func (o *GetSceneItemSourceParams) WithSceneItemId(x int) *GetSceneItemSourceParams
- func (o *GetSceneItemSourceParams) WithSceneName(x string) *GetSceneItemSourceParams
- func (o *GetSceneItemSourceParams) WithSceneUuid(x string) *GetSceneItemSourceParams
- type GetSceneItemSourceResponse
- type GetSceneItemTransformParams
- func (o *GetSceneItemTransformParams) GetRequestName() string
- func (o *GetSceneItemTransformParams) WithSceneItemId(x int) *GetSceneItemTransformParams
- func (o *GetSceneItemTransformParams) WithSceneName(x string) *GetSceneItemTransformParams
- func (o *GetSceneItemTransformParams) WithSceneUuid(x string) *GetSceneItemTransformParams
- type GetSceneItemTransformResponse
- type RemoveSceneItemParams
- type RemoveSceneItemResponse
- type SetSceneItemBlendModeParams
- func (o *SetSceneItemBlendModeParams) GetRequestName() string
- func (o *SetSceneItemBlendModeParams) WithSceneItemBlendMode(x string) *SetSceneItemBlendModeParams
- func (o *SetSceneItemBlendModeParams) WithSceneItemId(x int) *SetSceneItemBlendModeParams
- func (o *SetSceneItemBlendModeParams) WithSceneName(x string) *SetSceneItemBlendModeParams
- func (o *SetSceneItemBlendModeParams) WithSceneUuid(x string) *SetSceneItemBlendModeParams
- type SetSceneItemBlendModeResponse
- type SetSceneItemEnabledParams
- func (o *SetSceneItemEnabledParams) GetRequestName() string
- func (o *SetSceneItemEnabledParams) WithSceneItemEnabled(x bool) *SetSceneItemEnabledParams
- func (o *SetSceneItemEnabledParams) WithSceneItemId(x int) *SetSceneItemEnabledParams
- func (o *SetSceneItemEnabledParams) WithSceneName(x string) *SetSceneItemEnabledParams
- func (o *SetSceneItemEnabledParams) WithSceneUuid(x string) *SetSceneItemEnabledParams
- type SetSceneItemEnabledResponse
- type SetSceneItemIndexParams
- func (o *SetSceneItemIndexParams) GetRequestName() string
- func (o *SetSceneItemIndexParams) WithSceneItemId(x int) *SetSceneItemIndexParams
- func (o *SetSceneItemIndexParams) WithSceneItemIndex(x int) *SetSceneItemIndexParams
- func (o *SetSceneItemIndexParams) WithSceneName(x string) *SetSceneItemIndexParams
- func (o *SetSceneItemIndexParams) WithSceneUuid(x string) *SetSceneItemIndexParams
- type SetSceneItemIndexResponse
- type SetSceneItemLockedParams
- func (o *SetSceneItemLockedParams) GetRequestName() string
- func (o *SetSceneItemLockedParams) WithSceneItemId(x int) *SetSceneItemLockedParams
- func (o *SetSceneItemLockedParams) WithSceneItemLocked(x bool) *SetSceneItemLockedParams
- func (o *SetSceneItemLockedParams) WithSceneName(x string) *SetSceneItemLockedParams
- func (o *SetSceneItemLockedParams) WithSceneUuid(x string) *SetSceneItemLockedParams
- type SetSceneItemLockedResponse
- type SetSceneItemTransformParams
- func (o *SetSceneItemTransformParams) GetRequestName() string
- func (o *SetSceneItemTransformParams) WithSceneItemId(x int) *SetSceneItemTransformParams
- func (o *SetSceneItemTransformParams) WithSceneItemTransform(x *typedefs.SceneItemTransform) *SetSceneItemTransformParams
- func (o *SetSceneItemTransformParams) WithSceneName(x string) *SetSceneItemTransformParams
- func (o *SetSceneItemTransformParams) WithSceneUuid(x string) *SetSceneItemTransformParams
- type SetSceneItemTransformResponse
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 'scene items' requests.
func (*Client) CreateSceneItem ¶
func (c *Client) CreateSceneItem(paramss ...*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 ¶
func (c *Client) GetGroupSceneItemList( paramss ...*GetGroupSceneItemListParams, ) (*GetGroupSceneItemListResponse, error)
Basically GetSceneItemList, but for groups.
Using groups at all in OBS is discouraged, as they are very broken under the hood. Please use nested scenes instead.
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(paramss ...*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) GetSceneItemSource ¶
func (c *Client) GetSceneItemSource(params *GetSceneItemSourceParams) (*GetSceneItemSourceResponse, error)
Gets the source associated with a scene item.
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"`
// UUID of the scene to create the new item in
SceneUuid *string `json:"sceneUuid,omitempty"`
// Name of the source to add to the scene
SourceName *string `json:"sourceName,omitempty"`
// UUID of the source to add to the scene
SourceUuid *string `json:"sourceUuid,omitempty"`
}
Represents the request body for the CreateSceneItem request.
func NewCreateSceneItemParams ¶
func NewCreateSceneItemParams() *CreateSceneItemParams
func (*CreateSceneItemParams) GetRequestName ¶
func (o *CreateSceneItemParams) GetRequestName() string
Returns the associated request.
func (*CreateSceneItemParams) WithSceneItemEnabled ¶
func (o *CreateSceneItemParams) WithSceneItemEnabled(x bool) *CreateSceneItemParams
func (*CreateSceneItemParams) WithSceneName ¶
func (o *CreateSceneItemParams) WithSceneName(x string) *CreateSceneItemParams
func (*CreateSceneItemParams) WithSceneUuid ¶
func (o *CreateSceneItemParams) WithSceneUuid(x string) *CreateSceneItemParams
func (*CreateSceneItemParams) WithSourceName ¶
func (o *CreateSceneItemParams) WithSourceName(x string) *CreateSceneItemParams
func (*CreateSceneItemParams) WithSourceUuid ¶
func (o *CreateSceneItemParams) WithSourceUuid(x string) *CreateSceneItemParams
type CreateSceneItemResponse ¶
type CreateSceneItemResponse struct {
// Numeric ID of the scene item
SceneItemId int `json:"sceneItemId,omitempty"`
// contains filtered or unexported fields
}
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"`
// UUID of the scene to create the duplicated item in
DestinationSceneUuid *string `json:"destinationSceneUuid,omitempty"`
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the DuplicateSceneItem request.
func NewDuplicateSceneItemParams ¶
func NewDuplicateSceneItemParams() *DuplicateSceneItemParams
func (*DuplicateSceneItemParams) GetRequestName ¶
func (o *DuplicateSceneItemParams) GetRequestName() string
Returns the associated request.
func (*DuplicateSceneItemParams) WithDestinationSceneName ¶
func (o *DuplicateSceneItemParams) WithDestinationSceneName(x string) *DuplicateSceneItemParams
func (*DuplicateSceneItemParams) WithDestinationSceneUuid ¶
func (o *DuplicateSceneItemParams) WithDestinationSceneUuid(x string) *DuplicateSceneItemParams
func (*DuplicateSceneItemParams) WithSceneItemId ¶
func (o *DuplicateSceneItemParams) WithSceneItemId(x int) *DuplicateSceneItemParams
func (*DuplicateSceneItemParams) WithSceneName ¶
func (o *DuplicateSceneItemParams) WithSceneName(x string) *DuplicateSceneItemParams
func (*DuplicateSceneItemParams) WithSceneUuid ¶
func (o *DuplicateSceneItemParams) WithSceneUuid(x string) *DuplicateSceneItemParams
type DuplicateSceneItemResponse ¶
type DuplicateSceneItemResponse struct {
// Numeric ID of the duplicated scene item
SceneItemId int `json:"sceneItemId,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the DuplicateSceneItem request.
type GetGroupSceneItemListParams ¶
type GetGroupSceneItemListParams struct {
// Name of the group to get the items of
SceneName *string `json:"sceneName,omitempty"`
// UUID of the group to get the items of
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetGroupSceneItemList request.
func NewGetGroupSceneItemListParams ¶
func NewGetGroupSceneItemListParams() *GetGroupSceneItemListParams
func (*GetGroupSceneItemListParams) GetRequestName ¶
func (o *GetGroupSceneItemListParams) GetRequestName() string
Returns the associated request.
func (*GetGroupSceneItemListParams) WithSceneName ¶
func (o *GetGroupSceneItemListParams) WithSceneName(x string) *GetGroupSceneItemListParams
func (*GetGroupSceneItemListParams) WithSceneUuid ¶
func (o *GetGroupSceneItemListParams) WithSceneUuid(x string) *GetGroupSceneItemListParams
type GetGroupSceneItemListResponse ¶
type GetGroupSceneItemListResponse struct {
// Array of scene items in the group
SceneItems []*typedefs.SceneItem `json:"sceneItems,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetGroupSceneItemList request.
type GetSceneItemBlendModeParams ¶
type GetSceneItemBlendModeParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemBlendMode request.
func NewGetSceneItemBlendModeParams ¶
func NewGetSceneItemBlendModeParams() *GetSceneItemBlendModeParams
func (*GetSceneItemBlendModeParams) GetRequestName ¶
func (o *GetSceneItemBlendModeParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemBlendModeParams) WithSceneItemId ¶
func (o *GetSceneItemBlendModeParams) WithSceneItemId(x int) *GetSceneItemBlendModeParams
func (*GetSceneItemBlendModeParams) WithSceneName ¶
func (o *GetSceneItemBlendModeParams) WithSceneName(x string) *GetSceneItemBlendModeParams
func (*GetSceneItemBlendModeParams) WithSceneUuid ¶
func (o *GetSceneItemBlendModeParams) WithSceneUuid(x string) *GetSceneItemBlendModeParams
type GetSceneItemBlendModeResponse ¶
type GetSceneItemBlendModeResponse struct {
// Current blend mode
SceneItemBlendMode string `json:"sceneItemBlendMode,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemBlendMode request.
type GetSceneItemEnabledParams ¶
type GetSceneItemEnabledParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemEnabled request.
func NewGetSceneItemEnabledParams ¶
func NewGetSceneItemEnabledParams() *GetSceneItemEnabledParams
func (*GetSceneItemEnabledParams) GetRequestName ¶
func (o *GetSceneItemEnabledParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemEnabledParams) WithSceneItemId ¶
func (o *GetSceneItemEnabledParams) WithSceneItemId(x int) *GetSceneItemEnabledParams
func (*GetSceneItemEnabledParams) WithSceneName ¶
func (o *GetSceneItemEnabledParams) WithSceneName(x string) *GetSceneItemEnabledParams
func (*GetSceneItemEnabledParams) WithSceneUuid ¶
func (o *GetSceneItemEnabledParams) WithSceneUuid(x string) *GetSceneItemEnabledParams
type GetSceneItemEnabledResponse ¶
type GetSceneItemEnabledResponse struct {
// Whether the scene item is enabled. `true` for enabled, `false` for disabled
SceneItemEnabled bool `json:"sceneItemEnabled,omitempty"`
// contains filtered or unexported fields
}
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"`
// UUID of the scene or group to search in
SceneUuid *string `json:"sceneUuid,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 NewGetSceneItemIdParams ¶
func NewGetSceneItemIdParams() *GetSceneItemIdParams
func (*GetSceneItemIdParams) GetRequestName ¶
func (o *GetSceneItemIdParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemIdParams) WithSceneName ¶
func (o *GetSceneItemIdParams) WithSceneName(x string) *GetSceneItemIdParams
func (*GetSceneItemIdParams) WithSceneUuid ¶
func (o *GetSceneItemIdParams) WithSceneUuid(x string) *GetSceneItemIdParams
func (*GetSceneItemIdParams) WithSearchOffset ¶
func (o *GetSceneItemIdParams) WithSearchOffset(x float64) *GetSceneItemIdParams
func (*GetSceneItemIdParams) WithSourceName ¶
func (o *GetSceneItemIdParams) WithSourceName(x string) *GetSceneItemIdParams
type GetSceneItemIdResponse ¶
type GetSceneItemIdResponse struct {
// Numeric ID of the scene item
SceneItemId int `json:"sceneItemId,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemId request.
type GetSceneItemIndexParams ¶
type GetSceneItemIndexParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemIndex request.
func NewGetSceneItemIndexParams ¶
func NewGetSceneItemIndexParams() *GetSceneItemIndexParams
func (*GetSceneItemIndexParams) GetRequestName ¶
func (o *GetSceneItemIndexParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemIndexParams) WithSceneItemId ¶
func (o *GetSceneItemIndexParams) WithSceneItemId(x int) *GetSceneItemIndexParams
func (*GetSceneItemIndexParams) WithSceneName ¶
func (o *GetSceneItemIndexParams) WithSceneName(x string) *GetSceneItemIndexParams
func (*GetSceneItemIndexParams) WithSceneUuid ¶
func (o *GetSceneItemIndexParams) WithSceneUuid(x string) *GetSceneItemIndexParams
type GetSceneItemIndexResponse ¶
type GetSceneItemIndexResponse struct {
// Index position of the scene item
SceneItemIndex int `json:"sceneItemIndex,omitempty"`
// contains filtered or unexported fields
}
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"`
// UUID of the scene to get the items of
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemList request.
func NewGetSceneItemListParams ¶
func NewGetSceneItemListParams() *GetSceneItemListParams
func (*GetSceneItemListParams) GetRequestName ¶
func (o *GetSceneItemListParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemListParams) WithSceneName ¶
func (o *GetSceneItemListParams) WithSceneName(x string) *GetSceneItemListParams
func (*GetSceneItemListParams) WithSceneUuid ¶
func (o *GetSceneItemListParams) WithSceneUuid(x string) *GetSceneItemListParams
type GetSceneItemListResponse ¶
type GetSceneItemListResponse struct {
// Array of scene items in the scene
SceneItems []*typedefs.SceneItem `json:"sceneItems,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemList request.
type GetSceneItemLockedParams ¶
type GetSceneItemLockedParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemLocked request.
func NewGetSceneItemLockedParams ¶
func NewGetSceneItemLockedParams() *GetSceneItemLockedParams
func (*GetSceneItemLockedParams) GetRequestName ¶
func (o *GetSceneItemLockedParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemLockedParams) WithSceneItemId ¶
func (o *GetSceneItemLockedParams) WithSceneItemId(x int) *GetSceneItemLockedParams
func (*GetSceneItemLockedParams) WithSceneName ¶
func (o *GetSceneItemLockedParams) WithSceneName(x string) *GetSceneItemLockedParams
func (*GetSceneItemLockedParams) WithSceneUuid ¶
func (o *GetSceneItemLockedParams) WithSceneUuid(x string) *GetSceneItemLockedParams
type GetSceneItemLockedResponse ¶
type GetSceneItemLockedResponse struct {
// Whether the scene item is locked. `true` for locked, `false` for unlocked
SceneItemLocked bool `json:"sceneItemLocked,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemLocked request.
type GetSceneItemSourceParams ¶
type GetSceneItemSourceParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemSource request.
func NewGetSceneItemSourceParams ¶
func NewGetSceneItemSourceParams() *GetSceneItemSourceParams
func (*GetSceneItemSourceParams) GetRequestName ¶
func (o *GetSceneItemSourceParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemSourceParams) WithSceneItemId ¶
func (o *GetSceneItemSourceParams) WithSceneItemId(x int) *GetSceneItemSourceParams
func (*GetSceneItemSourceParams) WithSceneName ¶
func (o *GetSceneItemSourceParams) WithSceneName(x string) *GetSceneItemSourceParams
func (*GetSceneItemSourceParams) WithSceneUuid ¶
func (o *GetSceneItemSourceParams) WithSceneUuid(x string) *GetSceneItemSourceParams
type GetSceneItemSourceResponse ¶
type GetSceneItemSourceResponse struct {
// Name of the source associated with the scene item
SourceName string `json:"sourceName,omitempty"`
// UUID of the source associated with the scene item
SourceUuid string `json:"sourceUuid,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemSource request.
type GetSceneItemTransformParams ¶
type GetSceneItemTransformParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the GetSceneItemTransform request.
func NewGetSceneItemTransformParams ¶
func NewGetSceneItemTransformParams() *GetSceneItemTransformParams
func (*GetSceneItemTransformParams) GetRequestName ¶
func (o *GetSceneItemTransformParams) GetRequestName() string
Returns the associated request.
func (*GetSceneItemTransformParams) WithSceneItemId ¶
func (o *GetSceneItemTransformParams) WithSceneItemId(x int) *GetSceneItemTransformParams
func (*GetSceneItemTransformParams) WithSceneName ¶
func (o *GetSceneItemTransformParams) WithSceneName(x string) *GetSceneItemTransformParams
func (*GetSceneItemTransformParams) WithSceneUuid ¶
func (o *GetSceneItemTransformParams) WithSceneUuid(x string) *GetSceneItemTransformParams
type GetSceneItemTransformResponse ¶
type GetSceneItemTransformResponse struct {
// Object containing scene item transform info
SceneItemTransform *typedefs.SceneItemTransform `json:"sceneItemTransform,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSceneItemTransform request.
type RemoveSceneItemParams ¶
type RemoveSceneItemParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the RemoveSceneItem request.
func NewRemoveSceneItemParams ¶
func NewRemoveSceneItemParams() *RemoveSceneItemParams
func (*RemoveSceneItemParams) GetRequestName ¶
func (o *RemoveSceneItemParams) GetRequestName() string
Returns the associated request.
func (*RemoveSceneItemParams) WithSceneItemId ¶
func (o *RemoveSceneItemParams) WithSceneItemId(x int) *RemoveSceneItemParams
func (*RemoveSceneItemParams) WithSceneName ¶
func (o *RemoveSceneItemParams) WithSceneName(x string) *RemoveSceneItemParams
func (*RemoveSceneItemParams) WithSceneUuid ¶
func (o *RemoveSceneItemParams) WithSceneUuid(x string) *RemoveSceneItemParams
type RemoveSceneItemResponse ¶
type RemoveSceneItemResponse struct {
// contains filtered or unexported fields
}
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 *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneItemBlendMode request.
func NewSetSceneItemBlendModeParams ¶
func NewSetSceneItemBlendModeParams() *SetSceneItemBlendModeParams
func (*SetSceneItemBlendModeParams) GetRequestName ¶
func (o *SetSceneItemBlendModeParams) GetRequestName() string
Returns the associated request.
func (*SetSceneItemBlendModeParams) WithSceneItemBlendMode ¶
func (o *SetSceneItemBlendModeParams) WithSceneItemBlendMode(x string) *SetSceneItemBlendModeParams
func (*SetSceneItemBlendModeParams) WithSceneItemId ¶
func (o *SetSceneItemBlendModeParams) WithSceneItemId(x int) *SetSceneItemBlendModeParams
func (*SetSceneItemBlendModeParams) WithSceneName ¶
func (o *SetSceneItemBlendModeParams) WithSceneName(x string) *SetSceneItemBlendModeParams
func (*SetSceneItemBlendModeParams) WithSceneUuid ¶
func (o *SetSceneItemBlendModeParams) WithSceneUuid(x string) *SetSceneItemBlendModeParams
type SetSceneItemBlendModeResponse ¶
type SetSceneItemBlendModeResponse struct {
// contains filtered or unexported fields
}
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 *int `json:"sceneItemId,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneItemEnabled request.
func NewSetSceneItemEnabledParams ¶
func NewSetSceneItemEnabledParams() *SetSceneItemEnabledParams
func (*SetSceneItemEnabledParams) GetRequestName ¶
func (o *SetSceneItemEnabledParams) GetRequestName() string
Returns the associated request.
func (*SetSceneItemEnabledParams) WithSceneItemEnabled ¶
func (o *SetSceneItemEnabledParams) WithSceneItemEnabled(x bool) *SetSceneItemEnabledParams
func (*SetSceneItemEnabledParams) WithSceneItemId ¶
func (o *SetSceneItemEnabledParams) WithSceneItemId(x int) *SetSceneItemEnabledParams
func (*SetSceneItemEnabledParams) WithSceneName ¶
func (o *SetSceneItemEnabledParams) WithSceneName(x string) *SetSceneItemEnabledParams
func (*SetSceneItemEnabledParams) WithSceneUuid ¶
func (o *SetSceneItemEnabledParams) WithSceneUuid(x string) *SetSceneItemEnabledParams
type SetSceneItemEnabledResponse ¶
type SetSceneItemEnabledResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneItemEnabled request.
type SetSceneItemIndexParams ¶
type SetSceneItemIndexParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// New index position of the scene item
SceneItemIndex *int `json:"sceneItemIndex,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneItemIndex request.
func NewSetSceneItemIndexParams ¶
func NewSetSceneItemIndexParams() *SetSceneItemIndexParams
func (*SetSceneItemIndexParams) GetRequestName ¶
func (o *SetSceneItemIndexParams) GetRequestName() string
Returns the associated request.
func (*SetSceneItemIndexParams) WithSceneItemId ¶
func (o *SetSceneItemIndexParams) WithSceneItemId(x int) *SetSceneItemIndexParams
func (*SetSceneItemIndexParams) WithSceneItemIndex ¶
func (o *SetSceneItemIndexParams) WithSceneItemIndex(x int) *SetSceneItemIndexParams
func (*SetSceneItemIndexParams) WithSceneName ¶
func (o *SetSceneItemIndexParams) WithSceneName(x string) *SetSceneItemIndexParams
func (*SetSceneItemIndexParams) WithSceneUuid ¶
func (o *SetSceneItemIndexParams) WithSceneUuid(x string) *SetSceneItemIndexParams
type SetSceneItemIndexResponse ¶
type SetSceneItemIndexResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneItemIndex request.
type SetSceneItemLockedParams ¶
type SetSceneItemLockedParams struct {
// Numeric ID of the scene item
SceneItemId *int `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"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneItemLocked request.
func NewSetSceneItemLockedParams ¶
func NewSetSceneItemLockedParams() *SetSceneItemLockedParams
func (*SetSceneItemLockedParams) GetRequestName ¶
func (o *SetSceneItemLockedParams) GetRequestName() string
Returns the associated request.
func (*SetSceneItemLockedParams) WithSceneItemId ¶
func (o *SetSceneItemLockedParams) WithSceneItemId(x int) *SetSceneItemLockedParams
func (*SetSceneItemLockedParams) WithSceneItemLocked ¶
func (o *SetSceneItemLockedParams) WithSceneItemLocked(x bool) *SetSceneItemLockedParams
func (*SetSceneItemLockedParams) WithSceneName ¶
func (o *SetSceneItemLockedParams) WithSceneName(x string) *SetSceneItemLockedParams
func (*SetSceneItemLockedParams) WithSceneUuid ¶
func (o *SetSceneItemLockedParams) WithSceneUuid(x string) *SetSceneItemLockedParams
type SetSceneItemLockedResponse ¶
type SetSceneItemLockedResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneItemLocked request.
type SetSceneItemTransformParams ¶
type SetSceneItemTransformParams struct {
// Numeric ID of the scene item
SceneItemId *int `json:"sceneItemId,omitempty"`
// Object containing scene item transform info to update
SceneItemTransform *typedefs.SceneItemTransform `json:"sceneItemTransform,omitempty"`
// Name of the scene the item is in
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene the item is in
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the SetSceneItemTransform request.
func NewSetSceneItemTransformParams ¶
func NewSetSceneItemTransformParams() *SetSceneItemTransformParams
func (*SetSceneItemTransformParams) GetRequestName ¶
func (o *SetSceneItemTransformParams) GetRequestName() string
Returns the associated request.
func (*SetSceneItemTransformParams) WithSceneItemId ¶
func (o *SetSceneItemTransformParams) WithSceneItemId(x int) *SetSceneItemTransformParams
func (*SetSceneItemTransformParams) WithSceneItemTransform ¶
func (o *SetSceneItemTransformParams) WithSceneItemTransform( x *typedefs.SceneItemTransform, ) *SetSceneItemTransformParams
func (*SetSceneItemTransformParams) WithSceneName ¶
func (o *SetSceneItemTransformParams) WithSceneName(x string) *SetSceneItemTransformParams
func (*SetSceneItemTransformParams) WithSceneUuid ¶
func (o *SetSceneItemTransformParams) WithSceneUuid(x string) *SetSceneItemTransformParams
type SetSceneItemTransformResponse ¶
type SetSceneItemTransformResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetSceneItemTransform request.
Source Files
¶
- xx_generated.createsceneitem.go
- xx_generated.duplicatesceneitem.go
- xx_generated.getgroupsceneitemlist.go
- xx_generated.getsceneitemblendmode.go
- xx_generated.getsceneitemenabled.go
- xx_generated.getsceneitemid.go
- xx_generated.getsceneitemindex.go
- xx_generated.getsceneitemlist.go
- xx_generated.getsceneitemlocked.go
- xx_generated.getsceneitemsource.go
- xx_generated.getsceneitemtransform.go
- xx_generated.removesceneitem.go
- xx_generated.setsceneitemblendmode.go
- xx_generated.setsceneitemenabled.go
- xx_generated.setsceneitemindex.go
- xx_generated.setsceneitemlocked.go
- xx_generated.setsceneitemtransform.go
- zz_generated.client.go