transitions

package
v1.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 22, 2024 License: Apache-2.0 Imports: 2 Imported by: 3

Documentation

Index

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 'transitions' requests.

func NewClient added in v1.0.0 

func NewClient(c *api.Client) *Client

NewTransitions returns a new 'transitions' client.

func (*Client) GetCurrentSceneTransition added in v0.9.0 

func (c *Client) GetCurrentSceneTransition(
	paramss ...*GetCurrentSceneTransitionParams,
) (*GetCurrentSceneTransitionResponse, error)

Gets information about the current scene transition.

func (*Client) GetCurrentSceneTransitionCursor added in v0.9.0 

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 added in v0.9.0 

func (c *Client) GetSceneTransitionList(
	paramss ...*GetSceneTransitionListParams,
) (*GetSceneTransitionListResponse, error)

Gets an array of all scene transitions in OBS.

func (*Client) GetTransitionKindList added in v0.9.0 

func (c *Client) GetTransitionKindList(
	paramss ...*GetTransitionKindListParams,
) (*GetTransitionKindListResponse, error)

Gets an array of all available transition kinds.

Similar to `GetInputKindList`

func (*Client) SetCurrentSceneTransition added in v0.9.0 

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 added in v0.9.0 

func (c *Client) SetCurrentSceneTransitionDuration(
	params *SetCurrentSceneTransitionDurationParams,
) (*SetCurrentSceneTransitionDurationResponse, error)

Sets the duration of the current scene transition, if it is not fixed.

func (*Client) SetCurrentSceneTransitionSettings added in v0.9.0 

func (c *Client) SetCurrentSceneTransitionSettings(
	params *SetCurrentSceneTransitionSettingsParams,
) (*SetCurrentSceneTransitionSettingsResponse, error)

Sets the settings of the current scene transition.

func (*Client) SetTBarPosition added in v0.5.0 

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 added in v0.9.0 

func (c *Client) TriggerStudioModeTransition(
	paramss ...*TriggerStudioModeTransitionParams,
) (*TriggerStudioModeTransitionResponse, error)

Triggers the current scene transition. Same functionality as the `Transition` button in studio mode.

type GetCurrentSceneTransitionCursorParams added in v0.9.0 

type GetCurrentSceneTransitionCursorParams struct{}

Represents the request body for the GetCurrentSceneTransitionCursor request.

func (*GetCurrentSceneTransitionCursorParams) GetRequestName added in v0.9.0 

func (o *GetCurrentSceneTransitionCursorParams) GetRequestName() string

Returns the associated request.

type GetCurrentSceneTransitionCursorResponse added in v0.9.0 

