studiomode

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: 2 Imported by: 0

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 'studio mode' requests.

func (*Client) DisableStudioMode 

func (c *Client) DisableStudioMode(paramss ...*DisableStudioModeParams) (*DisableStudioModeResponse, error)

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

func (*Client) EnableStudioMode 

func (c *Client) EnableStudioMode(paramss ...*EnableStudioModeParams) (*EnableStudioModeResponse, error)

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

func (*Client) GetPreviewScene 

func (c *Client) GetPreviewScene(paramss ...*GetPreviewSceneParams) (*GetPreviewSceneResponse, error)

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

func (*Client) GetStudioModeStatus 

func (c *Client) GetStudioModeStatus(paramss ...*GetStudioModeStatusParams) (*GetStudioModeStatusResponse, error)

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

func (*Client) SetPreviewScene 

func (c *Client) SetPreviewScene(params *SetPreviewSceneParams) (*SetPreviewSceneResponse, error)

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

func (*Client) ToggleStudioMode 

func (c *Client) ToggleStudioMode(paramss ...*ToggleStudioModeParams) (*ToggleStudioModeResponse, error)

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

func (*Client) TransitionToProgram 

func (c *Client) TransitionToProgram(params *TransitionToProgramParams) (*TransitionToProgramResponse, error)

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

type DisableStudioModeParams 

type DisableStudioModeParams struct {
	requests.ParamsBasic
}

DisableStudioModeParams represents the params body for the "DisableStudioMode" request. Disables Studio Mode. Since 4.1.0.

func (*DisableStudioModeParams) GetSelfName added in v0.5.0 

func (o *DisableStudioModeParams) GetSelfName() string

GetSelfName just returns "DisableStudioMode".

type DisableStudioModeResponse 

type DisableStudioModeResponse struct {
	requests.ResponseBasic
}

DisableStudioModeResponse represents the response body for the "DisableStudioMode" request. Disables Studio Mode. Since v4.1.0.

type EnableStudioModeParams 

type EnableStudioModeParams struct {
	requests.ParamsBasic
}

EnableStudioModeParams represents the params body for the "EnableStudioMode" request. Enables Studio Mode. Since 4.1.0.

func (*EnableStudioModeParams) GetSelfName added in v0.5.0 

func (o *EnableStudioModeParams) GetSelfName() string

GetSelfName just returns "EnableStudioMode".

type EnableStudioModeResponse 

type EnableStudioModeResponse struct {
	requests.ResponseBasic
}

EnableStudioModeResponse represents the response body for the "EnableStudioMode" request. Enables Studio Mode. Since v4.1.0.

type GetPreviewSceneParams 

type GetPreviewSceneParams struct {
	requests.ParamsBasic
}

GetPreviewSceneParams represents the params body for the "GetPreviewScene" request. Get the name of the currently previewed scene and its list of sources. Will return an `error` if Studio Mode is not enabled. Since 4.1.0.

func (*GetPreviewSceneParams) GetSelfName added in v0.5.0 

func (o *GetPreviewSceneParams) GetSelfName() string

GetSelfName just returns "GetPreviewScene".

type GetPreviewSceneResponse 

type GetPreviewSceneResponse struct {
	requests.ResponseBasic

	// The name of the active preview scene.
	Name string `json:"name,omitempty"`

	Sources []typedefs.SceneItem `json:"sources,omitempty"`
}

GetPreviewSceneResponse represents the response body for the "GetPreviewScene" request. Get the name of the currently previewed scene and its list of sources. Will return an `error` if Studio Mode is not enabled. Since v4.1.0.

type GetStudioModeStatusParams 

type GetStudioModeStatusParams struct {
	requests.ParamsBasic
}

GetStudioModeStatusParams represents the params body for the "GetStudioModeStatus" request. Indicates if Studio Mode is currently enabled. Since 4.1.0.

func (*GetStudioModeStatusParams) GetSelfName added in v0.5.0 

func (o *GetStudioModeStatusParams) GetSelfName() string

GetSelfName just returns "GetStudioModeStatus".

type GetStudioModeStatusResponse 

type GetStudioModeStatusResponse struct {
	requests.ResponseBasic

	// Indicates if Studio Mode is enabled.
	StudioMode bool `json:"studio-mode,omitempty"`
}

GetStudioModeStatusResponse represents the response body for the "GetStudioModeStatus" request. Indicates if Studio Mode is currently enabled. Since v4.1.0.

type SetPreviewSceneParams 

type SetPreviewSceneParams struct {
	requests.ParamsBasic

	// The name of the scene to preview.
	SceneName string `json:"scene-name,omitempty"`
}

SetPreviewSceneParams represents the params body for the "SetPreviewScene" request. Set the active preview scene. Will return an `error` if Studio Mode is not enabled. Since 4.1.0.

func (*SetPreviewSceneParams) GetSelfName added in v0.5.0 

func (o *SetPreviewSceneParams) GetSelfName() string

GetSelfName just returns "SetPreviewScene".

type SetPreviewSceneResponse 

type SetPreviewSceneResponse struct {
	requests.ResponseBasic
}

SetPreviewSceneResponse represents the response body for the "SetPreviewScene" request. Set the active preview scene. Will return an `error` if Studio Mode is not enabled. Since v4.1.0.

type ToggleStudioModeParams 

type ToggleStudioModeParams struct {
	requests.ParamsBasic
}

ToggleStudioModeParams represents the params body for the "ToggleStudioMode" request. Toggles Studio Mode (depending on the current state of studio mode). Since 4.1.0.

func (*ToggleStudioModeParams) GetSelfName added in v0.5.0 

func (o *ToggleStudioModeParams) GetSelfName() string

GetSelfName just returns "ToggleStudioMode".

type ToggleStudioModeResponse 

type ToggleStudioModeResponse struct {
	requests.ResponseBasic
}

ToggleStudioModeResponse represents the response body for the "ToggleStudioMode" request. Toggles Studio Mode (depending on the current state of studio mode). Since v4.1.0.

type TransitionToProgramParams 

type TransitionToProgramParams struct {
	requests.ParamsBasic

	WithTransition *WithTransition `json:"with-transition,omitempty"`
}

TransitionToProgramParams represents the params body for the "TransitionToProgram" request. Transitions the currently previewed scene to the main output. Will return an `error` if Studio Mode is not enabled. Since 4.1.0.

func (*TransitionToProgramParams) GetSelfName added in v0.5.0 

func (o *TransitionToProgramParams) GetSelfName() string

GetSelfName just returns "TransitionToProgram".

type TransitionToProgramResponse 

type TransitionToProgramResponse struct {
	requests.ResponseBasic
}

TransitionToProgramResponse represents the response body for the "TransitionToProgram" request. Transitions the currently previewed scene to the main output. Will return an `error` if Studio Mode is not enabled. Since v4.1.0.

type WithTransition added in v0.6.0 

type WithTransition struct {
	// Transition duration (in milliseconds).
	Duration int `json:"duration,omitempty"`

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