transitions

package
v0.8.1 Latest Latest
Warning

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

 Go to latest Published: Feb 13, 2022 License: Apache-2.0 Imports: 1 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 {
	*requests.Client
}

Client represents a client for 'transitions' requests.

func (*Client) GetCurrentTransition 

func (c *Client) GetCurrentTransition(paramss ...*GetCurrentTransitionParams) (*GetCurrentTransitionResponse, error)

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

func (*Client) GetTransitionDuration 

func (c *Client) GetTransitionDuration(
	paramss ...*GetTransitionDurationParams,
) (*GetTransitionDurationResponse, error)

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

func (*Client) GetTransitionList 

func (c *Client) GetTransitionList(paramss ...*GetTransitionListParams) (*GetTransitionListResponse, error)

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

func (*Client) GetTransitionPosition added in v0.4.0 

func (c *Client) GetTransitionPosition(
	paramss ...*GetTransitionPositionParams,
) (*GetTransitionPositionResponse, error)

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

func (*Client) GetTransitionSettings added in v0.5.0 

func (c *Client) GetTransitionSettings(params *GetTransitionSettingsParams) (*GetTransitionSettingsResponse, error)

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

func (*Client) ReleaseTBar added in v0.5.0 

func (c *Client) ReleaseTBar(paramss ...*ReleaseTBarParams) (*ReleaseTBarResponse, error)

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

func (*Client) SetCurrentTransition 

func (c *Client) SetCurrentTransition(params *SetCurrentTransitionParams) (*SetCurrentTransitionResponse, error)

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

func (*Client) SetTBarPosition added in v0.5.0 

func (c *Client) SetTBarPosition(params *SetTBarPositionParams) (*SetTBarPositionResponse, error)

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

func (*Client) SetTransitionDuration 

func (c *Client) SetTransitionDuration(params *SetTransitionDurationParams) (*SetTransitionDurationResponse, error)

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

func (*Client) SetTransitionSettings added in v0.5.0 

func (c *Client) SetTransitionSettings(params *SetTransitionSettingsParams) (*SetTransitionSettingsResponse, error)

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

type GetCurrentTransitionParams 

type GetCurrentTransitionParams struct {
	requests.ParamsBasic
}

GetCurrentTransitionParams represents the params body for the "GetCurrentTransition" request. Get the name of the currently selected transition in the frontend's dropdown menu. Since 0.3.

func (*GetCurrentTransitionParams) GetSelfName added in v0.5.0 

func (o *GetCurrentTransitionParams) GetSelfName() string

GetSelfName just returns "GetCurrentTransition".

type GetCurrentTransitionResponse 

type GetCurrentTransitionResponse struct {
	requests.ResponseBasic

	// Transition duration (in milliseconds) if supported by the transition.
	Duration int `json:"duration,omitempty"`

	// Name of the selected transition.
	Name string `json:"name,omitempty"`
}

GetCurrentTransitionResponse represents the response body for the "GetCurrentTransition" request. Get the name of the currently selected transition in the frontend's dropdown menu. Since v0.3.

type GetTransitionDurationParams 

type GetTransitionDurationParams struct {
	requests.ParamsBasic
}

GetTransitionDurationParams represents the params body for the "GetTransitionDuration" request. Get the duration of the currently selected transition if supported. Since 4.1.0.

func (*GetTransitionDurationParams) GetSelfName added in v0.5.0 

func (o *GetTransitionDurationParams) GetSelfName() string

GetSelfName just returns "GetTransitionDuration".

type GetTransitionDurationResponse 

type GetTransitionDurationResponse struct {
	requests.ResponseBasic

	// Duration of the current transition (in milliseconds).
	TransitionDuration int `json:"transition-duration,omitempty"`
}

GetTransitionDurationResponse represents the response body for the "GetTransitionDuration" request. Get the duration of the currently selected transition if supported. Since v4.1.0.

type GetTransitionListParams 

type GetTransitionListParams struct {
	requests.ParamsBasic
}

GetTransitionListParams represents the params body for the "GetTransitionList" request. List of all transitions available in the frontend's dropdown menu. Since 4.1.0.

func (*GetTransitionListParams) GetSelfName added in v0.5.0 

func (o *GetTransitionListParams) GetSelfName() string

GetSelfName just returns "GetTransitionList".

type GetTransitionListResponse 

type GetTransitionListResponse struct {
	requests.ResponseBasic

	// Name of the currently active transition.
	CurrentTransition string `json:"current-transition,omitempty"`

	Transitions []*Transition `json:"transitions,omitempty"`
}

GetTransitionListResponse represents the response body for the "GetTransitionList" request. List of all transitions available in the frontend's dropdown menu. Since v4.1.0.

type GetTransitionPositionParams added in v0.4.0 

type GetTransitionPositionParams struct {
	requests.ParamsBasic
}

GetTransitionPositionParams represents the params body for the "GetTransitionPosition" request. Get the position of the current transition. Since 4.9.0.

func (*GetTransitionPositionParams) GetSelfName added in v0.5.0 

func (o *GetTransitionPositionParams) GetSelfName() string

GetSelfName just returns "GetTransitionPosition".

type GetTransitionPositionResponse added in v0.4.0 

type GetTransitionPositionResponse struct {
	requests.ResponseBasic

	// current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not
	// active.
	Position float64 `json:"position,omitempty"`
}

GetTransitionPositionResponse represents the response body for the "GetTransitionPosition" request. Get the position of the current transition. Since v4.9.0.

type GetTransitionSettingsParams added in v0.5.0 

type GetTransitionSettingsParams struct {
	requests.ParamsBasic

	// Transition name
	TransitionName string `json:"transitionName,omitempty"`
}

