Documentation
¶
Index ¶
- type Client
- func (c *Client) GetCurrentSceneTransition(paramss ...*GetCurrentSceneTransitionParams) (*GetCurrentSceneTransitionResponse, error)
- func (c *Client) GetCurrentSceneTransitionCursor(paramss ...*GetCurrentSceneTransitionCursorParams) (*GetCurrentSceneTransitionCursorResponse, error)
- func (c *Client) GetSceneTransitionList(paramss ...*GetSceneTransitionListParams) (*GetSceneTransitionListResponse, error)
- func (c *Client) GetTransitionKindList(paramss ...*GetTransitionKindListParams) (*GetTransitionKindListResponse, error)
- func (c *Client) SetCurrentSceneTransition(params *SetCurrentSceneTransitionParams) (*SetCurrentSceneTransitionResponse, error)
- func (c *Client) SetCurrentSceneTransitionDuration(params *SetCurrentSceneTransitionDurationParams) (*SetCurrentSceneTransitionDurationResponse, error)
- func (c *Client) SetCurrentSceneTransitionSettings(params *SetCurrentSceneTransitionSettingsParams) (*SetCurrentSceneTransitionSettingsResponse, error)
- func (c *Client) SetTBarPosition(params *SetTBarPositionParams) (*SetTBarPositionResponse, error)
- func (c *Client) TriggerStudioModeTransition(paramss ...*TriggerStudioModeTransitionParams) (*TriggerStudioModeTransitionResponse, error)
- type GetCurrentSceneTransitionCursorParams
- type GetCurrentSceneTransitionCursorResponse
- type GetCurrentSceneTransitionParams
- type GetCurrentSceneTransitionResponse
- type GetSceneTransitionListParams
- type GetSceneTransitionListResponse
- type GetTransitionKindListParams
- type GetTransitionKindListResponse
- type SetCurrentSceneTransitionDurationParams
- type SetCurrentSceneTransitionDurationResponse
- type SetCurrentSceneTransitionParams
- type SetCurrentSceneTransitionResponse
- type SetCurrentSceneTransitionSettingsParams
- type SetCurrentSceneTransitionSettingsResponse
- type SetTBarPositionParams
- type SetTBarPositionResponse
- type TriggerStudioModeTransitionParams
- type TriggerStudioModeTransitionResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client represents a client for 'transitions' requests.
func (*Client) GetCurrentSceneTransition ¶
func (c *Client) GetCurrentSceneTransition( paramss ...*GetCurrentSceneTransitionParams, ) (*GetCurrentSceneTransitionResponse, error)
Gets information about the current scene transition.
func (*Client) GetCurrentSceneTransitionCursor ¶
func (c *Client) GetCurrentSceneTransitionCursor( paramss ...*GetCurrentSceneTransitionCursorParams, ) (*GetCurrentSceneTransitionCursorResponse, error)
Gets the cursor position of the current scene transition.
Note: `transitionCursor` will return 1.0 when the transition is inactive.
func (*Client) GetSceneTransitionList ¶
func (c *Client) GetSceneTransitionList( paramss ...*GetSceneTransitionListParams, ) (*GetSceneTransitionListResponse, error)
Gets an array of all scene transitions in OBS.
func (*Client) GetTransitionKindList ¶
func (c *Client) GetTransitionKindList( paramss ...*GetTransitionKindListParams, ) (*GetTransitionKindListResponse, error)
Gets an array of all available transition kinds.
Similar to `GetInputKindList`
func (*Client) SetCurrentSceneTransition ¶
func (c *Client) SetCurrentSceneTransition( params *SetCurrentSceneTransitionParams, ) (*SetCurrentSceneTransitionResponse, error)
Sets the current scene transition.
Small note: While the namespace of scene transitions is generally unique, that uniqueness is not a guarantee as it is with other resources like inputs.
func (*Client) SetCurrentSceneTransitionDuration ¶
func (c *Client) SetCurrentSceneTransitionDuration( params *SetCurrentSceneTransitionDurationParams, ) (*SetCurrentSceneTransitionDurationResponse, error)
Sets the duration of the current scene transition, if it is not fixed.
func (*Client) SetCurrentSceneTransitionSettings ¶
func (c *Client) SetCurrentSceneTransitionSettings( params *SetCurrentSceneTransitionSettingsParams, ) (*SetCurrentSceneTransitionSettingsResponse, error)
Sets the settings of the current scene transition.
func (*Client) SetTBarPosition ¶
func (c *Client) SetTBarPosition(params *SetTBarPositionParams) (*SetTBarPositionResponse, error)
Sets the position of the TBar.
**Very important note**: This will be deprecated and replaced in a future version of obs-websocket.
func (*Client) TriggerStudioModeTransition ¶
func (c *Client) TriggerStudioModeTransition( paramss ...*TriggerStudioModeTransitionParams, ) (*TriggerStudioModeTransitionResponse, error)
Triggers the current scene transition. Same functionality as the `Transition` button in studio mode.
type GetCurrentSceneTransitionCursorParams ¶
type GetCurrentSceneTransitionCursorParams struct{}
Represents the request body for the GetCurrentSceneTransitionCursor request.
func (*GetCurrentSceneTransitionCursorParams) GetRequestName ¶
func (o *GetCurrentSceneTransitionCursorParams) GetRequestName() string
Returns the associated request.
type GetCurrentSceneTransitionCursorResponse ¶
type GetCurrentSceneTransitionCursorResponse struct {
// Cursor position, between 0.0 and 1.0
TransitionCursor float64 `json:"transitionCursor,omitempty"`
}
Represents the response body for the GetCurrentSceneTransitionCursor request.
type GetCurrentSceneTransitionParams ¶
type GetCurrentSceneTransitionParams struct{}
Represents the request body for the GetCurrentSceneTransition request.
func (*GetCurrentSceneTransitionParams) GetRequestName ¶
func (o *GetCurrentSceneTransitionParams) GetRequestName() string
Returns the associated request.
type GetCurrentSceneTransitionResponse ¶
type GetCurrentSceneTransitionResponse struct {
// Whether the transition supports being configured
TransitionConfigurable bool `json:"transitionConfigurable,omitempty"`
// Configured transition duration in milliseconds. `null` if transition is fixed
TransitionDuration float64 `json:"transitionDuration,omitempty"`
// Whether the transition uses a fixed (unconfigurable) duration
TransitionFixed bool `json:"transitionFixed,omitempty"`
// Kind of the transition
TransitionKind string `json:"transitionKind,omitempty"`
// Name of the transition
TransitionName string `json:"transitionName,omitempty"`
// Object of settings for the transition. `null` if transition is not configurable
TransitionSettings map[string]interface{} `json:"transitionSettings,omitempty"`
}
Represents the response body for the GetCurrentSceneTransition request.
type GetSceneTransitionListParams ¶
type GetSceneTransitionListParams struct{}
Represents the request body for the GetSceneTransitionList request.
func (*GetSceneTransitionListParams) GetRequestName ¶
func (o *GetSceneTransitionListParams) GetRequestName() string
Returns the associated request.
type GetSceneTransitionListResponse ¶
type GetSceneTransitionListResponse struct {
// Kind of the current scene transition. Can be null
CurrentSceneTransitionKind string `json:"currentSceneTransitionKind,omitempty"`
// Name of the current scene transition. Can be null
CurrentSceneTransitionName string `json:"currentSceneTransitionName,omitempty"`
Transitions []*typedefs.Transition `json:"transitions,omitempty"`
}
Represents the response body for the GetSceneTransitionList request.
type GetTransitionKindListParams ¶
type GetTransitionKindListParams struct{}
Represents the request body for the GetTransitionKindList request.
func (*GetTransitionKindListParams) GetRequestName ¶
func (o *GetTransitionKindListParams) GetRequestName() string
Returns the associated request.
type GetTransitionKindListResponse ¶
type GetTransitionKindListResponse struct {
// Array of transition kinds
TransitionKinds []string `json:"transitionKinds,omitempty"`
}
Represents the response body for the GetTransitionKindList request.
type SetCurrentSceneTransitionDurationParams ¶
type SetCurrentSceneTransitionDurationParams struct {
// Duration in milliseconds
TransitionDuration float64 `json:"transitionDuration,omitempty"`
}
Represents the request body for the SetCurrentSceneTransitionDuration request.
func (*SetCurrentSceneTransitionDurationParams) GetRequestName ¶
func (o *SetCurrentSceneTransitionDurationParams) GetRequestName() string
Returns the associated request.
type SetCurrentSceneTransitionDurationResponse ¶
type SetCurrentSceneTransitionDurationResponse struct{}
Represents the response body for the SetCurrentSceneTransitionDuration request.
type SetCurrentSceneTransitionParams ¶
type SetCurrentSceneTransitionParams struct {
// Name of the transition to make active
TransitionName string `json:"transitionName,omitempty"`
}
Represents the request body for the SetCurrentSceneTransition request.
func (*SetCurrentSceneTransitionParams) GetRequestName ¶
func (o *SetCurrentSceneTransitionParams) GetRequestName() string
Returns the associated request.
type SetCurrentSceneTransitionResponse ¶
type SetCurrentSceneTransitionResponse struct{}
Represents the response body for the SetCurrentSceneTransition request.
type SetCurrentSceneTransitionSettingsParams ¶
type SetCurrentSceneTransitionSettingsParams struct {
// Whether to overlay over the current settings or replace them
Overlay *bool `json:"overlay,omitempty"`
// Settings object to apply to the transition. Can be `{}`
TransitionSettings map[string]interface{} `json:"transitionSettings,omitempty"`
}
Represents the request body for the SetCurrentSceneTransitionSettings request.
func (*SetCurrentSceneTransitionSettingsParams) GetRequestName ¶
func (o *SetCurrentSceneTransitionSettingsParams) GetRequestName() string
Returns the associated request.
type SetCurrentSceneTransitionSettingsResponse ¶
type SetCurrentSceneTransitionSettingsResponse struct{}
Represents the response body for the SetCurrentSceneTransitionSettings request.
type SetTBarPositionParams ¶
type SetTBarPositionParams struct {
// New position
Position float64 `json:"position,omitempty"`
// Whether to release the TBar. Only set `false` if you know that you will be sending another position update
Release *bool `json:"release,omitempty"`
}
Represents the request body for the SetTBarPosition request.
func (*SetTBarPositionParams) GetRequestName ¶
func (o *SetTBarPositionParams) GetRequestName() string
Returns the associated request.
type SetTBarPositionResponse ¶
type SetTBarPositionResponse struct{}
Represents the response body for the SetTBarPosition request.
type TriggerStudioModeTransitionParams ¶
type TriggerStudioModeTransitionParams struct{}
Represents the request body for the TriggerStudioModeTransition request.
func (*TriggerStudioModeTransitionParams) GetRequestName ¶
func (o *TriggerStudioModeTransitionParams) GetRequestName() string
Returns the associated request.
type TriggerStudioModeTransitionResponse ¶
type TriggerStudioModeTransitionResponse struct{}
Represents the response body for the TriggerStudioModeTransition request.
Source Files
¶
- xx_generated.getcurrentscenetransition.go
- xx_generated.getcurrentscenetransitioncursor.go
- xx_generated.getscenetransitionlist.go
- xx_generated.gettransitionkindlist.go
- xx_generated.setcurrentscenetransition.go
- xx_generated.setcurrentscenetransitionduration.go
- xx_generated.setcurrentscenetransitionsettings.go
- xx_generated.settbarposition.go
- xx_generated.triggerstudiomodetransition.go
- zz_generated.client.go