transitions

Documentation

Index

• type Client
  • func (c *Client) GetCurrentTransition(paramss ...*GetCurrentTransitionParams) (*GetCurrentTransitionResponse, error)
  • func (c *Client) GetTransitionDuration(paramss ...*GetTransitionDurationParams) (*GetTransitionDurationResponse, error)
  • func (c *Client) GetTransitionList(paramss ...*GetTransitionListParams) (*GetTransitionListResponse, error)
  • func (c *Client) SetCurrentTransition(params *SetCurrentTransitionParams) (*SetCurrentTransitionResponse, error)
  • func (c *Client) SetTransitionDuration(params *SetTransitionDurationParams) (*SetTransitionDurationResponse, error)
• type GetCurrentTransitionParams
  • func (o *GetCurrentTransitionParams) Name() string
• type GetCurrentTransitionResponse
• type GetTransitionDurationParams
  • func (o *GetTransitionDurationParams) Name() string
• type GetTransitionDurationResponse
• type GetTransitionListParams
  • func (o *GetTransitionListParams) Name() string
• type GetTransitionListResponse
• type SetCurrentTransitionParams
  • func (o *SetCurrentTransitionParams) Name() string
• type SetCurrentTransitionResponse
• type SetTransitionDurationParams
  • func (o *SetTransitionDurationParams) Name() string
• type SetTransitionDurationResponse

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) SetCurrentTransition

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

SetCurrentTransition 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.

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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetCurrentTransition.

func (*GetCurrentTransitionParams) Name

func (o *GetCurrentTransitionParams) Name() string

Name just returns "GetCurrentTransition".

type GetCurrentTransitionResponse

type GetCurrentTransitionResponse struct {
	requests.ResponseBasic

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

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetCurrentTransition.

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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetTransitionDuration.

func (*GetTransitionDurationParams) Name

func (o *GetTransitionDurationParams) Name() string

Name just returns "GetTransitionDuration".

type GetTransitionDurationResponse

type GetTransitionDurationResponse struct {
	requests.ResponseBasic

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetTransitionDuration.

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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetTransitionList.

func (*GetTransitionListParams) Name

func (o *GetTransitionListParams) Name() string

Name just returns "GetTransitionList".

type GetTransitionListResponse

type GetTransitionListResponse struct {
	requests.ResponseBasic

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

	Transitions []struct {
		// Name of the transition.
		Name string `json:"name"`
	} `json:"transitions"`
}

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#GetTransitionList.

type SetCurrentTransitionParams

type SetCurrentTransitionParams struct {
	requests.ParamsBasic

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#SetCurrentTransition.

func (*SetCurrentTransitionParams) Name

func (o *SetCurrentTransitionParams) Name() string

Name just returns "SetCurrentTransition".

type SetCurrentTransitionResponse

type SetCurrentTransitionResponse struct {
	requests.ResponseBasic
}

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#SetCurrentTransition.

type SetTransitionDurationParams

type SetTransitionDurationParams struct {
	requests.ParamsBasic

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

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

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#SetTransitionDuration.

func (*SetTransitionDurationParams) Name

func (o *SetTransitionDurationParams) Name() string

Name 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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.5.0/docs/generated/protocol.md#SetTransitionDuration.