GetTransitionSettingsParams represents the params body for the "GetTransitionSettings" request. Get the current settings of a transition Since 4.9.0.

func (*GetTransitionSettingsParams) GetSelfName added in v0.5.0 

func (o *GetTransitionSettingsParams) GetSelfName() string

GetSelfName just returns "GetTransitionSettings".

type GetTransitionSettingsResponse added in v0.5.0 

type GetTransitionSettingsResponse struct {
	requests.ResponseBasic

	// Current transition settings
	TransitionSettings map[string]interface{} `json:"transitionSettings,omitempty"`
}

GetTransitionSettingsResponse represents the response body for the "GetTransitionSettings" request. Get the current settings of a transition Since v4.9.0.

type ReleaseTBarParams added in v0.5.0 

type ReleaseTBarParams struct {
	requests.ParamsBasic
}

ReleaseTBarParams represents the params body for the "ReleaseTBar" request. Release the T-Bar (like a user releasing their mouse button after moving it). *YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.* Since 4.9.0.

func (*ReleaseTBarParams) GetSelfName added in v0.5.0 

func (o *ReleaseTBarParams) GetSelfName() string

GetSelfName just returns "ReleaseTBar".

type ReleaseTBarResponse added in v0.5.0 

type ReleaseTBarResponse struct {
	requests.ResponseBasic
}

ReleaseTBarResponse represents the response body for the "ReleaseTBar" request. Release the T-Bar (like a user releasing their mouse button after moving it). *YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.* Since v4.9.0.

type SetCurrentTransitionParams 

type SetCurrentTransitionParams struct {
	requests.ParamsBasic

	// The name of the transition.
	TransitionName string `json:"transition-name,omitempty"`
}

SetCurrentTransitionParams represents the params body for the "SetCurrentTransition" request. Set the active transition. Since 0.3.

func (*SetCurrentTransitionParams) GetSelfName added in v0.5.0 

func (o *SetCurrentTransitionParams) GetSelfName() string

GetSelfName just returns "SetCurrentTransition".

type SetCurrentTransitionResponse 

type SetCurrentTransitionResponse struct {
	requests.ResponseBasic
}

SetCurrentTransitionResponse represents the response body for the "SetCurrentTransition" request. Set the active transition. Since v0.3.

type SetTBarPositionParams added in v0.5.0 

type SetTBarPositionParams struct {
	requests.ParamsBasic

	// T-Bar position. This value must be between 0.0 and 1.0.
	Position float64 `json:"position,omitempty"`

	// Whether or not the T-Bar gets released automatically after setting its new position (like a user releasing their
	// mouse button after moving the T-Bar). Call `ReleaseTBar` manually if you set `release` to false. Defaults to
	// true.
	Release *bool `json:"release,omitempty"`
}

SetTBarPositionParams represents the params body for the "SetTBarPosition" request. Set the manual position of the T-Bar (in Studio Mode) to the specified value. Will return an error if OBS is not in studio mode or if the current transition doesn't support T-Bar control.

If your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over. Since 4.9.0.

func (*SetTBarPositionParams) GetSelfName added in v0.5.0 

func (o *SetTBarPositionParams) GetSelfName() string

GetSelfName just returns "SetTBarPosition".

type SetTBarPositionResponse added in v0.5.0 

type SetTBarPositionResponse struct {
	requests.ResponseBasic
}

SetTBarPositionResponse represents the response body for the "SetTBarPosition" request. Set the manual position of the T-Bar (in Studio Mode) to the specified value. Will return an error if OBS is not in studio mode or if the current transition doesn't support T-Bar control.

If your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over. Since v4.9.0.

type SetTransitionDurationParams 

type SetTransitionDurationParams struct {
	requests.ParamsBasic

	// Desired duration of the transition (in milliseconds).
	Duration int `json:"duration,omitempty"`
}

SetTransitionDurationParams represents the params body for the "SetTransitionDuration" request. Set the duration of the currently selected transition if supported. Since 4.0.0.

func (*SetTransitionDurationParams) GetSelfName added in v0.5.0 

func (o *SetTransitionDurationParams) GetSelfName() string

GetSelfName just returns "SetTransitionDuration".

type SetTransitionDurationResponse 

type SetTransitionDurationResponse struct {
	requests.ResponseBasic
}

SetTransitionDurationResponse represents the response body for the "SetTransitionDuration" request. Set the duration of the currently selected transition if supported. Since v4.0.0.

type SetTransitionSettingsParams added in v0.5.0 

type SetTransitionSettingsParams struct {
	requests.ParamsBasic

	// Transition name
	TransitionName string `json:"transitionName,omitempty"`

	// Transition settings (they can be partial)
	TransitionSettings map[string]interface{} `json:"transitionSettings,omitempty"`
}

SetTransitionSettingsParams represents the params body for the "SetTransitionSettings" request. Change the current settings of a transition Since 4.9.0.

func (*SetTransitionSettingsParams) GetSelfName added in v0.5.0 

func (o *SetTransitionSettingsParams) GetSelfName() string

GetSelfName just returns "SetTransitionSettings".

type SetTransitionSettingsResponse added in v0.5.0 

type SetTransitionSettingsResponse struct {
	requests.ResponseBasic

	// Updated transition settings
	TransitionSettings map[string]interface{} `json:"transitionSettings,omitempty"`
}

SetTransitionSettingsResponse represents the response body for the "SetTransitionSettings" request. Change the current settings of a transition Since v4.9.0.

type Transition added in v0.6.0 

type Transition struct {
	// Name of the transition.
	Name string `json:"name,omitempty"`
}

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.