type GetCurrentSceneTransitionCursorResponse struct {

	// Cursor position, between 0.0 and 1.0
	TransitionCursor float64 `json:"transitionCursor,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetCurrentSceneTransitionCursor request.

type GetCurrentSceneTransitionParams added in v0.9.0 

type GetCurrentSceneTransitionParams struct{}

Represents the request body for the GetCurrentSceneTransition request.

func (*GetCurrentSceneTransitionParams) GetRequestName added in v0.9.0 

func (o *GetCurrentSceneTransitionParams) GetRequestName() string

Returns the associated request.

type GetCurrentSceneTransitionResponse added in v0.9.0 

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]any `json:"transitionSettings,omitempty"`

	// UUID of the transition
	TransitionUuid string `json:"transitionUuid,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetCurrentSceneTransition request.

type GetSceneTransitionListParams added in v0.9.0 

type GetSceneTransitionListParams struct{}

Represents the request body for the GetSceneTransitionList request.

func (*GetSceneTransitionListParams) GetRequestName added in v0.9.0 

func (o *GetSceneTransitionListParams) GetRequestName() string

Returns the associated request.

type GetSceneTransitionListResponse added in v0.9.0 

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"`

	// UUID of the current scene transition. Can be null
	CurrentSceneTransitionUuid string `json:"currentSceneTransitionUuid,omitempty"`

	// Array of transitions
	Transitions []*typedefs.Transition `json:"transitions,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetSceneTransitionList request.

type GetTransitionKindListParams added in v0.9.0 

type GetTransitionKindListParams struct{}

Represents the request body for the GetTransitionKindList request.

func (*GetTransitionKindListParams) GetRequestName added in v0.9.0 

func (o *GetTransitionKindListParams) GetRequestName() string

Returns the associated request.

type GetTransitionKindListResponse added in v0.9.0 

type GetTransitionKindListResponse struct {

	// Array of transition kinds
	TransitionKinds []string `json:"transitionKinds,omitempty"`
	// contains filtered or unexported fields
}

Represents the response body for the GetTransitionKindList request.

type SetCurrentSceneTransitionDurationParams added in v0.9.0 

type SetCurrentSceneTransitionDurationParams struct {
	// Duration in milliseconds
	TransitionDuration *float64 `json:"transitionDuration,omitempty"`
}

Represents the request body for the SetCurrentSceneTransitionDuration request.

func NewSetCurrentSceneTransitionDurationParams added in v1.0.0 

func NewSetCurrentSceneTransitionDurationParams() *SetCurrentSceneTransitionDurationParams

func (*SetCurrentSceneTransitionDurationParams) GetRequestName added in v0.9.0 

func (o *SetCurrentSceneTransitionDurationParams) GetRequestName() string

Returns the associated request.

func (*SetCurrentSceneTransitionDurationParams) WithTransitionDuration added in v1.0.0 

func (o *SetCurrentSceneTransitionDurationParams) WithTransitionDuration(
	x float64,
) *SetCurrentSceneTransitionDurationParams

type SetCurrentSceneTransitionDurationResponse added in v0.9.0 

type SetCurrentSceneTransitionDurationResponse struct {
	// contains filtered or unexported fields
}

Represents the response body for the SetCurrentSceneTransitionDuration request.

type SetCurrentSceneTransitionParams added in v0.9.0 

type SetCurrentSceneTransitionParams struct {
	// Name of the transition to make active
	TransitionName *string `json:"transitionName,omitempty"`
}

Represents the request body for the SetCurrentSceneTransition request.

func NewSetCurrentSceneTransitionParams added in v1.0.0 

func NewSetCurrentSceneTransitionParams() *SetCurrentSceneTransitionParams

func (*SetCurrentSceneTransitionParams) GetRequestName added in v0.9.0 

func (o *SetCurrentSceneTransitionParams) GetRequestName() string

Returns the associated request.

func (*SetCurrentSceneTransitionParams) WithTransitionName added in v1.0.0 

func (o *SetCurrentSceneTransitionParams) WithTransitionName(x string) *SetCurrentSceneTransitionParams

type SetCurrentSceneTransitionResponse added in v0.9.0 

type SetCurrentSceneTransitionResponse struct {
	// contains filtered or unexported fields
}

Represents the response body for the SetCurrentSceneTransition request.

type SetCurrentSceneTransitionSettingsParams added in v0.9.0 

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]any `json:"transitionSettings,omitempty"`
}

Represents the request body for the SetCurrentSceneTransitionSettings request.

func NewSetCurrentSceneTransitionSettingsParams added in v1.0.0 

func NewSetCurrentSceneTransitionSettingsParams() *SetCurrentSceneTransitionSettingsParams

func (*SetCurrentSceneTransitionSettingsParams) GetRequestName added in v0.9.0 

func (o *SetCurrentSceneTransitionSettingsParams) GetRequestName() string

Returns the associated request.

func (*SetCurrentSceneTransitionSettingsParams) WithOverlay added in v1.0.0 

func (o *SetCurrentSceneTransitionSettingsParams) WithOverlay(x bool) *SetCurrentSceneTransitionSettingsParams

func (*SetCurrentSceneTransitionSettingsParams) WithTransitionSettings added in v1.0.0 

func (o *SetCurrentSceneTransitionSettingsParams) WithTransitionSettings(
	x map[string]any,
) *SetCurrentSceneTransitionSettingsParams

type SetCurrentSceneTransitionSettingsResponse added in v0.9.0 

type SetCurrentSceneTransitionSettingsResponse struct {
	// contains filtered or unexported fields
}

Represents the response body for the SetCurrentSceneTransitionSettings request.

type SetTBarPositionParams added in v0.5.0 

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 NewSetTBarPositionParams added in v1.0.0 

func NewSetTBarPositionParams() *SetTBarPositionParams

func (*SetTBarPositionParams) GetRequestName added in v0.9.0 

func (o *SetTBarPositionParams) GetRequestName() string

Returns the associated request.

func (*SetTBarPositionParams) WithPosition added in v1.0.0 

func (o *SetTBarPositionParams) WithPosition(x float64) *SetTBarPositionParams

func (*SetTBarPositionParams) WithRelease added in v1.0.0 

func (o *SetTBarPositionParams) WithRelease(x bool) *SetTBarPositionParams

type SetTBarPositionResponse added in v0.5.0 

type SetTBarPositionResponse struct {
	// contains filtered or unexported fields
}

Represents the response body for the SetTBarPosition request.

type TriggerStudioModeTransitionParams added in v0.9.0 

type TriggerStudioModeTransitionParams struct{}

Represents the request body for the TriggerStudioModeTransition request.

func (*TriggerStudioModeTransitionParams) GetRequestName added in v0.9.0 

func (o *TriggerStudioModeTransitionParams) GetRequestName() string

Returns the associated request.

type TriggerStudioModeTransitionResponse added in v0.9.0 

type TriggerStudioModeTransitionResponse struct {
	// contains filtered or unexported fields
}

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