obsws

package module
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2020 License: MIT Imports: 11 Imported by: 0

README

obsws

Build Status GoDoc

obsws provides client functionality for obs-websocket. Currently, the target version is 4.4.

Installation

go get github.com/christopher-dG/go-obs-websocket

Usage

package main

import (
	"log"
	"time"

	"github.com/christopher-dG/go-obs-websocket"
)

func main() {
	// Connect a client.
	c := obsws.Client{Host: "localhost", Port: 4444}
	if err := c.Connect(); err != nil {
		log.Fatal(err)
	}
	defer c.Disconnect()

	// Send and receive a request asynchronously.
	req := obsws.NewGetStreamingStatusRequest()
	if err := req.Send(c); err != nil {
		log.Fatal(err)
	}
	// This will block until the response comes (potentially forever).
	resp, err := req.Receive()
	if err != nil {
		log.Fatal(err)
	}
	log.Println("streaming:", resp.Streaming)

	// Set the amount of time we can wait for a response.
	obsws.SetReceiveTimeout(time.Second * 2)

	// Send and receive a request synchronously.
	req = obsws.NewGetStreamingStatusRequest()
	// Note that we create a new request,
	// because requests have IDs that must be unique.
	// This will block for up to two seconds, since we set a timeout.
	resp, err = req.SendReceive(c)
	if err != nil {
		log.Fatal(err)
	}
	log.Println("streaming:", resp.Streaming)

	// Respond to events by registering handlers.
	c.AddEventHandler("SwitchScenes", func(e obsws.Event) {
		// Make sure to assert the actual event type.
		log.Println("new scene:", e.(obsws.SwitchScenesEvent).SceneName)
	})

	time.Sleep(time.Second * 10)
}

Documentation

Overview

Package obsws provides client functionality for obs-websocket.

Index

Constants

View Source 
const (
	// StatusOK indicates that the request was successful.
	StatusOK = "ok"
	// StatusError indicates that the request was unsuccessful.
	StatusError = "error"
)

Variables

View Source 
var (
	// ErrNotConnected is returned when a request is sent by a client which is not connected.
	ErrNotConnected = errors.New("not connected")
	// ErrReceiveTimeout is returned when a response takes too long to arrive.
	ErrReceiveTimeout = errors.New("receive timed out")
)
View Source 
var (
	// ErrNotSent is returned when you call Receive on a request that has not been sent.
	ErrNotSent = errors.New("request not yet sent")
	// ErrAlreadySent is returned when a request has already been sent.
	ErrAlreadySent = errors.New("request already sent")
)
View Source 
var ErrUnknownEventType = errors.New("unknown event type")

ErrUnknownEventType is returned when a handler is added for an unknown event.

View Source 
var Logger = log.New(os.Stdout, "[obsws] ", log.LstdFlags)

Functions

func SetReceiveTimeout 

func SetReceiveTimeout(timeout time.Duration)

SetReceiveTimeout sets the maximum blocking time for receiving request responses. If set to 0 (the default), there is no timeout.

Types

type AddFilterToSourceRequest 

type AddFilterToSourceRequest struct {
	// Name of the source on which the filter is added.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Name of the new filter.
	// Required: Yes.
	FilterName string `json:"filterName"`
	// Filter type.
	// Required: Yes.
	FilterType string `json:"filterType"`
	// Filter settings.
	// Required: Yes.
	FilterSettings map[string]interface{} `json:"filterSettings"`
	// contains filtered or unexported fields
}

AddFilterToSourceRequest : Add a new filter to a source Available source types along with their settings properties are available from `GetSourceTypesList`.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#addfiltertosource

func NewAddFilterToSourceRequest 

func NewAddFilterToSourceRequest(
	sourceName string,
	filterName string,
	filterType string,
	filterSettings map[string]interface{},
) AddFilterToSourceRequest

NewAddFilterToSourceRequest returns a new AddFilterToSourceRequest.

func (AddFilterToSourceRequest) ID 

func (r AddFilterToSourceRequest) ID() string

ID returns the request's message ID.

func (AddFilterToSourceRequest) Receive 

func (r AddFilterToSourceRequest) Receive() (AddFilterToSourceResponse, error)

Receive waits for the response.

func (*AddFilterToSourceRequest) Send 

func (r *AddFilterToSourceRequest) Send(c Client) error

Send sends the request.

func (AddFilterToSourceRequest) SendReceive 

func (r AddFilterToSourceRequest) SendReceive(c Client) (AddFilterToSourceResponse, error)

SendReceive sends the request then immediately waits for the response.

func (AddFilterToSourceRequest) Type 

func (r AddFilterToSourceRequest) Type() string

Type returns the request's message type.

type AddFilterToSourceResponse 

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

AddFilterToSourceResponse : Response for AddFilterToSourceRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#addfiltertosource

func (AddFilterToSourceResponse) Error 

func (r AddFilterToSourceResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (AddFilterToSourceResponse) ID 

func (r AddFilterToSourceResponse) ID() string

ID returns the response's message ID.

func (AddFilterToSourceResponse) Status 

func (r AddFilterToSourceResponse) Status() string

Status returns the response's status.

type AuthenticateRequest 

type AuthenticateRequest struct {
	// Response to the auth challenge (see "Authentication" for more information).
	// Required: Yes.
	Auth string `json:"auth"`
	// contains filtered or unexported fields
}

AuthenticateRequest : Attempt to authenticate the client to the server.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#authenticate

func NewAuthenticateRequest 

func NewAuthenticateRequest(auth string) AuthenticateRequest

NewAuthenticateRequest returns a new AuthenticateRequest.

func (AuthenticateRequest) ID 

func (r AuthenticateRequest) ID() string

ID returns the request's message ID.

func (AuthenticateRequest) Receive 

func (r AuthenticateRequest) Receive() (AuthenticateResponse, error)

Receive waits for the response.

func (*AuthenticateRequest) Send 

func (r *AuthenticateRequest) Send(c Client) error

Send sends the request.

func (AuthenticateRequest) SendReceive 

func (r AuthenticateRequest) SendReceive(c Client) (AuthenticateResponse, error)

SendReceive sends the request then immediately waits for the response.

func (AuthenticateRequest) Type 

func (r AuthenticateRequest) Type() string

Type returns the request's message type.

type AuthenticateResponse 

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

AuthenticateResponse : Response for AuthenticateRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#authenticate

func (AuthenticateResponse) Error 

func (r AuthenticateResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (AuthenticateResponse) ID 

func (r AuthenticateResponse) ID() string

ID returns the response's message ID.

func (AuthenticateResponse) Status 

func (r AuthenticateResponse) Status() string

Status returns the response's status.

type Client 

type Client struct {
	Host     string // Host (probably "localhost").
	Port     int    // Port (OBS default is 4444).
	Password string // Password (OBS default is "").
	// contains filtered or unexported fields
}

Client is the interface to obs-websocket. Client{Host: "localhost", Port: 4444} will probably work if you haven't configured OBS.

func (*Client) AddEventHandler 

func (c *Client) AddEventHandler(eventType string, handler func(Event)) error

AddEventHandler adds a handler function for a given event type.

func (*Client) Connect 

func (c *Client) Connect() error

Connect opens a WebSocket connection and authenticates if necessary.

func (Client) Connected 

func (c Client) Connected() bool

Connected returns wheter or not the client is connected.

func (*Client) Disconnect 

func (c *Client) Disconnect() error

Disconnect closes the WebSocket connection.

func (*Client) RemoveEventHandler 

func (c *Client) RemoveEventHandler(eventType string)

RemoveEventHandler removes the handler for a given event type.

type DisableStudioModeRequest 

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

DisableStudioModeRequest : Disables Studio Mode.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#disablestudiomode

func NewDisableStudioModeRequest 

func NewDisableStudioModeRequest() DisableStudioModeRequest

NewDisableStudioModeRequest returns a new DisableStudioModeRequest.

func (DisableStudioModeRequest) ID 

func (r DisableStudioModeRequest) ID() string

ID returns the request's message ID.

func (DisableStudioModeRequest) Receive 

func (r DisableStudioModeRequest) Receive() (DisableStudioModeResponse, error)

Receive waits for the response.

func (*DisableStudioModeRequest) Send 

func (r *DisableStudioModeRequest) Send(c Client) error

Send sends the request.

func (DisableStudioModeRequest) SendReceive 

func (r DisableStudioModeRequest) SendReceive(c Client) (DisableStudioModeResponse, error)

SendReceive sends the request then immediately waits for the response.

func (DisableStudioModeRequest) Type 

func (r DisableStudioModeRequest) Type() string

Type returns the request's message type.

type DisableStudioModeResponse 

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

DisableStudioModeResponse : Response for DisableStudioModeRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#disablestudiomode

func (DisableStudioModeResponse) Error 

func (r DisableStudioModeResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (DisableStudioModeResponse) ID 

func (r DisableStudioModeResponse) ID() string

ID returns the response's message ID.

func (DisableStudioModeResponse) Status 

func (r DisableStudioModeResponse) Status() string

Status returns the response's status.

type EnableStudioModeRequest 

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

EnableStudioModeRequest : Enables Studio Mode.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#enablestudiomode

func NewEnableStudioModeRequest 

func NewEnableStudioModeRequest() EnableStudioModeRequest

NewEnableStudioModeRequest returns a new EnableStudioModeRequest.

func (EnableStudioModeRequest) ID 

func (r EnableStudioModeRequest) ID() string

ID returns the request's message ID.

func (EnableStudioModeRequest) Receive 

func (r EnableStudioModeRequest) Receive() (EnableStudioModeResponse, error)

Receive waits for the response.

func (*EnableStudioModeRequest) Send 

func (r *EnableStudioModeRequest) Send(c Client) error

Send sends the request.

func (EnableStudioModeRequest) SendReceive 

func (r EnableStudioModeRequest) SendReceive(c Client) (EnableStudioModeResponse, error)

SendReceive sends the request then immediately waits for the response.

func (EnableStudioModeRequest) Type 

func (r EnableStudioModeRequest) Type() string

Type returns the request's message type.

type EnableStudioModeResponse 

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

EnableStudioModeResponse : Response for EnableStudioModeRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#enablestudiomode

func (EnableStudioModeResponse) Error 

func (r EnableStudioModeResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (EnableStudioModeResponse) ID 

func (r EnableStudioModeResponse) ID() string

ID returns the response's message ID.

func (EnableStudioModeResponse) Status 

func (r EnableStudioModeResponse) Status() string

Status returns the response's status.

type Event 

type Event interface {
	Type() string
	StreamTimecode() string
	RecTimecode() string
}

Event is broadcast by the server to each connected client when a recognized action occurs within OBS.

type ExitingEvent 

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

ExitingEvent : OBS is exiting.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#exiting

func (ExitingEvent) RecTimecode 

func (e ExitingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ExitingEvent) StreamTimecode 

func (e ExitingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ExitingEvent) Type 

func (e ExitingEvent) Type() string

Type returns the event's update type.

type GetAuthRequiredRequest 

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

GetAuthRequiredRequest : Tells the client if authentication is required If so, returns authentication parameters `challenge` and `salt` (see "Authentication" for more information).

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getauthrequired

func NewGetAuthRequiredRequest 

func NewGetAuthRequiredRequest() GetAuthRequiredRequest

NewGetAuthRequiredRequest returns a new GetAuthRequiredRequest.

func (GetAuthRequiredRequest) ID 

func (r GetAuthRequiredRequest) ID() string

ID returns the request's message ID.

func (GetAuthRequiredRequest) Receive 

func (r GetAuthRequiredRequest) Receive() (GetAuthRequiredResponse, error)

Receive waits for the response.

func (*GetAuthRequiredRequest) Send 

func (r *GetAuthRequiredRequest) Send(c Client) error

Send sends the request.

func (GetAuthRequiredRequest) SendReceive 

func (r GetAuthRequiredRequest) SendReceive(c Client) (GetAuthRequiredResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetAuthRequiredRequest) Type 

func (r GetAuthRequiredRequest) Type() string

Type returns the request's message type.

type GetAuthRequiredResponse 

type GetAuthRequiredResponse struct {
	// Indicates whether authentication is required.
	// Required: Yes.
	AuthRequired bool `json:"authRequired"`
	// Required: No.
	Challenge string `json:"challenge"`
	// Required: No.
	Salt string `json:"salt"`
	// contains filtered or unexported fields
}

GetAuthRequiredResponse : Response for GetAuthRequiredRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getauthrequired

func (GetAuthRequiredResponse) Error 

func (r GetAuthRequiredResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetAuthRequiredResponse) ID 

func (r GetAuthRequiredResponse) ID() string

ID returns the response's message ID.

func (GetAuthRequiredResponse) Status 

func (r GetAuthRequiredResponse) Status() string

Status returns the response's status.

type GetBrowserSourcePropertiesRequest 

type GetBrowserSourcePropertiesRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetBrowserSourcePropertiesRequest : Get current properties for a Browser Source.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getbrowsersourceproperties

func NewGetBrowserSourcePropertiesRequest 

func NewGetBrowserSourcePropertiesRequest(source string) GetBrowserSourcePropertiesRequest

NewGetBrowserSourcePropertiesRequest returns a new GetBrowserSourcePropertiesRequest.

func (GetBrowserSourcePropertiesRequest) ID 

func (r GetBrowserSourcePropertiesRequest) ID() string

ID returns the request's message ID.

func (GetBrowserSourcePropertiesRequest) Receive 

func (r GetBrowserSourcePropertiesRequest) Receive() (GetBrowserSourcePropertiesResponse, error)

Receive waits for the response.

func (*GetBrowserSourcePropertiesRequest) Send 

func (r *GetBrowserSourcePropertiesRequest) Send(c Client) error

Send sends the request.

func (GetBrowserSourcePropertiesRequest) SendReceive 

func (r GetBrowserSourcePropertiesRequest) SendReceive(c Client) (GetBrowserSourcePropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetBrowserSourcePropertiesRequest) Type 

func (r GetBrowserSourcePropertiesRequest) Type() string

Type returns the request's message type.

type GetBrowserSourcePropertiesResponse 

type GetBrowserSourcePropertiesResponse struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Indicates that a local file is in use.
	// Required: Yes.
	IsLocalFile bool `json:"is_local_file"`
	// file path.
	// Required: Yes.
	LocalFile string `json:"local_file"`
	// Url.
	// Required: Yes.
	Url string `json:"url"`
	// CSS to inject.
	// Required: Yes.
	Css string `json:"css"`
	// Width.
	// Required: Yes.
	Width int `json:"width"`
	// Height.
	// Required: Yes.
	Height int `json:"height"`
	// Framerate.
	// Required: Yes.
	FPS int `json:"fps"`
	// Indicates whether the source should be shutdown when not visible.
	// Required: Yes.
	Shutdown bool `json:"shutdown"`
	// contains filtered or unexported fields
}

GetBrowserSourcePropertiesResponse : Response for GetBrowserSourcePropertiesRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getbrowsersourceproperties

func (GetBrowserSourcePropertiesResponse) Error 

func (r GetBrowserSourcePropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetBrowserSourcePropertiesResponse) ID 

func (r GetBrowserSourcePropertiesResponse) ID() string

ID returns the response's message ID.

func (GetBrowserSourcePropertiesResponse) Status 

func (r GetBrowserSourcePropertiesResponse) Status() string

Status returns the response's status.

type GetCurrentProfileRequest 

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

GetCurrentProfileRequest : Get the name of the current profile.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentprofile

func NewGetCurrentProfileRequest 

func NewGetCurrentProfileRequest() GetCurrentProfileRequest

NewGetCurrentProfileRequest returns a new GetCurrentProfileRequest.

func (GetCurrentProfileRequest) ID 

func (r GetCurrentProfileRequest) ID() string

ID returns the request's message ID.

func (GetCurrentProfileRequest) Receive 

func (r GetCurrentProfileRequest) Receive() (GetCurrentProfileResponse, error)

Receive waits for the response.

func (*GetCurrentProfileRequest) Send 

func (r *GetCurrentProfileRequest) Send(c Client) error

Send sends the request.

func (GetCurrentProfileRequest) SendReceive 

func (r GetCurrentProfileRequest) SendReceive(c Client) (GetCurrentProfileResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetCurrentProfileRequest) Type 

func (r GetCurrentProfileRequest) Type() string

Type returns the request's message type.

type GetCurrentProfileResponse 

type GetCurrentProfileResponse struct {
	// Name of the currently active profile.
	// Required: Yes.
	ProfileName string `json:"profile-name"`
	// contains filtered or unexported fields
}

GetCurrentProfileResponse : Response for GetCurrentProfileRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentprofile

func (GetCurrentProfileResponse) Error 

func (r GetCurrentProfileResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetCurrentProfileResponse) ID 

func (r GetCurrentProfileResponse) ID() string

ID returns the response's message ID.

func (GetCurrentProfileResponse) Status 

func (r GetCurrentProfileResponse) Status() string

Status returns the response's status.

type GetCurrentSceneCollectionRequest 

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

GetCurrentSceneCollectionRequest : Get the name of the current scene collection.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentscenecollection

func NewGetCurrentSceneCollectionRequest 

func NewGetCurrentSceneCollectionRequest() GetCurrentSceneCollectionRequest

NewGetCurrentSceneCollectionRequest returns a new GetCurrentSceneCollectionRequest.

func (GetCurrentSceneCollectionRequest) ID 

func (r GetCurrentSceneCollectionRequest) ID() string

ID returns the request's message ID.

func (GetCurrentSceneCollectionRequest) Receive 

func (r GetCurrentSceneCollectionRequest) Receive() (GetCurrentSceneCollectionResponse, error)

Receive waits for the response.

func (*GetCurrentSceneCollectionRequest) Send 

func (r *GetCurrentSceneCollectionRequest) Send(c Client) error

Send sends the request.

func (GetCurrentSceneCollectionRequest) SendReceive 

func (r GetCurrentSceneCollectionRequest) SendReceive(c Client) (GetCurrentSceneCollectionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetCurrentSceneCollectionRequest) Type 

func (r GetCurrentSceneCollectionRequest) Type() string

Type returns the request's message type.

type GetCurrentSceneCollectionResponse 

type GetCurrentSceneCollectionResponse struct {
	// Name of the currently active scene collection.
	// Required: Yes.
	ScName string `json:"sc-name"`
	// contains filtered or unexported fields
}

GetCurrentSceneCollectionResponse : Response for GetCurrentSceneCollectionRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentscenecollection

func (GetCurrentSceneCollectionResponse) Error 

func (r GetCurrentSceneCollectionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetCurrentSceneCollectionResponse) ID 

func (r GetCurrentSceneCollectionResponse) ID() string

ID returns the response's message ID.

func (GetCurrentSceneCollectionResponse) Status 

func (r GetCurrentSceneCollectionResponse) Status() string

Status returns the response's status.

type GetCurrentSceneRequest 

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

GetCurrentSceneRequest : Get the current scene's name and source items.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentscene

func NewGetCurrentSceneRequest 

func NewGetCurrentSceneRequest() GetCurrentSceneRequest

NewGetCurrentSceneRequest returns a new GetCurrentSceneRequest.

func (GetCurrentSceneRequest) ID 

func (r GetCurrentSceneRequest) ID() string

ID returns the request's message ID.

func (GetCurrentSceneRequest) Receive 

func (r GetCurrentSceneRequest) Receive() (GetCurrentSceneResponse, error)

Receive waits for the response.

func (*GetCurrentSceneRequest) Send 

func (r *GetCurrentSceneRequest) Send(c Client) error

Send sends the request.

func (GetCurrentSceneRequest) SendReceive 

func (r GetCurrentSceneRequest) SendReceive(c Client) (GetCurrentSceneResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetCurrentSceneRequest) Type 

func (r GetCurrentSceneRequest) Type() string

Type returns the request's message type.

type GetCurrentSceneResponse 

type GetCurrentSceneResponse struct {
	// Name of the currently active scene.
	// Required: Yes.
	Name string `json:"name"`
	// Ordered list of the current scene's source items.
	// Required: Yes.
	Sources []map[string]interface{} `json:"sources"`
	// contains filtered or unexported fields
}

GetCurrentSceneResponse : Response for GetCurrentSceneRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrentscene

func (GetCurrentSceneResponse) Error 

func (r GetCurrentSceneResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetCurrentSceneResponse) ID 

func (r GetCurrentSceneResponse) ID() string

ID returns the response's message ID.

func (GetCurrentSceneResponse) Status 

func (r GetCurrentSceneResponse) Status() string

Status returns the response's status.

type GetCurrentTransitionRequest 

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

GetCurrentTransitionRequest : Get the name of the currently selected transition in the frontend's dropdown menu.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrenttransition

func NewGetCurrentTransitionRequest 

func NewGetCurrentTransitionRequest() GetCurrentTransitionRequest

NewGetCurrentTransitionRequest returns a new GetCurrentTransitionRequest.

func (GetCurrentTransitionRequest) ID 

func (r GetCurrentTransitionRequest) ID() string

ID returns the request's message ID.

func (GetCurrentTransitionRequest) Receive 

func (r GetCurrentTransitionRequest) Receive() (GetCurrentTransitionResponse, error)

Receive waits for the response.

func (*GetCurrentTransitionRequest) Send 

func (r *GetCurrentTransitionRequest) Send(c Client) error

Send sends the request.

func (GetCurrentTransitionRequest) SendReceive 

func (r GetCurrentTransitionRequest) SendReceive(c Client) (GetCurrentTransitionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetCurrentTransitionRequest) Type 

func (r GetCurrentTransitionRequest) Type() string

Type returns the request's message type.

type GetCurrentTransitionResponse 

type GetCurrentTransitionResponse struct {
	// Name of the selected transition.
	// Required: Yes.
	Name string `json:"name"`
	// Transition duration (in milliseconds) if supported by the transition.
	// Required: No.
	Duration int `json:"duration"`
	// contains filtered or unexported fields
}

GetCurrentTransitionResponse : Response for GetCurrentTransitionRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getcurrenttransition

func (GetCurrentTransitionResponse) Error 

func (r GetCurrentTransitionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetCurrentTransitionResponse) ID 

func (r GetCurrentTransitionResponse) ID() string

ID returns the response's message ID.

func (GetCurrentTransitionResponse) Status 

func (r GetCurrentTransitionResponse) Status() string

Status returns the response's status.

type GetFilenameFormattingRequest 

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

GetFilenameFormattingRequest : Get the filename formatting string.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getfilenameformatting

func NewGetFilenameFormattingRequest 

func NewGetFilenameFormattingRequest() GetFilenameFormattingRequest

NewGetFilenameFormattingRequest returns a new GetFilenameFormattingRequest.

func (GetFilenameFormattingRequest) ID 

func (r GetFilenameFormattingRequest) ID() string

ID returns the request's message ID.

func (GetFilenameFormattingRequest) Receive 

func (r GetFilenameFormattingRequest) Receive() (GetFilenameFormattingResponse, error)

Receive waits for the response.

func (*GetFilenameFormattingRequest) Send 

func (r *GetFilenameFormattingRequest) Send(c Client) error

Send sends the request.

func (GetFilenameFormattingRequest) SendReceive 

func (r GetFilenameFormattingRequest) SendReceive(c Client) (GetFilenameFormattingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetFilenameFormattingRequest) Type 

func (r GetFilenameFormattingRequest) Type() string

Type returns the request's message type.

type GetFilenameFormattingResponse 

type GetFilenameFormattingResponse struct {
	// Current filename formatting string.
	// Required: Yes.
	FilenameFormatting string `json:"filename-formatting"`
	// contains filtered or unexported fields
}

GetFilenameFormattingResponse : Response for GetFilenameFormattingRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getfilenameformatting

func (GetFilenameFormattingResponse) Error 

func (r GetFilenameFormattingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetFilenameFormattingResponse) ID 

func (r GetFilenameFormattingResponse) ID() string

ID returns the response's message ID.

func (GetFilenameFormattingResponse) Status 

func (r GetFilenameFormattingResponse) Status() string

Status returns the response's status.

type GetMuteRequest 

type GetMuteRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetMuteRequest : Get the mute status of a specified source.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getmute

func NewGetMuteRequest 

func NewGetMuteRequest(source string) GetMuteRequest

NewGetMuteRequest returns a new GetMuteRequest.

func (GetMuteRequest) ID 

func (r GetMuteRequest) ID() string

ID returns the request's message ID.

func (GetMuteRequest) Receive 

func (r GetMuteRequest) Receive() (GetMuteResponse, error)

Receive waits for the response.

func (*GetMuteRequest) Send 

func (r *GetMuteRequest) Send(c Client) error

Send sends the request.

func (GetMuteRequest) SendReceive 

func (r GetMuteRequest) SendReceive(c Client) (GetMuteResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetMuteRequest) Type 

func (r GetMuteRequest) Type() string

Type returns the request's message type.

type GetMuteResponse 

type GetMuteResponse struct {
	// Source name.
	// Required: Yes.
	Name string `json:"name"`
	// Mute status of the source.
	// Required: Yes.
	Muted bool `json:"muted"`
	// contains filtered or unexported fields
}

GetMuteResponse : Response for GetMuteRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getmute

func (GetMuteResponse) Error 

func (r GetMuteResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetMuteResponse) ID 

func (r GetMuteResponse) ID() string

ID returns the response's message ID.

func (GetMuteResponse) Status 

func (r GetMuteResponse) Status() string

Status returns the response's status.

type GetOutputInfoRequest 

type GetOutputInfoRequest struct {
	// Output name.
	// Required: Yes.
	OutputName string `json:"outputName"`
	// contains filtered or unexported fields
}

GetOutputInfoRequest : Get information about a single output.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getoutputinfo

func NewGetOutputInfoRequest 

func NewGetOutputInfoRequest(outputName string) GetOutputInfoRequest

NewGetOutputInfoRequest returns a new GetOutputInfoRequest.

func (GetOutputInfoRequest) ID 

func (r GetOutputInfoRequest) ID() string

ID returns the request's message ID.

func (GetOutputInfoRequest) Receive 

func (r GetOutputInfoRequest) Receive() (GetOutputInfoResponse, error)

Receive waits for the response.

func (*GetOutputInfoRequest) Send 

func (r *GetOutputInfoRequest) Send(c Client) error

Send sends the request.

func (GetOutputInfoRequest) SendReceive 

func (r GetOutputInfoRequest) SendReceive(c Client) (GetOutputInfoResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetOutputInfoRequest) Type 

func (r GetOutputInfoRequest) Type() string

Type returns the request's message type.

type GetOutputInfoResponse 

type GetOutputInfoResponse struct {
	// Output info.
	// Required: Yes.
	OutputInfo interface{} `json:"outputInfo"`
	// contains filtered or unexported fields
}

GetOutputInfoResponse : Response for GetOutputInfoRequest.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getoutputinfo

func (GetOutputInfoResponse) Error 

func (r GetOutputInfoResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetOutputInfoResponse) ID 

func (r GetOutputInfoResponse) ID() string

ID returns the response's message ID.

func (GetOutputInfoResponse) Status 

func (r GetOutputInfoResponse) Status() string

Status returns the response's status.

type GetPreviewSceneRequest 

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

GetPreviewSceneRequest : Get the name of the currently previewed scene and its list of sources. Will return an `error` if Studio Mode is not enabled.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getpreviewscene

func NewGetPreviewSceneRequest 

func NewGetPreviewSceneRequest() GetPreviewSceneRequest

NewGetPreviewSceneRequest returns a new GetPreviewSceneRequest.

func (GetPreviewSceneRequest) ID 

func (r GetPreviewSceneRequest) ID() string

ID returns the request's message ID.

func (GetPreviewSceneRequest) Receive 

func (r GetPreviewSceneRequest) Receive() (GetPreviewSceneResponse, error)

Receive waits for the response.

func (*GetPreviewSceneRequest) Send 

func (r *GetPreviewSceneRequest) Send(c Client) error

Send sends the request.

func (GetPreviewSceneRequest) SendReceive 

func (r GetPreviewSceneRequest) SendReceive(c Client) (GetPreviewSceneResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetPreviewSceneRequest) Type 

func (r GetPreviewSceneRequest) Type() string

Type returns the request's message type.

type GetPreviewSceneResponse 

type GetPreviewSceneResponse struct {
	// The name of the active preview scene.
	// Required: Yes.
	Name string `json:"name"`
	// Required: Yes.
	Sources []map[string]interface{} `json:"sources"`
	// contains filtered or unexported fields
}

GetPreviewSceneResponse : Response for GetPreviewSceneRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getpreviewscene

func (GetPreviewSceneResponse) Error 

func (r GetPreviewSceneResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetPreviewSceneResponse) ID 

func (r GetPreviewSceneResponse) ID() string

ID returns the response's message ID.

func (GetPreviewSceneResponse) Status 

func (r GetPreviewSceneResponse) Status() string

Status returns the response's status.

type GetRecordingFolderRequest 

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

GetRecordingFolderRequest : Get the path of the current recording folder.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getrecordingfolder

func NewGetRecordingFolderRequest 

func NewGetRecordingFolderRequest() GetRecordingFolderRequest

NewGetRecordingFolderRequest returns a new GetRecordingFolderRequest.

func (GetRecordingFolderRequest) ID 

func (r GetRecordingFolderRequest) ID() string

ID returns the request's message ID.

func (GetRecordingFolderRequest) Receive 

func (r GetRecordingFolderRequest) Receive() (GetRecordingFolderResponse, error)

Receive waits for the response.

func (*GetRecordingFolderRequest) Send 

func (r *GetRecordingFolderRequest) Send(c Client) error

Send sends the request.

func (GetRecordingFolderRequest) SendReceive 

func (r GetRecordingFolderRequest) SendReceive(c Client) (GetRecordingFolderResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetRecordingFolderRequest) Type 

func (r GetRecordingFolderRequest) Type() string

Type returns the request's message type.

type GetRecordingFolderResponse 

type GetRecordingFolderResponse struct {
	// Path of the recording folder.
	// Required: Yes.
	RecFolder string `json:"rec-folder"`
	// contains filtered or unexported fields
}

GetRecordingFolderResponse : Response for GetRecordingFolderRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getrecordingfolder

func (GetRecordingFolderResponse) Error 

func (r GetRecordingFolderResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetRecordingFolderResponse) ID 

func (r GetRecordingFolderResponse) ID() string

ID returns the response's message ID.

func (GetRecordingFolderResponse) Status 

func (r GetRecordingFolderResponse) Status() string

Status returns the response's status.

type GetSceneItemPropertiesRequest 

type GetSceneItemPropertiesRequest struct {
	// the name of the scene that the source item belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// The name of the source.
	// Required: Yes.
	Item string `json:"item"`
	// contains filtered or unexported fields
}

GetSceneItemPropertiesRequest : Gets the scene specific properties of the specified source item.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getsceneitemproperties

func NewGetSceneItemPropertiesRequest 

func NewGetSceneItemPropertiesRequest(
	sceneName string,
	item string,
) GetSceneItemPropertiesRequest

NewGetSceneItemPropertiesRequest returns a new GetSceneItemPropertiesRequest.

func (GetSceneItemPropertiesRequest) ID 

func (r GetSceneItemPropertiesRequest) ID() string

ID returns the request's message ID.

func (GetSceneItemPropertiesRequest) Receive 

func (r GetSceneItemPropertiesRequest) Receive() (GetSceneItemPropertiesResponse, error)

Receive waits for the response.

func (*GetSceneItemPropertiesRequest) Send 

func (r *GetSceneItemPropertiesRequest) Send(c Client) error

Send sends the request.

func (GetSceneItemPropertiesRequest) SendReceive 

func (r GetSceneItemPropertiesRequest) SendReceive(c Client) (GetSceneItemPropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSceneItemPropertiesRequest) Type 

func (r GetSceneItemPropertiesRequest) Type() string

Type returns the request's message type.

type GetSceneItemPropertiesResponse 

type GetSceneItemPropertiesResponse struct {
	// The name of the source.
	// Required: Yes.
	Name string `json:"name"`
	// The x position of the source from the left.
	// Required: Yes.
	PositionX int `json:"position.x"`
	// The y position of the source from the top.
	// Required: Yes.
	PositionY int `json:"position.y"`
	// The point on the source that the item is manipulated from.
	// Required: Yes.
	PositionAlignment int `json:"position.alignment"`
	// The clockwise rotation of the item in degrees around the point of alignment.
	// Required: Yes.
	Rotation float64 `json:"rotation"`
	// The x-scale factor of the source.
	// Required: Yes.
	ScaleX float64 `json:"scale.x"`
	// The y-scale factor of the source.
	// Required: Yes.
	ScaleY float64 `json:"scale.y"`
	// The number of pixels cropped off the top of the source before scaling.
	// Required: Yes.
	CropTop int `json:"crop.top"`
	// The number of pixels cropped off the right of the source before scaling.
	// Required: Yes.
	CropRight int `json:"crop.right"`
	// The number of pixels cropped off the bottom of the source before scaling.
	// Required: Yes.
	CropBottom int `json:"crop.bottom"`
	// The number of pixels cropped off the left of the source before scaling.
	// Required: Yes.
	CropLeft int `json:"crop.left"`
	// If the source is visible.
	// Required: Yes.
	Visible bool `json:"visible"`
	// Type of bounding box.
	// Required: Yes.
	BoundsType string `json:"bounds.type"`
	// Alignment of the bounding box.
	// Required: Yes.
	BoundsAlignment int `json:"bounds.alignment"`
	// Width of the bounding box.
	// Required: Yes.
	BoundsX float64 `json:"bounds.x"`
	// Height of the bounding box.
	// Required: Yes.
	BoundsY float64 `json:"bounds.y"`
	// contains filtered or unexported fields
}

GetSceneItemPropertiesResponse : Response for GetSceneItemPropertiesRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getsceneitemproperties

func (GetSceneItemPropertiesResponse) Error 

func (r GetSceneItemPropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSceneItemPropertiesResponse) ID 

func (r GetSceneItemPropertiesResponse) ID() string

ID returns the response's message ID.

func (GetSceneItemPropertiesResponse) Status 

func (r GetSceneItemPropertiesResponse) Status() string

Status returns the response's status.

type GetSceneListRequest 

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

GetSceneListRequest : Get a list of scenes in the currently active profile.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getscenelist

func NewGetSceneListRequest 

func NewGetSceneListRequest() GetSceneListRequest

NewGetSceneListRequest returns a new GetSceneListRequest.

func (GetSceneListRequest) ID 

func (r GetSceneListRequest) ID() string

ID returns the request's message ID.

func (GetSceneListRequest) Receive 

func (r GetSceneListRequest) Receive() (GetSceneListResponse, error)

Receive waits for the response.

func (*GetSceneListRequest) Send 

func (r *GetSceneListRequest) Send(c Client) error

Send sends the request.

func (GetSceneListRequest) SendReceive 

func (r GetSceneListRequest) SendReceive(c Client) (GetSceneListResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSceneListRequest) Type 

func (r GetSceneListRequest) Type() string

Type returns the request's message type.

type GetSceneListResponse 

type GetSceneListResponse struct {
	// Name of the currently active scene.
	// Required: Yes.
	CurrentScene string `json:"current-scene"`
	// Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for more information).
	// Required: Yes.
	Scenes []map[string]interface{} `json:"scenes"`
	// contains filtered or unexported fields
}

GetSceneListResponse : Response for GetSceneListRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getscenelist

func (GetSceneListResponse) Error 

func (r GetSceneListResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSceneListResponse) ID 

func (r GetSceneListResponse) ID() string

ID returns the response's message ID.

func (GetSceneListResponse) Status 

func (r GetSceneListResponse) Status() string

Status returns the response's status.

type GetSourceFiltersRequest 

type GetSourceFiltersRequest struct {
	// Source name.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// contains filtered or unexported fields
}

GetSourceFiltersRequest : List filters applied to a source.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcefilters

func NewGetSourceFiltersRequest 

func NewGetSourceFiltersRequest(sourceName string) GetSourceFiltersRequest

NewGetSourceFiltersRequest returns a new GetSourceFiltersRequest.

func (GetSourceFiltersRequest) ID 

func (r GetSourceFiltersRequest) ID() string

ID returns the request's message ID.

func (GetSourceFiltersRequest) Receive 

func (r GetSourceFiltersRequest) Receive() (GetSourceFiltersResponse, error)

Receive waits for the response.

func (*GetSourceFiltersRequest) Send 

func (r *GetSourceFiltersRequest) Send(c Client) error

Send sends the request.

func (GetSourceFiltersRequest) SendReceive 

func (r GetSourceFiltersRequest) SendReceive(c Client) (GetSourceFiltersResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSourceFiltersRequest) Type 

func (r GetSourceFiltersRequest) Type() string

Type returns the request's message type.

type GetSourceFiltersResponse 

type GetSourceFiltersResponse struct {
	// List of filters for the specified source.
	// Required: Yes.
	Filters []map[string]interface{} `json:"filters"`
	// Filter type.
	// Required: Yes.
	FiltersType string `json:"filters.*.type"`
	// Filter name.
	// Required: Yes.
	FiltersName string `json:"filters.*.name"`
	// Filter settings.
	// Required: Yes.
	FiltersSettings map[string]interface{} `json:"filters.*.settings"`
	// contains filtered or unexported fields
}

GetSourceFiltersResponse : Response for GetSourceFiltersRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcefilters

func (GetSourceFiltersResponse) Error 

func (r GetSourceFiltersResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSourceFiltersResponse) ID 

func (r GetSourceFiltersResponse) ID() string

ID returns the response's message ID.

func (GetSourceFiltersResponse) Status 

func (r GetSourceFiltersResponse) Status() string

Status returns the response's status.

type GetSourceSettingsRequest 

type GetSourceSettingsRequest struct {
	// Source name.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Type of the specified source.
	// Useful for type-checking if you expect a specific settings schema.
	// Required: No.
	SourceType string `json:"sourceType"`
	// contains filtered or unexported fields
}

GetSourceSettingsRequest : Get settings of the specified source.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcesettings

func NewGetSourceSettingsRequest 

func NewGetSourceSettingsRequest(
	sourceName string,
	sourceType string,
) GetSourceSettingsRequest

NewGetSourceSettingsRequest returns a new GetSourceSettingsRequest.

func (GetSourceSettingsRequest) ID 

func (r GetSourceSettingsRequest) ID() string

ID returns the request's message ID.

func (GetSourceSettingsRequest) Receive 

func (r GetSourceSettingsRequest) Receive() (GetSourceSettingsResponse, error)

Receive waits for the response.

func (*GetSourceSettingsRequest) Send 

func (r *GetSourceSettingsRequest) Send(c Client) error

Send sends the request.

func (GetSourceSettingsRequest) SendReceive 

func (r GetSourceSettingsRequest) SendReceive(c Client) (GetSourceSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSourceSettingsRequest) Type 

func (r GetSourceSettingsRequest) Type() string

Type returns the request's message type.

type GetSourceSettingsResponse 

type GetSourceSettingsResponse struct {
	// Source name.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Type of the specified source.
	// Required: Yes.
	SourceType string `json:"sourceType"`
	// Source settings (varies between source types, may require some probing around).
	// Required: Yes.
	SourceSettings map[string]interface{} `json:"sourceSettings"`
	// contains filtered or unexported fields
}

GetSourceSettingsResponse : Response for GetSourceSettingsRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcesettings

func (GetSourceSettingsResponse) Error 

func (r GetSourceSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSourceSettingsResponse) ID 

func (r GetSourceSettingsResponse) ID() string

ID returns the response's message ID.

func (GetSourceSettingsResponse) Status 

func (r GetSourceSettingsResponse) Status() string

Status returns the response's status.

type GetSourcesListRequest 

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

GetSourcesListRequest : List all sources available in the running OBS instance.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourceslist

func NewGetSourcesListRequest 

func NewGetSourcesListRequest() GetSourcesListRequest

NewGetSourcesListRequest returns a new GetSourcesListRequest.

func (GetSourcesListRequest) ID 

func (r GetSourcesListRequest) ID() string

ID returns the request's message ID.

func (GetSourcesListRequest) Receive 

func (r GetSourcesListRequest) Receive() (GetSourcesListResponse, error)

Receive waits for the response.

func (*GetSourcesListRequest) Send 

func (r *GetSourcesListRequest) Send(c Client) error

Send sends the request.

func (GetSourcesListRequest) SendReceive 

func (r GetSourcesListRequest) SendReceive(c Client) (GetSourcesListResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSourcesListRequest) Type 

func (r GetSourcesListRequest) Type() string

Type returns the request's message type.

type GetSourcesListResponse 

type GetSourcesListResponse struct {
	// Array of sources.
	// Required: Yes.
	Sources []map[string]interface{} `json:"sources"`
	// Unique source name.
	// Required: Yes.
	SourcesName string `json:"sources.*.name"`
	// Non-unique source internal type (a.k.a type id).
	// Required: Yes.
	SourcesTypeID string `json:"sources.*.typeId"`
	// Source type.
	// Value is one of the following: "input", "filter", "transition", "scene" or "unknown".
	// Required: Yes.
	SourcesType string `json:"sources.*.type"`
	// contains filtered or unexported fields
}

GetSourcesListResponse : Response for GetSourcesListRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourceslist

func (GetSourcesListResponse) Error 

func (r GetSourcesListResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSourcesListResponse) ID 

func (r GetSourcesListResponse) ID() string

ID returns the response's message ID.

func (GetSourcesListResponse) Status 

func (r GetSourcesListResponse) Status() string

Status returns the response's status.

type GetSourcesTypesListRequest 

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

GetSourcesTypesListRequest : Get a list of all available sources types.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcestypeslist

func NewGetSourcesTypesListRequest 

func NewGetSourcesTypesListRequest() GetSourcesTypesListRequest

NewGetSourcesTypesListRequest returns a new GetSourcesTypesListRequest.

func (GetSourcesTypesListRequest) ID 

func (r GetSourcesTypesListRequest) ID() string

ID returns the request's message ID.

func (GetSourcesTypesListRequest) Receive 

func (r GetSourcesTypesListRequest) Receive() (GetSourcesTypesListResponse, error)

Receive waits for the response.

func (*GetSourcesTypesListRequest) Send 

func (r *GetSourcesTypesListRequest) Send(c Client) error

Send sends the request.

func (GetSourcesTypesListRequest) SendReceive 

func (r GetSourcesTypesListRequest) SendReceive(c Client) (GetSourcesTypesListResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSourcesTypesListRequest) Type 

func (r GetSourcesTypesListRequest) Type() string

Type returns the request's message type.

type GetSourcesTypesListResponse 

type GetSourcesTypesListResponse struct {
	// Array of source types.
	// Required: Yes.
	IDs []map[string]interface{} `json:"ids"`
	// Non-unique internal source type ID.
	// Required: Yes.
	IDsTypeID string `json:"ids.*.typeId"`
	// Display name of the source type.
	// Required: Yes.
	IDsDisplayName string `json:"ids.*.displayName"`
	// Type.
	// Value is one of the following: "input", "filter", "transition" or "other".
	// Required: Yes.
	IDsType string `json:"ids.*.type"`
	// Default settings of this source type.
	// Required: Yes.
	IDsDefaultSettings map[string]interface{} `json:"ids.*.defaultSettings"`
	// Source type capabilities.
	// Required: Yes.
	IDsCaps map[string]interface{} `json:"ids.*.caps"`
	// True if source of this type provide frames asynchronously.
	// Required: Yes.
	IDsCapsIsAsync bool `json:"ids.*.caps.isAsync"`
	// True if sources of this type provide video.
	// Required: Yes.
	IDsCapsHasVideo bool `json:"ids.*.caps.hasVideo"`
	// True if sources of this type provide audio.
	// Required: Yes.
	IDsCapsHasAudio bool `json:"ids.*.caps.hasAudio"`
	// True if interaction with this sources of this type is possible.
	// Required: Yes.
	IDsCapsCanInteract bool `json:"ids.*.caps.canInteract"`
	// True if sources of this type composite one or more sub-sources.
	// Required: Yes.
	IDsCapsIsComposite bool `json:"ids.*.caps.isComposite"`
	// True if sources of this type should not be fully duplicated.
	// Required: Yes.
	IDsCapsDoNotDuplicate bool `json:"ids.*.caps.doNotDuplicate"`
	// True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be.
	// Required: Yes.
	IDsCapsDoNotSelfMonitor bool `json:"ids.*.caps.doNotSelfMonitor"`
	// contains filtered or unexported fields
}

GetSourcesTypesListResponse : Response for GetSourcesTypesListRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsourcestypeslist

func (GetSourcesTypesListResponse) Error 

func (r GetSourcesTypesListResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSourcesTypesListResponse) ID 

func (r GetSourcesTypesListResponse) ID() string

ID returns the response's message ID.

func (GetSourcesTypesListResponse) Status 

func (r GetSourcesTypesListResponse) Status() string

Status returns the response's status.

type GetSpecialSourcesRequest 

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

GetSpecialSourcesRequest : Get configured special sources like Desktop Audio and Mic/Aux sources.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getspecialsources

func NewGetSpecialSourcesRequest 

func NewGetSpecialSourcesRequest() GetSpecialSourcesRequest

NewGetSpecialSourcesRequest returns a new GetSpecialSourcesRequest.

func (GetSpecialSourcesRequest) ID 

func (r GetSpecialSourcesRequest) ID() string

ID returns the request's message ID.

func (GetSpecialSourcesRequest) Receive 

func (r GetSpecialSourcesRequest) Receive() (GetSpecialSourcesResponse, error)

Receive waits for the response.

func (*GetSpecialSourcesRequest) Send 

func (r *GetSpecialSourcesRequest) Send(c Client) error

Send sends the request.

func (GetSpecialSourcesRequest) SendReceive 

func (r GetSpecialSourcesRequest) SendReceive(c Client) (GetSpecialSourcesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSpecialSourcesRequest) Type 

func (r GetSpecialSourcesRequest) Type() string

Type returns the request's message type.

type GetSpecialSourcesResponse 

type GetSpecialSourcesResponse struct {
	// Name of the first Desktop Audio capture source.
	// Required: No.
	Desktop1 string `json:"desktop-1"`
	// Name of the second Desktop Audio capture source.
	// Required: No.
	Desktop2 string `json:"desktop-2"`
	// Name of the first Mic/Aux input source.
	// Required: No.
	Mic1 string `json:"mic-1"`
	// Name of the second Mic/Aux input source.
	// Required: No.
	Mic2 string `json:"mic-2"`
	// NAme of the third Mic/Aux input source.
	// Required: No.
	Mic3 string `json:"mic-3"`
	// contains filtered or unexported fields
}

GetSpecialSourcesResponse : Response for GetSpecialSourcesRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getspecialsources

func (GetSpecialSourcesResponse) Error 

func (r GetSpecialSourcesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSpecialSourcesResponse) ID 

func (r GetSpecialSourcesResponse) ID() string

ID returns the response's message ID.

func (GetSpecialSourcesResponse) Status 

func (r GetSpecialSourcesResponse) Status() string

Status returns the response's status.

type GetStreamSettingsRequest 

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

GetStreamSettingsRequest : Get the current streaming server settings.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getstreamsettings

func NewGetStreamSettingsRequest 

func NewGetStreamSettingsRequest() GetStreamSettingsRequest

NewGetStreamSettingsRequest returns a new GetStreamSettingsRequest.

func (GetStreamSettingsRequest) ID 

func (r GetStreamSettingsRequest) ID() string

ID returns the request's message ID.

func (GetStreamSettingsRequest) Receive 

func (r GetStreamSettingsRequest) Receive() (GetStreamSettingsResponse, error)

Receive waits for the response.

func (*GetStreamSettingsRequest) Send 

func (r *GetStreamSettingsRequest) Send(c Client) error

Send sends the request.

func (GetStreamSettingsRequest) SendReceive 

func (r GetStreamSettingsRequest) SendReceive(c Client) (GetStreamSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetStreamSettingsRequest) Type 

func (r GetStreamSettingsRequest) Type() string

Type returns the request's message type.

type GetStreamSettingsResponse 

type GetStreamSettingsResponse struct {
	// The type of streaming service configuration.
	// Possible values: 'rtmp_custom' or 'rtmp_common'.
	// Required: Yes.
	Type string `json:"type"`
	// Stream settings object.
	// Required: Yes.
	Settings map[string]interface{} `json:"settings"`
	// The publish URL.
	// Required: Yes.
	SettingsServer string `json:"settings.server"`
	// The publish key of the stream.
	// Required: Yes.
	SettingsKey string `json:"settings.key"`
	// Indicates whether authentication should be used when connecting to the streaming server.
	// Required: Yes.
	SettingsUseAuth bool `json:"settings.use-auth"`
	// The username to use when accessing the streaming server.
	// Only present if `use-auth` is `true`.
	// Required: Yes.
	SettingsUsername string `json:"settings.username"`
	// The password to use when accessing the streaming server.
	// Only present if `use-auth` is `true`.
	// Required: Yes.
	SettingsPassword string `json:"settings.password"`
	// contains filtered or unexported fields
}

GetStreamSettingsResponse : Response for GetStreamSettingsRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getstreamsettings

func (GetStreamSettingsResponse) Error 

func (r GetStreamSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetStreamSettingsResponse) ID 

func (r GetStreamSettingsResponse) ID() string

ID returns the response's message ID.

func (GetStreamSettingsResponse) Status 

func (r GetStreamSettingsResponse) Status() string

Status returns the response's status.

type GetStreamingStatusRequest 

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

GetStreamingStatusRequest : Get current streaming and recording status.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getstreamingstatus

func NewGetStreamingStatusRequest 

func NewGetStreamingStatusRequest() GetStreamingStatusRequest

NewGetStreamingStatusRequest returns a new GetStreamingStatusRequest.

func (GetStreamingStatusRequest) ID 

func (r GetStreamingStatusRequest) ID() string

ID returns the request's message ID.

func (GetStreamingStatusRequest) Receive 

func (r GetStreamingStatusRequest) Receive() (GetStreamingStatusResponse, error)

Receive waits for the response.

func (*GetStreamingStatusRequest) Send 

func (r *GetStreamingStatusRequest) Send(c Client) error

Send sends the request.

func (GetStreamingStatusRequest) SendReceive 

func (r GetStreamingStatusRequest) SendReceive(c Client) (GetStreamingStatusResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetStreamingStatusRequest) Type 

func (r GetStreamingStatusRequest) Type() string

Type returns the request's message type.

type GetStreamingStatusResponse 

type GetStreamingStatusResponse struct {
	// Current streaming status.
	// Required: Yes.
	Streaming bool `json:"streaming"`
	// Current recording status.
	// Required: Yes.
	Recording bool `json:"recording"`
	// Time elapsed since streaming started (only present if currently streaming).
	// Required: No.
	StreamTimecode string `json:"stream-timecode"`
	// Time elapsed since recording started (only present if currently recording).
	// Required: No.
	RecTimecode string `json:"rec-timecode"`
	// add FPS
	FPS              float64 `json:"fps"`
	KbitsPerSec      int     `json:"kbits-per-sec"`
	Strain           float64 `json:"strain"`
	NumDroppedFrames int     `json:"num-dropped-frames"`
	NumTotalFrames   int     `json:"num-total-frames"`
	TotalStreamTime  int     `json:"total-stream-time"`
	// Always false.
	// Retrocompatibility with OBSRemote.
	// Required: Yes.
	PreviewOnly bool `json:"preview-only"`
	// contains filtered or unexported fields
}

GetStreamingStatusResponse : Response for GetStreamingStatusRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#getstreamingstatus

func (GetStreamingStatusResponse) Error 

func (r GetStreamingStatusResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetStreamingStatusResponse) ID 

func (r GetStreamingStatusResponse) ID() string

ID returns the response's message ID.

func (GetStreamingStatusResponse) Status 

func (r GetStreamingStatusResponse) Status() string

Status returns the response's status.

type GetStudioModeStatusRequest 

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

GetStudioModeStatusRequest : Indicates if Studio Mode is currently enabled.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getstudiomodestatus

func NewGetStudioModeStatusRequest 

func NewGetStudioModeStatusRequest() GetStudioModeStatusRequest

NewGetStudioModeStatusRequest returns a new GetStudioModeStatusRequest.

func (GetStudioModeStatusRequest) ID 

func (r GetStudioModeStatusRequest) ID() string

ID returns the request's message ID.

func (GetStudioModeStatusRequest) Receive 

func (r GetStudioModeStatusRequest) Receive() (GetStudioModeStatusResponse, error)

Receive waits for the response.

func (*GetStudioModeStatusRequest) Send 

func (r *GetStudioModeStatusRequest) Send(c Client) error

Send sends the request.

func (GetStudioModeStatusRequest) SendReceive 

func (r GetStudioModeStatusRequest) SendReceive(c Client) (GetStudioModeStatusResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetStudioModeStatusRequest) Type 

func (r GetStudioModeStatusRequest) Type() string

Type returns the request's message type.

type GetStudioModeStatusResponse 

type GetStudioModeStatusResponse struct {
	// Indicates if Studio Mode is enabled.
	// Required: Yes.
	StudioMode bool `json:"studio-mode"`
	// contains filtered or unexported fields
}

GetStudioModeStatusResponse : Response for GetStudioModeStatusRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getstudiomodestatus

func (GetStudioModeStatusResponse) Error 

func (r GetStudioModeStatusResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetStudioModeStatusResponse) ID 

func (r GetStudioModeStatusResponse) ID() string

ID returns the response's message ID.

func (GetStudioModeStatusResponse) Status 

func (r GetStudioModeStatusResponse) Status() string

Status returns the response's status.

type GetSyncOffsetRequest 

type GetSyncOffsetRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetSyncOffsetRequest : Get the audio sync offset of a specified source.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsyncoffset

func NewGetSyncOffsetRequest 

func NewGetSyncOffsetRequest(source string) GetSyncOffsetRequest

NewGetSyncOffsetRequest returns a new GetSyncOffsetRequest.

func (GetSyncOffsetRequest) ID 

func (r GetSyncOffsetRequest) ID() string

ID returns the request's message ID.

func (GetSyncOffsetRequest) Receive 

func (r GetSyncOffsetRequest) Receive() (GetSyncOffsetResponse, error)

Receive waits for the response.

func (*GetSyncOffsetRequest) Send 

func (r *GetSyncOffsetRequest) Send(c Client) error

Send sends the request.

func (GetSyncOffsetRequest) SendReceive 

func (r GetSyncOffsetRequest) SendReceive(c Client) (GetSyncOffsetResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetSyncOffsetRequest) Type 

func (r GetSyncOffsetRequest) Type() string

Type returns the request's message type.

type GetSyncOffsetResponse 

type GetSyncOffsetResponse struct {
	// Source name.
	// Required: Yes.
	Name string `json:"name"`
	// The audio sync offset (in nanoseconds).
	// Required: Yes.
	Offset int `json:"offset"`
	// contains filtered or unexported fields
}

GetSyncOffsetResponse : Response for GetSyncOffsetRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getsyncoffset

func (GetSyncOffsetResponse) Error 

func (r GetSyncOffsetResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetSyncOffsetResponse) ID 

func (r GetSyncOffsetResponse) ID() string

ID returns the response's message ID.

func (GetSyncOffsetResponse) Status 

func (r GetSyncOffsetResponse) Status() string

Status returns the response's status.

type GetTextFreetype2PropertiesRequest 

type GetTextFreetype2PropertiesRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetTextFreetype2PropertiesRequest : Get the current properties of a Text Freetype 2 source.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettextfreetype2properties

func NewGetTextFreetype2PropertiesRequest 

func NewGetTextFreetype2PropertiesRequest(source string) GetTextFreetype2PropertiesRequest

NewGetTextFreetype2PropertiesRequest returns a new GetTextFreetype2PropertiesRequest.

func (GetTextFreetype2PropertiesRequest) ID 

func (r GetTextFreetype2PropertiesRequest) ID() string

ID returns the request's message ID.

func (GetTextFreetype2PropertiesRequest) Receive 

func (r GetTextFreetype2PropertiesRequest) Receive() (GetTextFreetype2PropertiesResponse, error)

Receive waits for the response.

func (*GetTextFreetype2PropertiesRequest) Send 

func (r *GetTextFreetype2PropertiesRequest) Send(c Client) error

Send sends the request.

func (GetTextFreetype2PropertiesRequest) SendReceive 

func (r GetTextFreetype2PropertiesRequest) SendReceive(c Client) (GetTextFreetype2PropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetTextFreetype2PropertiesRequest) Type 

func (r GetTextFreetype2PropertiesRequest) Type() string

Type returns the request's message type.

type GetTextFreetype2PropertiesResponse 

type GetTextFreetype2PropertiesResponse struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Gradient top color.
	// Required: Yes.
	Color1 int `json:"color1"`
	// Gradient bottom color.
	// Required: Yes.
	Color2 int `json:"color2"`
	// Custom width (0 to disable).
	// Required: Yes.
	CustomWidth int `json:"custom_width"`
	// Drop shadow.
	// Required: Yes.
	DropShadow bool `json:"drop_shadow"`
	// Holds data for the font.
	// Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`.
	// Required: Yes.
	Font map[string]interface{} `json:"font"`
	// Font face.
	// Required: Yes.
	FontFace string `json:"font.face"`
	// Font text styling flag.
	// `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`.
	// Required: Yes.
	FontFlags int `json:"font.flags"`
	// Font text size.
	// Required: Yes.
	FontSize int `json:"font.size"`
	// Font Style (unknown function).
	// Required: Yes.
	FontStyle string `json:"font.style"`
	// Read text from the specified file.
	// Required: Yes.
	FromFile bool `json:"from_file"`
	// Chat log.
	// Required: Yes.
	LogMode bool `json:"log_mode"`
	// Outline.
	// Required: Yes.
	Outline bool `json:"outline"`
	// Text content to be displayed.
	// Required: Yes.
	Text string `json:"text"`
	// File path.
	// Required: Yes.
	TextFile string `json:"text_file"`
	// Word wrap.
	// Required: Yes.
	WordWrap bool `json:"word_wrap"`
	// contains filtered or unexported fields
}

GetTextFreetype2PropertiesResponse : Response for GetTextFreetype2PropertiesRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettextfreetype2properties

func (GetTextFreetype2PropertiesResponse) Error 

func (r GetTextFreetype2PropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetTextFreetype2PropertiesResponse) ID 

func (r GetTextFreetype2PropertiesResponse) ID() string

ID returns the response's message ID.

func (GetTextFreetype2PropertiesResponse) Status 

func (r GetTextFreetype2PropertiesResponse) Status() string

Status returns the response's status.

type GetTextGDIPlusPropertiesRequest 

type GetTextGDIPlusPropertiesRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetTextGDIPlusPropertiesRequest : Get the current properties of a Text GDI Plus source.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettextgdiplusproperties

func NewGetTextGDIPlusPropertiesRequest 

func NewGetTextGDIPlusPropertiesRequest(source string) GetTextGDIPlusPropertiesRequest

NewGetTextGDIPlusPropertiesRequest returns a new GetTextGDIPlusPropertiesRequest.

func (GetTextGDIPlusPropertiesRequest) ID 

func (r GetTextGDIPlusPropertiesRequest) ID() string

ID returns the request's message ID.

func (GetTextGDIPlusPropertiesRequest) Receive 

func (r GetTextGDIPlusPropertiesRequest) Receive() (GetTextGDIPlusPropertiesResponse, error)

Receive waits for the response.

func (*GetTextGDIPlusPropertiesRequest) Send 

func (r *GetTextGDIPlusPropertiesRequest) Send(c Client) error

Send sends the request.

func (GetTextGDIPlusPropertiesRequest) SendReceive 

func (r GetTextGDIPlusPropertiesRequest) SendReceive(c Client) (GetTextGDIPlusPropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetTextGDIPlusPropertiesRequest) Type 

func (r GetTextGDIPlusPropertiesRequest) Type() string

Type returns the request's message type.

type GetTextGDIPlusPropertiesResponse 

type GetTextGDIPlusPropertiesResponse struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Text Alignment ("left", "center", "right").
	// Required: Yes.
	Align string `json:"align"`
	// Background color.
	// Required: Yes.
	BkColor int `json:"bk-color"`
	// Background opacity (0-100).
	// Required: Yes.
	BkOpacity int `json:"bk-opacity"`
	// Chat log.
	// Required: Yes.
	Chatlog bool `json:"chatlog"`
	// Chat log lines.
	// Required: Yes.
	ChatlogLines int `json:"chatlog_lines"`
	// Text color.
	// Required: Yes.
	Color int `json:"color"`
	// Extents wrap.
	// Required: Yes.
	Extents bool `json:"extents"`
	// Extents cx.
	// Required: Yes.
	ExtentsCx int `json:"extents_cx"`
	// Extents cy.
	// Required: Yes.
	ExtentsCy int `json:"extents_cy"`
	// File path name.
	// Required: Yes.
	File string `json:"file"`
	// Read text from the specified file.
	// Required: Yes.
	ReadFromFile bool `json:"read_from_file"`
	// Holds data for the font.
	// Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`.
	// Required: Yes.
	Font map[string]interface{} `json:"font"`
	// Font face.
	// Required: Yes.
	FontFace string `json:"font.face"`
	// Font text styling flag.
	// `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`.
	// Required: Yes.
	FontFlags int `json:"font.flags"`
	// Font text size.
	// Required: Yes.
	FontSize int `json:"font.size"`
	// Font Style (unknown function).
	// Required: Yes.
	FontStyle string `json:"font.style"`
	// Gradient enabled.
	// Required: Yes.
	Gradient bool `json:"gradient"`
	// Gradient color.
	// Required: Yes.
	GradientColor int `json:"gradient_color"`
	// Gradient direction.
	// Required: Yes.
	GradientDir float64 `json:"gradient_dir"`
	// Gradient opacity (0-100).
	// Required: Yes.
	GradientOpacity int `json:"gradient_opacity"`
	// Outline.
	// Required: Yes.
	Outline bool `json:"outline"`
	// Outline color.
	// Required: Yes.
	OutlineColor int `json:"outline_color"`
	// Outline size.
	// Required: Yes.
	OutlineSize int `json:"outline_size"`
	// Outline opacity (0-100).
	// Required: Yes.
	OutlineOpacity int `json:"outline_opacity"`
	// Text content to be displayed.
	// Required: Yes.
	Text string `json:"text"`
	// Text vertical alignment ("top", "center", "bottom").
	// Required: Yes.
	Valign string `json:"valign"`
	// Vertical text enabled.
	// Required: Yes.
	Vertical bool `json:"vertical"`
	// contains filtered or unexported fields
}

GetTextGDIPlusPropertiesResponse : Response for GetTextGDIPlusPropertiesRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettextgdiplusproperties

func (GetTextGDIPlusPropertiesResponse) Error 

func (r GetTextGDIPlusPropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetTextGDIPlusPropertiesResponse) ID 

func (r GetTextGDIPlusPropertiesResponse) ID() string

ID returns the response's message ID.

func (GetTextGDIPlusPropertiesResponse) Status 

func (r GetTextGDIPlusPropertiesResponse) Status() string

Status returns the response's status.

type GetTransitionDurationRequest 

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

GetTransitionDurationRequest : Get the duration of the currently selected transition if supported.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettransitionduration

func NewGetTransitionDurationRequest 

func NewGetTransitionDurationRequest() GetTransitionDurationRequest

NewGetTransitionDurationRequest returns a new GetTransitionDurationRequest.

func (GetTransitionDurationRequest) ID 

func (r GetTransitionDurationRequest) ID() string

ID returns the request's message ID.

func (GetTransitionDurationRequest) Receive 

func (r GetTransitionDurationRequest) Receive() (GetTransitionDurationResponse, error)

Receive waits for the response.

func (*GetTransitionDurationRequest) Send 

func (r *GetTransitionDurationRequest) Send(c Client) error

Send sends the request.

func (GetTransitionDurationRequest) SendReceive 

func (r GetTransitionDurationRequest) SendReceive(c Client) (GetTransitionDurationResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetTransitionDurationRequest) Type 

func (r GetTransitionDurationRequest) Type() string

Type returns the request's message type.

type GetTransitionDurationResponse 

type GetTransitionDurationResponse struct {
	// Duration of the current transition (in milliseconds).
	// Required: Yes.
	TransitionDuration int `json:"transition-duration"`
	// contains filtered or unexported fields
}

GetTransitionDurationResponse : Response for GetTransitionDurationRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettransitionduration

func (GetTransitionDurationResponse) Error 

func (r GetTransitionDurationResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetTransitionDurationResponse) ID 

func (r GetTransitionDurationResponse) ID() string

ID returns the response's message ID.

func (GetTransitionDurationResponse) Status 

func (r GetTransitionDurationResponse) Status() string

Status returns the response's status.

type GetTransitionListRequest 

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

GetTransitionListRequest : List of all transitions available in the frontend's dropdown menu.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettransitionlist

func NewGetTransitionListRequest 

func NewGetTransitionListRequest() GetTransitionListRequest

NewGetTransitionListRequest returns a new GetTransitionListRequest.

func (GetTransitionListRequest) ID 

func (r GetTransitionListRequest) ID() string

ID returns the request's message ID.

func (GetTransitionListRequest) Receive 

func (r GetTransitionListRequest) Receive() (GetTransitionListResponse, error)

Receive waits for the response.

func (*GetTransitionListRequest) Send 

func (r *GetTransitionListRequest) Send(c Client) error

Send sends the request.

func (GetTransitionListRequest) SendReceive 

func (r GetTransitionListRequest) SendReceive(c Client) (GetTransitionListResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetTransitionListRequest) Type 

func (r GetTransitionListRequest) Type() string

Type returns the request's message type.

type GetTransitionListResponse 

type GetTransitionListResponse struct {
	// Name of the currently active transition.
	// Required: Yes.
	CurrentTransition string `json:"current-transition"`
	// List of transitions.
	// Required: Yes.
	Transitions []map[string]interface{} `json:"transitions"`
	// Name of the transition.
	// Required: Yes.
	TransitionsName string `json:"transitions.*.name"`
	// contains filtered or unexported fields
}

GetTransitionListResponse : Response for GetTransitionListRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#gettransitionlist

func (GetTransitionListResponse) Error 

func (r GetTransitionListResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetTransitionListResponse) ID 

func (r GetTransitionListResponse) ID() string

ID returns the response's message ID.

func (GetTransitionListResponse) Status 

func (r GetTransitionListResponse) Status() string

Status returns the response's status.

type GetVersionRequest 

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

GetVersionRequest : Returns the latest version of the plugin and the API.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getversion

func NewGetVersionRequest 

func NewGetVersionRequest() GetVersionRequest

NewGetVersionRequest returns a new GetVersionRequest.

func (GetVersionRequest) ID 

func (r GetVersionRequest) ID() string

ID returns the request's message ID.

func (GetVersionRequest) Receive 

func (r GetVersionRequest) Receive() (GetVersionResponse, error)

Receive waits for the response.

func (*GetVersionRequest) Send 

func (r *GetVersionRequest) Send(c Client) error

Send sends the request.

func (GetVersionRequest) SendReceive 

func (r GetVersionRequest) SendReceive(c Client) (GetVersionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetVersionRequest) Type 

func (r GetVersionRequest) Type() string

Type returns the request's message type.

type GetVersionResponse 

type GetVersionResponse struct {
	// OBSRemote compatible API version.
	// Fixed to 1.1 for retrocompatibility.
	// Required: Yes.
	Version float64 `json:"version"`
	// obs-websocket plugin version.
	// Required: Yes.
	OBSWebsocketVersion string `json:"obs-websocket-version"`
	// OBS Studio program version.
	// Required: Yes.
	OBSStudioVersion string `json:"obs-studio-version"`
	// List of available request types, formatted as a comma-separated list string (e.g. : "Method1,Method2,Method3").
	// Required: Yes.
	AvailableRequests string `json:"available-requests"`
	// contains filtered or unexported fields
}

GetVersionResponse : Response for GetVersionRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getversion

func (GetVersionResponse) Error 

func (r GetVersionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetVersionResponse) ID 

func (r GetVersionResponse) ID() string

ID returns the response's message ID.

func (GetVersionResponse) Status 

func (r GetVersionResponse) Status() string

Status returns the response's status.

type GetVolumeRequest 

type GetVolumeRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

GetVolumeRequest : Get the volume of the specified source.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getvolume

func NewGetVolumeRequest 

func NewGetVolumeRequest(source string) GetVolumeRequest

NewGetVolumeRequest returns a new GetVolumeRequest.

func (GetVolumeRequest) ID 

func (r GetVolumeRequest) ID() string

ID returns the request's message ID.

func (GetVolumeRequest) Receive 

func (r GetVolumeRequest) Receive() (GetVolumeResponse, error)

Receive waits for the response.

func (*GetVolumeRequest) Send 

func (r *GetVolumeRequest) Send(c Client) error

Send sends the request.

func (GetVolumeRequest) SendReceive 

func (r GetVolumeRequest) SendReceive(c Client) (GetVolumeResponse, error)

SendReceive sends the request then immediately waits for the response.

func (GetVolumeRequest) Type 

func (r GetVolumeRequest) Type() string

Type returns the request's message type.

type GetVolumeResponse 

type GetVolumeResponse struct {
	// Source name.
	// Required: Yes.
	Name string `json:"name"`
	// Volume of the source.
	// Between `0.0` and `1.0`.
	// Required: Yes.
	Volume float64 `json:"volume"`
	// Indicates whether the source is muted.
	// Required: Yes.
	Muted bool `json:"muted"`
	// contains filtered or unexported fields
}

GetVolumeResponse : Response for GetVolumeRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#getvolume

func (GetVolumeResponse) Error 

func (r GetVolumeResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (GetVolumeResponse) ID 

func (r GetVolumeResponse) ID() string

ID returns the response's message ID.

func (GetVolumeResponse) Status 

func (r GetVolumeResponse) Status() string

Status returns the response's status.

type HeartbeatEvent 

type HeartbeatEvent struct {
	// Toggles between every JSON message as an "I am alive" indicator.
	// Required: Yes.
	Pulse bool `json:"pulse"`
	// Current active profile.
	// Required: No.
	CurrentProfile string `json:"current-profile"`
	// Current active scene.
	// Required: No.
	CurrentScene string `json:"current-scene"`
	// Current streaming state.
	// Required: No.
	Streaming bool `json:"streaming"`
	// Total time (in seconds) since the stream started.
	// Required: No.
	TotalStreamTime int `json:"total-stream-time"`
	// Total bytes sent since the stream started.
	// Required: No.
	TotalStreamBytes int `json:"total-stream-bytes"`
	// Total frames streamed since the stream started.
	// Required: No.
	TotalStreamFrames int `json:"total-stream-frames"`
	// Current recording state.
	// Required: No.
	Recording bool `json:"recording"`
	// Total time (in seconds) since recording started.
	// Required: No.
	TotalRecordTime int `json:"total-record-time"`
	// Total bytes recorded since the recording started.
	// Required: No.
	TotalRecordBytes int `json:"total-record-bytes"`
	// Total frames recorded since the recording started.
	// Required: No.
	TotalRecordFrames int `json:"total-record-frames"`
	// contains filtered or unexported fields
}

HeartbeatEvent : Emitted every 2 seconds after enabling it by calling SetHeartbeat.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#heartbeat

func (HeartbeatEvent) RecTimecode 

func (e HeartbeatEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (HeartbeatEvent) StreamTimecode 

func (e HeartbeatEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (HeartbeatEvent) Type 

func (e HeartbeatEvent) Type() string

Type returns the event's update type.

type ListOutputsRequest 

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

ListOutputsRequest : List existing outputs.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listoutputs

func NewListOutputsRequest 

func NewListOutputsRequest() ListOutputsRequest

NewListOutputsRequest returns a new ListOutputsRequest.

func (ListOutputsRequest) ID 

func (r ListOutputsRequest) ID() string

ID returns the request's message ID.

func (ListOutputsRequest) Receive 

func (r ListOutputsRequest) Receive() (ListOutputsResponse, error)

Receive waits for the response.

func (*ListOutputsRequest) Send 

func (r *ListOutputsRequest) Send(c Client) error

Send sends the request.

func (ListOutputsRequest) SendReceive 

func (r ListOutputsRequest) SendReceive(c Client) (ListOutputsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ListOutputsRequest) Type 

func (r ListOutputsRequest) Type() string

Type returns the request's message type.

type ListOutputsResponse 

type ListOutputsResponse struct {
	// Outputs list.
	// Required: Yes.
	Outputs []map[string]interface{} `json:"outputs"`
	// contains filtered or unexported fields
}

ListOutputsResponse : Response for ListOutputsRequest.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listoutputs

func (ListOutputsResponse) Error 

func (r ListOutputsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ListOutputsResponse) ID 

func (r ListOutputsResponse) ID() string

ID returns the response's message ID.

func (ListOutputsResponse) Status 

func (r ListOutputsResponse) Status() string

Status returns the response's status.

type ListProfilesRequest 

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

ListProfilesRequest : Get a list of available profiles.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listprofiles

func NewListProfilesRequest 

func NewListProfilesRequest() ListProfilesRequest

NewListProfilesRequest returns a new ListProfilesRequest.

func (ListProfilesRequest) ID 

func (r ListProfilesRequest) ID() string

ID returns the request's message ID.

func (ListProfilesRequest) Receive 

func (r ListProfilesRequest) Receive() (ListProfilesResponse, error)

Receive waits for the response.

func (*ListProfilesRequest) Send 

func (r *ListProfilesRequest) Send(c Client) error

Send sends the request.

func (ListProfilesRequest) SendReceive 

func (r ListProfilesRequest) SendReceive(c Client) (ListProfilesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ListProfilesRequest) Type 

func (r ListProfilesRequest) Type() string

Type returns the request's message type.

type ListProfilesResponse 

type ListProfilesResponse struct {
	// List of available profiles.
	// Required: Yes.
	Profiles []map[string]interface{} `json:"profiles"`
	// contains filtered or unexported fields
}

ListProfilesResponse : Response for ListProfilesRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listprofiles

func (ListProfilesResponse) Error 

func (r ListProfilesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ListProfilesResponse) ID 

func (r ListProfilesResponse) ID() string

ID returns the response's message ID.

func (ListProfilesResponse) Status 

func (r ListProfilesResponse) Status() string

Status returns the response's status.

type ListSceneCollectionsRequest 

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

ListSceneCollectionsRequest : List available scene collections.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listscenecollections

func NewListSceneCollectionsRequest 

func NewListSceneCollectionsRequest() ListSceneCollectionsRequest

NewListSceneCollectionsRequest returns a new ListSceneCollectionsRequest.

func (ListSceneCollectionsRequest) ID 

func (r ListSceneCollectionsRequest) ID() string

ID returns the request's message ID.

func (ListSceneCollectionsRequest) Receive 

func (r ListSceneCollectionsRequest) Receive() (ListSceneCollectionsResponse, error)

Receive waits for the response.

func (*ListSceneCollectionsRequest) Send 

func (r *ListSceneCollectionsRequest) Send(c Client) error

Send sends the request.

func (ListSceneCollectionsRequest) SendReceive 

func (r ListSceneCollectionsRequest) SendReceive(c Client) (ListSceneCollectionsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ListSceneCollectionsRequest) Type 

func (r ListSceneCollectionsRequest) Type() string

Type returns the request's message type.

type ListSceneCollectionsResponse 

type ListSceneCollectionsResponse struct {
	// Scene collections list.
	// Required: Yes.
	SceneCollections []string `json:"scene-collections"`
	// contains filtered or unexported fields
}

ListSceneCollectionsResponse : Response for ListSceneCollectionsRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#listscenecollections

func (ListSceneCollectionsResponse) Error 

func (r ListSceneCollectionsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ListSceneCollectionsResponse) ID 

func (r ListSceneCollectionsResponse) ID() string

ID returns the response's message ID.

func (ListSceneCollectionsResponse) Status 

func (r ListSceneCollectionsResponse) Status() string

Status returns the response's status.

type MoveSourceFilterRequest 

type MoveSourceFilterRequest struct {
	// Name of the source to which the filter belongs.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Name of the filter to reorder.
	// Required: Yes.
	FilterName string `json:"filterName"`
	// How to move the filter around in the source's filter chain.
	// Either "up", "down", "top" or "bottom".
	// Required: Yes.
	MovementType string `json:"movementType"`
	// contains filtered or unexported fields
}

MoveSourceFilterRequest : Move a filter in the chain (relative positioning).

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#movesourcefilter

func NewMoveSourceFilterRequest 

func NewMoveSourceFilterRequest(
	sourceName string,
	filterName string,
	movementType string,
) MoveSourceFilterRequest

NewMoveSourceFilterRequest returns a new MoveSourceFilterRequest.

func (MoveSourceFilterRequest) ID 

func (r MoveSourceFilterRequest) ID() string

ID returns the request's message ID.

func (MoveSourceFilterRequest) Receive 

func (r MoveSourceFilterRequest) Receive() (MoveSourceFilterResponse, error)

Receive waits for the response.

func (*MoveSourceFilterRequest) Send 

func (r *MoveSourceFilterRequest) Send(c Client) error

Send sends the request.

func (MoveSourceFilterRequest) SendReceive 

func (r MoveSourceFilterRequest) SendReceive(c Client) (MoveSourceFilterResponse, error)

SendReceive sends the request then immediately waits for the response.

func (MoveSourceFilterRequest) Type 

func (r MoveSourceFilterRequest) Type() string

Type returns the request's message type.

type MoveSourceFilterResponse 

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

MoveSourceFilterResponse : Response for MoveSourceFilterRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#movesourcefilter

func (MoveSourceFilterResponse) Error 

func (r MoveSourceFilterResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (MoveSourceFilterResponse) ID 

func (r MoveSourceFilterResponse) ID() string

ID returns the response's message ID.

func (MoveSourceFilterResponse) Status 

func (r MoveSourceFilterResponse) Status() string

Status returns the response's status.

type PreviewSceneChangedEvent 

type PreviewSceneChangedEvent struct {
	// Name of the scene being previewed.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// List of sources composing the scene.
	// Same specification as [`GetCurrentScene`](#getcurrentscene).
	// Required: Yes.
	Sources []map[string]interface{} `json:"sources"`
	// contains filtered or unexported fields
}

PreviewSceneChangedEvent : The selected preview scene has changed (only available in Studio Mode).

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#previewscenechanged

func (PreviewSceneChangedEvent) RecTimecode 

func (e PreviewSceneChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (PreviewSceneChangedEvent) StreamTimecode 

func (e PreviewSceneChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (PreviewSceneChangedEvent) Type 

func (e PreviewSceneChangedEvent) Type() string

Type returns the event's update type.

type ProfileChangedEvent 

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

ProfileChangedEvent : Triggered when switching to another profile or when renaming the current profile.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#profilechanged

func (ProfileChangedEvent) RecTimecode 

func (e ProfileChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ProfileChangedEvent) StreamTimecode 

func (e ProfileChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ProfileChangedEvent) Type 

func (e ProfileChangedEvent) Type() string

Type returns the event's update type.

type ProfileListChangedEvent 

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

ProfileListChangedEvent : Triggered when a profile is created, added, renamed, or removed.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#profilelistchanged

func (ProfileListChangedEvent) RecTimecode 

func (e ProfileListChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ProfileListChangedEvent) StreamTimecode 

func (e ProfileListChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ProfileListChangedEvent) Type 

func (e ProfileListChangedEvent) Type() string

Type returns the event's update type.

type RecordingStartedEvent 

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

RecordingStartedEvent : Recording started successfully.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#recordingstarted

func (RecordingStartedEvent) RecTimecode 

func (e RecordingStartedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (RecordingStartedEvent) StreamTimecode 

func (e RecordingStartedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (RecordingStartedEvent) Type 

func (e RecordingStartedEvent) Type() string

Type returns the event's update type.

type RecordingStartingEvent 

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

RecordingStartingEvent : A request to start recording has been issued.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#recordingstarting

func (RecordingStartingEvent) RecTimecode 

func (e RecordingStartingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (RecordingStartingEvent) StreamTimecode 

func (e RecordingStartingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (RecordingStartingEvent) Type 

func (e RecordingStartingEvent) Type() string

Type returns the event's update type.

type RecordingStoppedEvent 

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

RecordingStoppedEvent : Recording stopped successfully.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#recordingstopped

func (RecordingStoppedEvent) RecTimecode 

func (e RecordingStoppedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (RecordingStoppedEvent) StreamTimecode 

func (e RecordingStoppedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (RecordingStoppedEvent) Type 

func (e RecordingStoppedEvent) Type() string

Type returns the event's update type.

type RecordingStoppingEvent 

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

RecordingStoppingEvent : A request to stop recording has been issued.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#recordingstopping

func (RecordingStoppingEvent) RecTimecode 

func (e RecordingStoppingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (RecordingStoppingEvent) StreamTimecode 

func (e RecordingStoppingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (RecordingStoppingEvent) Type 

func (e RecordingStoppingEvent) Type() string

Type returns the event's update type.

type RemoveFilterFromSourceRequest 

type RemoveFilterFromSourceRequest struct {
	// Name of the source from which the specified filter is removed.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Name of the filter to remove.
	// Required: Yes.
	FilterName string `json:"filterName"`
	// contains filtered or unexported fields
}

RemoveFilterFromSourceRequest : Remove a filter from a source.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#removefilterfromsource

func NewRemoveFilterFromSourceRequest 

func NewRemoveFilterFromSourceRequest(
	sourceName string,
	filterName string,
) RemoveFilterFromSourceRequest

NewRemoveFilterFromSourceRequest returns a new RemoveFilterFromSourceRequest.

func (RemoveFilterFromSourceRequest) ID 

func (r RemoveFilterFromSourceRequest) ID() string

ID returns the request's message ID.

func (RemoveFilterFromSourceRequest) Receive 

func (r RemoveFilterFromSourceRequest) Receive() (RemoveFilterFromSourceResponse, error)

Receive waits for the response.

func (*RemoveFilterFromSourceRequest) Send 

func (r *RemoveFilterFromSourceRequest) Send(c Client) error

Send sends the request.

func (RemoveFilterFromSourceRequest) SendReceive 

func (r RemoveFilterFromSourceRequest) SendReceive(c Client) (RemoveFilterFromSourceResponse, error)

SendReceive sends the request then immediately waits for the response.

func (RemoveFilterFromSourceRequest) Type 

func (r RemoveFilterFromSourceRequest) Type() string

Type returns the request's message type.

type RemoveFilterFromSourceResponse 

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

RemoveFilterFromSourceResponse : Response for RemoveFilterFromSourceRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#removefilterfromsource

func (RemoveFilterFromSourceResponse) Error 

func (r RemoveFilterFromSourceResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (RemoveFilterFromSourceResponse) ID 

func (r RemoveFilterFromSourceResponse) ID() string

ID returns the response's message ID.

func (RemoveFilterFromSourceResponse) Status 

func (r RemoveFilterFromSourceResponse) Status() string

Status returns the response's status.

type ReorderSceneItemsRequest 

type ReorderSceneItemsRequest struct {
	// Name of the scene to reorder (defaults to current).
	// Required: No.
	Scene string `json:"scene"`
	// Ordered list of objects with name and/or id specified.
	// Id preferred due to uniqueness per scene.
	// Required: Yes.
	Items []map[string]interface{} `json:"items"`
	// Id of a specific scene item.
	// Unique on a scene by scene basis.
	// Required: No.
	ItemsID int `json:"items[].id"`
	// Name of a scene item.
	// Sufficiently unique if no scene items share sources within the scene.
	// Required: No.
	ItemsName string `json:"items[].name"`
	// contains filtered or unexported fields
}

ReorderSceneItemsRequest : Changes the order of scene items in the requested scene.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#reordersceneitems

func NewReorderSceneItemsRequest 

func NewReorderSceneItemsRequest(
	scene string,
	items []map[string]interface{},
	itemsID int,
	itemsName string,
) ReorderSceneItemsRequest

NewReorderSceneItemsRequest returns a new ReorderSceneItemsRequest.

func (ReorderSceneItemsRequest) ID 

func (r ReorderSceneItemsRequest) ID() string

ID returns the request's message ID.

func (ReorderSceneItemsRequest) Receive 

func (r ReorderSceneItemsRequest) Receive() (ReorderSceneItemsResponse, error)

Receive waits for the response.

func (*ReorderSceneItemsRequest) Send 

func (r *ReorderSceneItemsRequest) Send(c Client) error

Send sends the request.

func (ReorderSceneItemsRequest) SendReceive 

func (r ReorderSceneItemsRequest) SendReceive(c Client) (ReorderSceneItemsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ReorderSceneItemsRequest) Type 

func (r ReorderSceneItemsRequest) Type() string

Type returns the request's message type.

type ReorderSceneItemsResponse 

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

ReorderSceneItemsResponse : Response for ReorderSceneItemsRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#reordersceneitems

func (ReorderSceneItemsResponse) Error 

func (r ReorderSceneItemsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ReorderSceneItemsResponse) ID 

func (r ReorderSceneItemsResponse) ID() string

ID returns the response's message ID.

func (ReorderSceneItemsResponse) Status 

func (r ReorderSceneItemsResponse) Status() string

Status returns the response's status.

type ReorderSourceFilterRequest 

type ReorderSourceFilterRequest struct {
	// Name of the source to which the filter belongs.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Name of the filter to reorder.
	// Required: Yes.
	FilterName string `json:"filterName"`
	// Desired position of the filter in the chain.
	// Required: Yes.
	NewIndex int `json:"newIndex"`
	// contains filtered or unexported fields
}

ReorderSourceFilterRequest : Move a filter in the chain (absolute index positioning).

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#reordersourcefilter

func NewReorderSourceFilterRequest 

func NewReorderSourceFilterRequest(
	sourceName string,
	filterName string,
	newIndex int,
) ReorderSourceFilterRequest

NewReorderSourceFilterRequest returns a new ReorderSourceFilterRequest.

func (ReorderSourceFilterRequest) ID 

func (r ReorderSourceFilterRequest) ID() string

ID returns the request's message ID.

func (ReorderSourceFilterRequest) Receive 

func (r ReorderSourceFilterRequest) Receive() (ReorderSourceFilterResponse, error)

Receive waits for the response.

func (*ReorderSourceFilterRequest) Send 

func (r *ReorderSourceFilterRequest) Send(c Client) error

Send sends the request.

func (ReorderSourceFilterRequest) SendReceive 

func (r ReorderSourceFilterRequest) SendReceive(c Client) (ReorderSourceFilterResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ReorderSourceFilterRequest) Type 

func (r ReorderSourceFilterRequest) Type() string

Type returns the request's message type.

type ReorderSourceFilterResponse 

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

ReorderSourceFilterResponse : Response for ReorderSourceFilterRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#reordersourcefilter

func (ReorderSourceFilterResponse) Error 

func (r ReorderSourceFilterResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ReorderSourceFilterResponse) ID 

func (r ReorderSourceFilterResponse) ID() string

ID returns the response's message ID.

func (ReorderSourceFilterResponse) Status 

func (r ReorderSourceFilterResponse) Status() string

Status returns the response's status.

type ReplayStartedEvent 

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

ReplayStartedEvent : Replay Buffer started successfully.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#replaystarted

func (ReplayStartedEvent) RecTimecode 

func (e ReplayStartedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ReplayStartedEvent) StreamTimecode 

func (e ReplayStartedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ReplayStartedEvent) Type 

func (e ReplayStartedEvent) Type() string

Type returns the event's update type.

type ReplayStartingEvent 

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

ReplayStartingEvent : A request to start the replay buffer has been issued.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#replaystarting

func (ReplayStartingEvent) RecTimecode 

func (e ReplayStartingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ReplayStartingEvent) StreamTimecode 

func (e ReplayStartingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ReplayStartingEvent) Type 

func (e ReplayStartingEvent) Type() string

Type returns the event's update type.

type ReplayStoppedEvent 

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

ReplayStoppedEvent : Replay Buffer stopped successfully.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#replaystopped

func (ReplayStoppedEvent) RecTimecode 

func (e ReplayStoppedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ReplayStoppedEvent) StreamTimecode 

func (e ReplayStoppedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ReplayStoppedEvent) Type 

func (e ReplayStoppedEvent) Type() string

Type returns the event's update type.

type ReplayStoppingEvent 

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

ReplayStoppingEvent : A request to stop the replay buffer has been issued.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#replaystopping

func (ReplayStoppingEvent) RecTimecode 

func (e ReplayStoppingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ReplayStoppingEvent) StreamTimecode 

func (e ReplayStoppingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ReplayStoppingEvent) Type 

func (e ReplayStoppingEvent) Type() string

Type returns the event's update type.

type Request 

type Request interface {
	ID() string
	Type() string
	Send(Client) error
}

Request is a request to obs-websocket.

type ResetSceneItemRequest 

type ResetSceneItemRequest struct {
	// Name of the scene the source belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// Name of the source item.
	// Required: Yes.
	Item string `json:"item"`
	// contains filtered or unexported fields
}

ResetSceneItemRequest : Reset a scene item.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#resetsceneitem

func NewResetSceneItemRequest 

func NewResetSceneItemRequest(
	sceneName string,
	item string,
) ResetSceneItemRequest

NewResetSceneItemRequest returns a new ResetSceneItemRequest.

func (ResetSceneItemRequest) ID 

func (r ResetSceneItemRequest) ID() string

ID returns the request's message ID.

func (ResetSceneItemRequest) Receive 

func (r ResetSceneItemRequest) Receive() (ResetSceneItemResponse, error)

Receive waits for the response.

func (*ResetSceneItemRequest) Send 

func (r *ResetSceneItemRequest) Send(c Client) error

Send sends the request.

func (ResetSceneItemRequest) SendReceive 

func (r ResetSceneItemRequest) SendReceive(c Client) (ResetSceneItemResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ResetSceneItemRequest) Type 

func (r ResetSceneItemRequest) Type() string

Type returns the request's message type.

type ResetSceneItemResponse 

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

ResetSceneItemResponse : Response for ResetSceneItemRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#resetsceneitem

func (ResetSceneItemResponse) Error 

func (r ResetSceneItemResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ResetSceneItemResponse) ID 

func (r ResetSceneItemResponse) ID() string

ID returns the response's message ID.

func (ResetSceneItemResponse) Status 

func (r ResetSceneItemResponse) Status() string

Status returns the response's status.

type Response 

type Response interface {
	ID() string
	Status() string
	Error() string
}

Response is a response from obs-websocket.

type SaveReplayBufferRequest 

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

SaveReplayBufferRequest : Flush and save the contents of the Replay Buffer to disk This is basically the same as triggering the "Save Replay Buffer" hotkey. Will return an `error` if the Replay Buffer is not active.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#savereplaybuffer

func NewSaveReplayBufferRequest 

func NewSaveReplayBufferRequest() SaveReplayBufferRequest

NewSaveReplayBufferRequest returns a new SaveReplayBufferRequest.

func (SaveReplayBufferRequest) ID 

func (r SaveReplayBufferRequest) ID() string

ID returns the request's message ID.

func (SaveReplayBufferRequest) Receive 

func (r SaveReplayBufferRequest) Receive() (SaveReplayBufferResponse, error)

Receive waits for the response.

func (*SaveReplayBufferRequest) Send 

func (r *SaveReplayBufferRequest) Send(c Client) error

Send sends the request.

func (SaveReplayBufferRequest) SendReceive 

func (r SaveReplayBufferRequest) SendReceive(c Client) (SaveReplayBufferResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SaveReplayBufferRequest) Type 

func (r SaveReplayBufferRequest) Type() string

Type returns the request's message type.

type SaveReplayBufferResponse 

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

SaveReplayBufferResponse : Response for SaveReplayBufferRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#savereplaybuffer

func (SaveReplayBufferResponse) Error 

func (r SaveReplayBufferResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SaveReplayBufferResponse) ID 

func (r SaveReplayBufferResponse) ID() string

ID returns the response's message ID.

func (SaveReplayBufferResponse) Status 

func (r SaveReplayBufferResponse) Status() string

Status returns the response's status.

type SaveStreamSettingsRequest 

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

SaveStreamSettingsRequest : Save the current streaming server settings to disk.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#savestreamsettings

func NewSaveStreamSettingsRequest 

func NewSaveStreamSettingsRequest() SaveStreamSettingsRequest

NewSaveStreamSettingsRequest returns a new SaveStreamSettingsRequest.

func (SaveStreamSettingsRequest) ID 

func (r SaveStreamSettingsRequest) ID() string

ID returns the request's message ID.

func (SaveStreamSettingsRequest) Receive 

func (r SaveStreamSettingsRequest) Receive() (SaveStreamSettingsResponse, error)

Receive waits for the response.

func (*SaveStreamSettingsRequest) Send 

func (r *SaveStreamSettingsRequest) Send(c Client) error

Send sends the request.

func (SaveStreamSettingsRequest) SendReceive 

func (r SaveStreamSettingsRequest) SendReceive(c Client) (SaveStreamSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SaveStreamSettingsRequest) Type 

func (r SaveStreamSettingsRequest) Type() string

Type returns the request's message type.

type SaveStreamSettingsResponse 

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

SaveStreamSettingsResponse : Response for SaveStreamSettingsRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#savestreamsettings

func (SaveStreamSettingsResponse) Error 

func (r SaveStreamSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SaveStreamSettingsResponse) ID 

func (r SaveStreamSettingsResponse) ID() string

ID returns the response's message ID.

func (SaveStreamSettingsResponse) Status 

func (r SaveStreamSettingsResponse) Status() string

Status returns the response's status.

type SceneCollectionChangedEvent 

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

SceneCollectionChangedEvent : Triggered when switching to another scene collection or when renaming the current scene collection.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#scenecollectionchanged

func (SceneCollectionChangedEvent) RecTimecode 

func (e SceneCollectionChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SceneCollectionChangedEvent) StreamTimecode 

func (e SceneCollectionChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SceneCollectionChangedEvent) Type 

func (e SceneCollectionChangedEvent) Type() string

Type returns the event's update type.

type SceneCollectionListChangedEvent 

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

SceneCollectionListChangedEvent : Triggered when a scene collection is created, added, renamed, or removed.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#scenecollectionlistchanged

func (SceneCollectionListChangedEvent) RecTimecode 

func (e SceneCollectionListChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SceneCollectionListChangedEvent) StreamTimecode 

func (e SceneCollectionListChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SceneCollectionListChangedEvent) Type 

func (e SceneCollectionListChangedEvent) Type() string

Type returns the event's update type.

type SceneItemAddedEvent 

type SceneItemAddedEvent struct {
	// Name of the scene.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// Name of the item added to the scene.
	// Required: Yes.
	ItemName string `json:"item-name"`
	// contains filtered or unexported fields
}

SceneItemAddedEvent : An item has been added to the current scene.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#sceneitemadded

func (SceneItemAddedEvent) RecTimecode 

func (e SceneItemAddedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SceneItemAddedEvent) StreamTimecode 

func (e SceneItemAddedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SceneItemAddedEvent) Type 

func (e SceneItemAddedEvent) Type() string

Type returns the event's update type.

type SceneItemRemovedEvent 

type SceneItemRemovedEvent struct {
	// Name of the scene.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// Name of the item removed from the scene.
	// Required: Yes.
	ItemName string `json:"item-name"`
	// contains filtered or unexported fields
}

SceneItemRemovedEvent : An item has been removed from the current scene.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#sceneitemremoved

func (SceneItemRemovedEvent) RecTimecode 

func (e SceneItemRemovedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SceneItemRemovedEvent) StreamTimecode 

func (e SceneItemRemovedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SceneItemRemovedEvent) Type 

func (e SceneItemRemovedEvent) Type() string

Type returns the event's update type.

type SceneItemVisibilityChangedEvent 

type SceneItemVisibilityChangedEvent struct {
	// Name of the scene.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// Name of the item in the scene.
	// Required: Yes.
	ItemName string `json:"item-name"`
	// New visibility state of the item.
	// Required: Yes.
	ItemVisible bool `json:"item-visible"`
	// contains filtered or unexported fields
}

SceneItemVisibilityChangedEvent : An item's visibility has been toggled.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#sceneitemvisibilitychanged

func (SceneItemVisibilityChangedEvent) RecTimecode 

func (e SceneItemVisibilityChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SceneItemVisibilityChangedEvent) StreamTimecode 

func (e SceneItemVisibilityChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SceneItemVisibilityChangedEvent) Type 

func (e SceneItemVisibilityChangedEvent) Type() string

Type returns the event's update type.

type ScenesChangedEvent 

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

ScenesChangedEvent : The scene list has been modified. Scenes have been added, removed, or renamed.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#sceneschanged

func (ScenesChangedEvent) RecTimecode 

func (e ScenesChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (ScenesChangedEvent) StreamTimecode 

func (e ScenesChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (ScenesChangedEvent) Type 

func (e ScenesChangedEvent) Type() string

Type returns the event's update type.

type SetBrowserSourcePropertiesRequest 

type SetBrowserSourcePropertiesRequest struct {
	// Name of the source.
	// Required: Yes.
	Source string `json:"source"`
	// Indicates that a local file is in use.
	// Required: No.
	IsLocalFile bool `json:"is_local_file"`
	// file path.
	// Required: No.
	LocalFile string `json:"local_file"`
	// Url.
	// Required: No.
	Url string `json:"url"`
	// CSS to inject.
	// Required: No.
	Css string `json:"css"`
	// Width.
	// Required: No.
	Width int `json:"width"`
	// Height.
	// Required: No.
	Height int `json:"height"`
	// Framerate.
	// Required: No.
	FPS int `json:"fps"`
	// Indicates whether the source should be shutdown when not visible.
	// Required: No.
	Shutdown bool `json:"shutdown"`
	// Visibility of the scene item.
	// Required: No.
	Render bool `json:"render"`
	// contains filtered or unexported fields
}

SetBrowserSourcePropertiesRequest : Set current properties for a Browser Source.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setbrowsersourceproperties

func NewSetBrowserSourcePropertiesRequest 

func NewSetBrowserSourcePropertiesRequest(
	source string,
	isLocalFile bool,
	localFile string,
	url string,
	css string,
	width int,
	height int,
	fps int,
	shutdown bool,
	render bool,
) SetBrowserSourcePropertiesRequest

NewSetBrowserSourcePropertiesRequest returns a new SetBrowserSourcePropertiesRequest.

func (SetBrowserSourcePropertiesRequest) ID 

func (r SetBrowserSourcePropertiesRequest) ID() string

ID returns the request's message ID.

func (SetBrowserSourcePropertiesRequest) Receive 

func (r SetBrowserSourcePropertiesRequest) Receive() (SetBrowserSourcePropertiesResponse, error)

Receive waits for the response.

func (*SetBrowserSourcePropertiesRequest) Send 

func (r *SetBrowserSourcePropertiesRequest) Send(c Client) error

Send sends the request.

func (SetBrowserSourcePropertiesRequest) SendReceive 

func (r SetBrowserSourcePropertiesRequest) SendReceive(c Client) (SetBrowserSourcePropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetBrowserSourcePropertiesRequest) Type 

func (r SetBrowserSourcePropertiesRequest) Type() string

Type returns the request's message type.

type SetBrowserSourcePropertiesResponse 

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

SetBrowserSourcePropertiesResponse : Response for SetBrowserSourcePropertiesRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setbrowsersourceproperties

func (SetBrowserSourcePropertiesResponse) Error 

func (r SetBrowserSourcePropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetBrowserSourcePropertiesResponse) ID 

func (r SetBrowserSourcePropertiesResponse) ID() string

ID returns the response's message ID.

func (SetBrowserSourcePropertiesResponse) Status 

func (r SetBrowserSourcePropertiesResponse) Status() string

Status returns the response's status.

type SetCurrentProfileRequest 

type SetCurrentProfileRequest struct {
	// Name of the desired profile.
	// Required: Yes.
	ProfileName string `json:"profile-name"`
	// contains filtered or unexported fields
}

SetCurrentProfileRequest : Set the currently active profile.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentprofile

func NewSetCurrentProfileRequest 

func NewSetCurrentProfileRequest(profileName string) SetCurrentProfileRequest

NewSetCurrentProfileRequest returns a new SetCurrentProfileRequest.

func (SetCurrentProfileRequest) ID 

func (r SetCurrentProfileRequest) ID() string

ID returns the request's message ID.

func (SetCurrentProfileRequest) Receive 

func (r SetCurrentProfileRequest) Receive() (SetCurrentProfileResponse, error)

Receive waits for the response.

func (*SetCurrentProfileRequest) Send 

func (r *SetCurrentProfileRequest) Send(c Client) error

Send sends the request.

func (SetCurrentProfileRequest) SendReceive 

func (r SetCurrentProfileRequest) SendReceive(c Client) (SetCurrentProfileResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetCurrentProfileRequest) Type 

func (r SetCurrentProfileRequest) Type() string

Type returns the request's message type.

type SetCurrentProfileResponse 

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

SetCurrentProfileResponse : Response for SetCurrentProfileRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentprofile

func (SetCurrentProfileResponse) Error 

func (r SetCurrentProfileResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetCurrentProfileResponse) ID 

func (r SetCurrentProfileResponse) ID() string

ID returns the response's message ID.

func (SetCurrentProfileResponse) Status 

func (r SetCurrentProfileResponse) Status() string

Status returns the response's status.

type SetCurrentSceneCollectionRequest 

type SetCurrentSceneCollectionRequest struct {
	// Name of the desired scene collection.
	// Required: Yes.
	ScName string `json:"sc-name"`
	// contains filtered or unexported fields
}

SetCurrentSceneCollectionRequest : Change the active scene collection.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentscenecollection

func NewSetCurrentSceneCollectionRequest 

func NewSetCurrentSceneCollectionRequest(scName string) SetCurrentSceneCollectionRequest

NewSetCurrentSceneCollectionRequest returns a new SetCurrentSceneCollectionRequest.

func (SetCurrentSceneCollectionRequest) ID 

func (r SetCurrentSceneCollectionRequest) ID() string

ID returns the request's message ID.

func (SetCurrentSceneCollectionRequest) Receive 

func (r SetCurrentSceneCollectionRequest) Receive() (SetCurrentSceneCollectionResponse, error)

Receive waits for the response.

func (*SetCurrentSceneCollectionRequest) Send 

func (r *SetCurrentSceneCollectionRequest) Send(c Client) error

Send sends the request.

func (SetCurrentSceneCollectionRequest) SendReceive 

func (r SetCurrentSceneCollectionRequest) SendReceive(c Client) (SetCurrentSceneCollectionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetCurrentSceneCollectionRequest) Type 

func (r SetCurrentSceneCollectionRequest) Type() string

Type returns the request's message type.

type SetCurrentSceneCollectionResponse 

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

SetCurrentSceneCollectionResponse : Response for SetCurrentSceneCollectionRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentscenecollection

func (SetCurrentSceneCollectionResponse) Error 

func (r SetCurrentSceneCollectionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetCurrentSceneCollectionResponse) ID 

func (r SetCurrentSceneCollectionResponse) ID() string

ID returns the response's message ID.

func (SetCurrentSceneCollectionResponse) Status 

func (r SetCurrentSceneCollectionResponse) Status() string

Status returns the response's status.

type SetCurrentSceneRequest 

type SetCurrentSceneRequest struct {
	// Name of the scene to switch to.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// contains filtered or unexported fields
}

SetCurrentSceneRequest : Switch to the specified scene.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentscene

func NewSetCurrentSceneRequest 

func NewSetCurrentSceneRequest(sceneName string) SetCurrentSceneRequest

NewSetCurrentSceneRequest returns a new SetCurrentSceneRequest.

func (SetCurrentSceneRequest) ID 

func (r SetCurrentSceneRequest) ID() string

ID returns the request's message ID.

func (SetCurrentSceneRequest) Receive 

func (r SetCurrentSceneRequest) Receive() (SetCurrentSceneResponse, error)

Receive waits for the response.

func (*SetCurrentSceneRequest) Send 

func (r *SetCurrentSceneRequest) Send(c Client) error

Send sends the request.

func (SetCurrentSceneRequest) SendReceive 

func (r SetCurrentSceneRequest) SendReceive(c Client) (SetCurrentSceneResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetCurrentSceneRequest) Type 

func (r SetCurrentSceneRequest) Type() string

Type returns the request's message type.

type SetCurrentSceneResponse 

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

SetCurrentSceneResponse : Response for SetCurrentSceneRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrentscene

func (SetCurrentSceneResponse) Error 

func (r SetCurrentSceneResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetCurrentSceneResponse) ID 

func (r SetCurrentSceneResponse) ID() string

ID returns the response's message ID.

func (SetCurrentSceneResponse) Status 

func (r SetCurrentSceneResponse) Status() string

Status returns the response's status.

type SetCurrentTransitionRequest 

type SetCurrentTransitionRequest struct {
	// The name of the transition.
	// Required: Yes.
	TransitionName string `json:"transition-name"`
	// contains filtered or unexported fields
}

SetCurrentTransitionRequest : Set the active transition.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrenttransition

func NewSetCurrentTransitionRequest 

func NewSetCurrentTransitionRequest(transitionName string) SetCurrentTransitionRequest

NewSetCurrentTransitionRequest returns a new SetCurrentTransitionRequest.

func (SetCurrentTransitionRequest) ID 

func (r SetCurrentTransitionRequest) ID() string

ID returns the request's message ID.

func (SetCurrentTransitionRequest) Receive 

func (r SetCurrentTransitionRequest) Receive() (SetCurrentTransitionResponse, error)

Receive waits for the response.

func (*SetCurrentTransitionRequest) Send 

func (r *SetCurrentTransitionRequest) Send(c Client) error

Send sends the request.

func (SetCurrentTransitionRequest) SendReceive 

func (r SetCurrentTransitionRequest) SendReceive(c Client) (SetCurrentTransitionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetCurrentTransitionRequest) Type 

func (r SetCurrentTransitionRequest) Type() string

Type returns the request's message type.

type SetCurrentTransitionResponse 

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

SetCurrentTransitionResponse : Response for SetCurrentTransitionRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setcurrenttransition

func (SetCurrentTransitionResponse) Error 

func (r SetCurrentTransitionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetCurrentTransitionResponse) ID 

func (r SetCurrentTransitionResponse) ID() string

ID returns the response's message ID.

func (SetCurrentTransitionResponse) Status 

func (r SetCurrentTransitionResponse) Status() string

Status returns the response's status.

type SetFilenameFormattingRequest 

type SetFilenameFormattingRequest struct {
	// Filename formatting string to set.
	// Required: Yes.
	FilenameFormatting string `json:"filename-formatting"`
	// contains filtered or unexported fields
}

SetFilenameFormattingRequest : Set the filename formatting string.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setfilenameformatting

func NewSetFilenameFormattingRequest 

func NewSetFilenameFormattingRequest(filenameFormatting string) SetFilenameFormattingRequest

NewSetFilenameFormattingRequest returns a new SetFilenameFormattingRequest.

func (SetFilenameFormattingRequest) ID 

func (r SetFilenameFormattingRequest) ID() string

ID returns the request's message ID.

func (SetFilenameFormattingRequest) Receive 

func (r SetFilenameFormattingRequest) Receive() (SetFilenameFormattingResponse, error)

Receive waits for the response.

func (*SetFilenameFormattingRequest) Send 

func (r *SetFilenameFormattingRequest) Send(c Client) error

Send sends the request.

func (SetFilenameFormattingRequest) SendReceive 

func (r SetFilenameFormattingRequest) SendReceive(c Client) (SetFilenameFormattingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetFilenameFormattingRequest) Type 

func (r SetFilenameFormattingRequest) Type() string

Type returns the request's message type.

type SetFilenameFormattingResponse 

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

SetFilenameFormattingResponse : Response for SetFilenameFormattingRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setfilenameformatting

func (SetFilenameFormattingResponse) Error 

func (r SetFilenameFormattingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetFilenameFormattingResponse) ID 

func (r SetFilenameFormattingResponse) ID() string

ID returns the response's message ID.

func (SetFilenameFormattingResponse) Status 

func (r SetFilenameFormattingResponse) Status() string

Status returns the response's status.

type SetHeartbeatRequest 

type SetHeartbeatRequest struct {
	// Starts/Stops emitting heartbeat messages.
	// Required: Yes.
	Enable bool `json:"enable"`
	// contains filtered or unexported fields
}

SetHeartbeatRequest : Enable/disable sending of the Heartbeat event.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setheartbeat

func NewSetHeartbeatRequest 

func NewSetHeartbeatRequest(enable bool) SetHeartbeatRequest

NewSetHeartbeatRequest returns a new SetHeartbeatRequest.

func (SetHeartbeatRequest) ID 

func (r SetHeartbeatRequest) ID() string

ID returns the request's message ID.

func (SetHeartbeatRequest) Receive 

func (r SetHeartbeatRequest) Receive() (SetHeartbeatResponse, error)

Receive waits for the response.

func (*SetHeartbeatRequest) Send 

func (r *SetHeartbeatRequest) Send(c Client) error

Send sends the request.

func (SetHeartbeatRequest) SendReceive 

func (r SetHeartbeatRequest) SendReceive(c Client) (SetHeartbeatResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetHeartbeatRequest) Type 

func (r SetHeartbeatRequest) Type() string

Type returns the request's message type.

type SetHeartbeatResponse 

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

SetHeartbeatResponse : Response for SetHeartbeatRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setheartbeat

func (SetHeartbeatResponse) Error 

func (r SetHeartbeatResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetHeartbeatResponse) ID 

func (r SetHeartbeatResponse) ID() string

ID returns the response's message ID.

func (SetHeartbeatResponse) Status 

func (r SetHeartbeatResponse) Status() string

Status returns the response's status.

type SetMuteRequest 

type SetMuteRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Desired mute status.
	// Required: Yes.
	Mute bool `json:"mute"`
	// contains filtered or unexported fields
}

SetMuteRequest : Sets the mute status of a specified source.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setmute

func NewSetMuteRequest 

func NewSetMuteRequest(
	source string,
	mute bool,
) SetMuteRequest

NewSetMuteRequest returns a new SetMuteRequest.

func (SetMuteRequest) ID 

func (r SetMuteRequest) ID() string

ID returns the request's message ID.

func (SetMuteRequest) Receive 

func (r SetMuteRequest) Receive() (SetMuteResponse, error)

Receive waits for the response.

func (*SetMuteRequest) Send 

func (r *SetMuteRequest) Send(c Client) error

Send sends the request.

func (SetMuteRequest) SendReceive 

func (r SetMuteRequest) SendReceive(c Client) (SetMuteResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetMuteRequest) Type 

func (r SetMuteRequest) Type() string

Type returns the request's message type.

type SetMuteResponse 

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

SetMuteResponse : Response for SetMuteRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setmute

func (SetMuteResponse) Error 

func (r SetMuteResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetMuteResponse) ID 

func (r SetMuteResponse) ID() string

ID returns the response's message ID.

func (SetMuteResponse) Status 

func (r SetMuteResponse) Status() string

Status returns the response's status.

type SetPreviewSceneRequest 

type SetPreviewSceneRequest struct {
	// The name of the scene to preview.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// contains filtered or unexported fields
}

SetPreviewSceneRequest : Set the active preview scene. Will return an `error` if Studio Mode is not enabled.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setpreviewscene

func NewSetPreviewSceneRequest 

func NewSetPreviewSceneRequest(sceneName string) SetPreviewSceneRequest

NewSetPreviewSceneRequest returns a new SetPreviewSceneRequest.

func (SetPreviewSceneRequest) ID 

func (r SetPreviewSceneRequest) ID() string

ID returns the request's message ID.

func (SetPreviewSceneRequest) Receive 

func (r SetPreviewSceneRequest) Receive() (SetPreviewSceneResponse, error)

Receive waits for the response.

func (*SetPreviewSceneRequest) Send 

func (r *SetPreviewSceneRequest) Send(c Client) error

Send sends the request.

func (SetPreviewSceneRequest) SendReceive 

func (r SetPreviewSceneRequest) SendReceive(c Client) (SetPreviewSceneResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetPreviewSceneRequest) Type 

func (r SetPreviewSceneRequest) Type() string

Type returns the request's message type.

type SetPreviewSceneResponse 

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

SetPreviewSceneResponse : Response for SetPreviewSceneRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setpreviewscene

func (SetPreviewSceneResponse) Error 

func (r SetPreviewSceneResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetPreviewSceneResponse) ID 

func (r SetPreviewSceneResponse) ID() string

ID returns the response's message ID.

func (SetPreviewSceneResponse) Status 

func (r SetPreviewSceneResponse) Status() string

Status returns the response's status.

type SetRecordingFolderRequest 

type SetRecordingFolderRequest struct {
	// Path of the recording folder.
	// Required: Yes.
	RecFolder string `json:"rec-folder"`
	// contains filtered or unexported fields
}

SetRecordingFolderRequest : Change the current recording folder.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setrecordingfolder

func NewSetRecordingFolderRequest 

func NewSetRecordingFolderRequest(recFolder string) SetRecordingFolderRequest

NewSetRecordingFolderRequest returns a new SetRecordingFolderRequest.

func (SetRecordingFolderRequest) ID 

func (r SetRecordingFolderRequest) ID() string

ID returns the request's message ID.

func (SetRecordingFolderRequest) Receive 

func (r SetRecordingFolderRequest) Receive() (SetRecordingFolderResponse, error)

Receive waits for the response.

func (*SetRecordingFolderRequest) Send 

func (r *SetRecordingFolderRequest) Send(c Client) error

Send sends the request.

func (SetRecordingFolderRequest) SendReceive 

func (r SetRecordingFolderRequest) SendReceive(c Client) (SetRecordingFolderResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetRecordingFolderRequest) Type 

func (r SetRecordingFolderRequest) Type() string

Type returns the request's message type.

type SetRecordingFolderResponse 

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

SetRecordingFolderResponse : Response for SetRecordingFolderRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setrecordingfolder

func (SetRecordingFolderResponse) Error 

func (r SetRecordingFolderResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetRecordingFolderResponse) ID 

func (r SetRecordingFolderResponse) ID() string

ID returns the response's message ID.

func (SetRecordingFolderResponse) Status 

func (r SetRecordingFolderResponse) Status() string

Status returns the response's status.

type SetSceneItemCropRequest 

type SetSceneItemCropRequest struct {
	// the name of the scene that the source item belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// The name of the source.
	// Required: Yes.
	Item string `json:"item"`
	// Pixel position of the top of the source item.
	// Required: Yes.
	Top int `json:"top"`
	// Pixel position of the bottom of the source item.
	// Required: Yes.
	Bottom int `json:"bottom"`
	// Pixel position of the left of the source item.
	// Required: Yes.
	Left int `json:"left"`
	// Pixel position of the right of the source item.
	// Required: Yes.
	Right int `json:"right"`
	// contains filtered or unexported fields
}

SetSceneItemCropRequest : Sets the crop coordinates of the specified source item.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemcrop

func NewSetSceneItemCropRequest 

func NewSetSceneItemCropRequest(
	sceneName string,
	item string,
	top int,
	bottom int,
	left int,
	right int,
) SetSceneItemCropRequest

NewSetSceneItemCropRequest returns a new SetSceneItemCropRequest.

func (SetSceneItemCropRequest) ID 

func (r SetSceneItemCropRequest) ID() string

ID returns the request's message ID.

func (SetSceneItemCropRequest) Receive 

func (r SetSceneItemCropRequest) Receive() (SetSceneItemCropResponse, error)

Receive waits for the response.

func (*SetSceneItemCropRequest) Send 

func (r *SetSceneItemCropRequest) Send(c Client) error

Send sends the request.

func (SetSceneItemCropRequest) SendReceive 

func (r SetSceneItemCropRequest) SendReceive(c Client) (SetSceneItemCropResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSceneItemCropRequest) Type 

func (r SetSceneItemCropRequest) Type() string

Type returns the request's message type.

type SetSceneItemCropResponse 

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

SetSceneItemCropResponse : Response for SetSceneItemCropRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemcrop

func (SetSceneItemCropResponse) Error 

func (r SetSceneItemCropResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSceneItemCropResponse) ID 

func (r SetSceneItemCropResponse) ID() string

ID returns the response's message ID.

func (SetSceneItemCropResponse) Status 

func (r SetSceneItemCropResponse) Status() string

Status returns the response's status.

type SetSceneItemPositionRequest 

type SetSceneItemPositionRequest struct {
	// The name of the scene that the source item belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// The name of the source item.
	// Required: Yes.
	Item string `json:"item"`
	// X coordinate.
	// Required: Yes.
	X float64 `json:"x"`
	// Y coordinate.
	// Required: Yes.
	Y float64 `json:"y"`
	// contains filtered or unexported fields
}

SetSceneItemPositionRequest : Sets the coordinates of a specified source item.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemposition

func NewSetSceneItemPositionRequest 

func NewSetSceneItemPositionRequest(
	sceneName string,
	item string,
	x float64,
	y float64,
) SetSceneItemPositionRequest

NewSetSceneItemPositionRequest returns a new SetSceneItemPositionRequest.

func (SetSceneItemPositionRequest) ID 

func (r SetSceneItemPositionRequest) ID() string

ID returns the request's message ID.

func (SetSceneItemPositionRequest) Receive 

func (r SetSceneItemPositionRequest) Receive() (SetSceneItemPositionResponse, error)

Receive waits for the response.

func (*SetSceneItemPositionRequest) Send 

func (r *SetSceneItemPositionRequest) Send(c Client) error

Send sends the request.

func (SetSceneItemPositionRequest) SendReceive 

func (r SetSceneItemPositionRequest) SendReceive(c Client) (SetSceneItemPositionResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSceneItemPositionRequest) Type 

func (r SetSceneItemPositionRequest) Type() string

Type returns the request's message type.

type SetSceneItemPositionResponse 

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

SetSceneItemPositionResponse : Response for SetSceneItemPositionRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemposition

func (SetSceneItemPositionResponse) Error 

func (r SetSceneItemPositionResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSceneItemPositionResponse) ID 

func (r SetSceneItemPositionResponse) ID() string

ID returns the response's message ID.

func (SetSceneItemPositionResponse) Status 

func (r SetSceneItemPositionResponse) Status() string

Status returns the response's status.

type SetSceneItemPropertiesRequest 

type SetSceneItemPropertiesRequest struct {
	// the name of the scene that the source item belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// The name of the source.
	// Required: Yes.
	Item string `json:"item"`
	// The new x position of the source.
	// Required: Yes.
	PositionX int `json:"position.x"`
	// The new y position of the source.
	// Required: Yes.
	PositionY int `json:"position.y"`
	// The new alignment of the source.
	// Required: Yes.
	PositionAlignment int `json:"position.alignment"`
	// The new clockwise rotation of the item in degrees.
	// Required: Yes.
	Rotation float64 `json:"rotation"`
	// The new x scale of the item.
	// Required: Yes.
	ScaleX float64 `json:"scale.x"`
	// The new y scale of the item.
	// Required: Yes.
	ScaleY float64 `json:"scale.y"`
	// The new amount of pixels cropped off the top of the source before scaling.
	// Required: Yes.
	CropTop int `json:"crop.top"`
	// The new amount of pixels cropped off the bottom of the source before scaling.
	// Required: Yes.
	CropBottom int `json:"crop.bottom"`
	// The new amount of pixels cropped off the left of the source before scaling.
	// Required: Yes.
	CropLeft int `json:"crop.left"`
	// The new amount of pixels cropped off the right of the source before scaling.
	// Required: Yes.
	CropRight int `json:"crop.right"`
	// The new visibility of the source.
	// 'true' shows source, 'false' hides source.
	// Required: Yes.
	Visible bool `json:"visible"`
	// The new bounds type of the source.
	// Required: Yes.
	BoundsType string `json:"bounds.type"`
	// The new alignment of the bounding box.
	// (0-2, 4-6, 8-10).
	// Required: Yes.
	BoundsAlignment int `json:"bounds.alignment"`
	// The new width of the bounding box.
	// Required: Yes.
	BoundsX float64 `json:"bounds.x"`
	// The new height of the bounding box.
	// Required: Yes.
	BoundsY float64 `json:"bounds.y"`
	// contains filtered or unexported fields
}

SetSceneItemPropertiesRequest : Sets the scene specific properties of a source Unspecified properties will remain unchanged.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemproperties

func NewSetSceneItemPropertiesRequest 

func NewSetSceneItemPropertiesRequest(
	sceneName string,
	item string,
	positionX int,
	positionY int,
	positionAlignment int,
	rotation float64,
	scaleX float64,
	scaleY float64,
	cropTop int,
	cropBottom int,
	cropLeft int,
	cropRight int,
	visible bool,
	boundsType string,
	boundsAlignment int,
	boundsX float64,
	boundsY float64,
) SetSceneItemPropertiesRequest

NewSetSceneItemPropertiesRequest returns a new SetSceneItemPropertiesRequest.

func (SetSceneItemPropertiesRequest) ID 

func (r SetSceneItemPropertiesRequest) ID() string

ID returns the request's message ID.

func (SetSceneItemPropertiesRequest) Receive 

func (r SetSceneItemPropertiesRequest) Receive() (SetSceneItemPropertiesResponse, error)

Receive waits for the response.

func (*SetSceneItemPropertiesRequest) Send 

func (r *SetSceneItemPropertiesRequest) Send(c Client) error

Send sends the request.

func (SetSceneItemPropertiesRequest) SendReceive 

func (r SetSceneItemPropertiesRequest) SendReceive(c Client) (SetSceneItemPropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSceneItemPropertiesRequest) Type 

func (r SetSceneItemPropertiesRequest) Type() string

Type returns the request's message type.

type SetSceneItemPropertiesResponse 

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

SetSceneItemPropertiesResponse : Response for SetSceneItemPropertiesRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemproperties

func (SetSceneItemPropertiesResponse) Error 

func (r SetSceneItemPropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSceneItemPropertiesResponse) ID 

func (r SetSceneItemPropertiesResponse) ID() string

ID returns the response's message ID.

func (SetSceneItemPropertiesResponse) Status 

func (r SetSceneItemPropertiesResponse) Status() string

Status returns the response's status.

type SetSceneItemRenderRequest 

type SetSceneItemRenderRequest struct {
	// Scene item name in the specified scene.
	// Required: Yes.
	Source string `json:"source"`
	// true = shown ; false = hidden.
	// Required: Yes.
	Render bool `json:"render"`
	// Name of the scene where the source resides.
	// Defaults to the currently active scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// contains filtered or unexported fields
}

SetSceneItemRenderRequest : Show or hide a specified source item in a specified scene.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemrender

func NewSetSceneItemRenderRequest 

func NewSetSceneItemRenderRequest(
	source string,
	render bool,
	sceneName string,
) SetSceneItemRenderRequest

NewSetSceneItemRenderRequest returns a new SetSceneItemRenderRequest.

func (SetSceneItemRenderRequest) ID 

func (r SetSceneItemRenderRequest) ID() string

ID returns the request's message ID.

func (SetSceneItemRenderRequest) Receive 

func (r SetSceneItemRenderRequest) Receive() (SetSceneItemRenderResponse, error)

Receive waits for the response.

func (*SetSceneItemRenderRequest) Send 

func (r *SetSceneItemRenderRequest) Send(c Client) error

Send sends the request.

func (SetSceneItemRenderRequest) SendReceive 

func (r SetSceneItemRenderRequest) SendReceive(c Client) (SetSceneItemRenderResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSceneItemRenderRequest) Type 

func (r SetSceneItemRenderRequest) Type() string

Type returns the request's message type.

type SetSceneItemRenderResponse 

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

SetSceneItemRenderResponse : Response for SetSceneItemRenderRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemrender

func (SetSceneItemRenderResponse) Error 

func (r SetSceneItemRenderResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSceneItemRenderResponse) ID 

func (r SetSceneItemRenderResponse) ID() string

ID returns the response's message ID.

func (SetSceneItemRenderResponse) Status 

func (r SetSceneItemRenderResponse) Status() string

Status returns the response's status.

type SetSceneItemTransformRequest 

type SetSceneItemTransformRequest struct {
	// The name of the scene that the source item belongs to.
	// Defaults to the current scene.
	// Required: No.
	SceneName string `json:"scene-name"`
	// The name of the source item.
	// Required: Yes.
	Item string `json:"item"`
	// Width scale factor.
	// Required: Yes.
	XScale float64 `json:"x-scale"`
	// Height scale factor.
	// Required: Yes.
	YScale float64 `json:"y-scale"`
	// Source item rotation (in degrees).
	// Required: Yes.
	Rotation float64 `json:"rotation"`
	// contains filtered or unexported fields
}

SetSceneItemTransformRequest : Set the transform of the specified source item.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemtransform

func NewSetSceneItemTransformRequest 

func NewSetSceneItemTransformRequest(
	sceneName string,
	item string,
	xScale float64,
	yScale float64,
	rotation float64,
) SetSceneItemTransformRequest

NewSetSceneItemTransformRequest returns a new SetSceneItemTransformRequest.

func (SetSceneItemTransformRequest) ID 

func (r SetSceneItemTransformRequest) ID() string

ID returns the request's message ID.

func (SetSceneItemTransformRequest) Receive 

func (r SetSceneItemTransformRequest) Receive() (SetSceneItemTransformResponse, error)

Receive waits for the response.

func (*SetSceneItemTransformRequest) Send 

func (r *SetSceneItemTransformRequest) Send(c Client) error

Send sends the request.

func (SetSceneItemTransformRequest) SendReceive 

func (r SetSceneItemTransformRequest) SendReceive(c Client) (SetSceneItemTransformResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSceneItemTransformRequest) Type 

func (r SetSceneItemTransformRequest) Type() string

Type returns the request's message type.

type SetSceneItemTransformResponse 

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

SetSceneItemTransformResponse : Response for SetSceneItemTransformRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setsceneitemtransform

func (SetSceneItemTransformResponse) Error 

func (r SetSceneItemTransformResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSceneItemTransformResponse) ID 

func (r SetSceneItemTransformResponse) ID() string

ID returns the response's message ID.

func (SetSceneItemTransformResponse) Status 

func (r SetSceneItemTransformResponse) Status() string

Status returns the response's status.

type SetSourceFilterSettingsRequest 

type SetSourceFilterSettingsRequest struct {
	// Name of the source to which the filter belongs.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Name of the filter to reconfigure.
	// Required: Yes.
	FilterName string `json:"filterName"`
	// New settings.
	// These will be merged to the current filter settings.
	// Required: Yes.
	FilterSettings map[string]interface{} `json:"filterSettings"`
	// contains filtered or unexported fields
}

SetSourceFilterSettingsRequest : Update settings of a filter.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsourcefiltersettings

func NewSetSourceFilterSettingsRequest 

func NewSetSourceFilterSettingsRequest(
	sourceName string,
	filterName string,
	filterSettings map[string]interface{},
) SetSourceFilterSettingsRequest

NewSetSourceFilterSettingsRequest returns a new SetSourceFilterSettingsRequest.

func (SetSourceFilterSettingsRequest) ID 

func (r SetSourceFilterSettingsRequest) ID() string

ID returns the request's message ID.

func (SetSourceFilterSettingsRequest) Receive 

func (r SetSourceFilterSettingsRequest) Receive() (SetSourceFilterSettingsResponse, error)

Receive waits for the response.

func (*SetSourceFilterSettingsRequest) Send 

func (r *SetSourceFilterSettingsRequest) Send(c Client) error

Send sends the request.

func (SetSourceFilterSettingsRequest) SendReceive 

func (r SetSourceFilterSettingsRequest) SendReceive(c Client) (SetSourceFilterSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSourceFilterSettingsRequest) Type 

func (r SetSourceFilterSettingsRequest) Type() string

Type returns the request's message type.

type SetSourceFilterSettingsResponse 

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

SetSourceFilterSettingsResponse : Response for SetSourceFilterSettingsRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsourcefiltersettings

func (SetSourceFilterSettingsResponse) Error 

func (r SetSourceFilterSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSourceFilterSettingsResponse) ID 

func (r SetSourceFilterSettingsResponse) ID() string

ID returns the response's message ID.

func (SetSourceFilterSettingsResponse) Status 

func (r SetSourceFilterSettingsResponse) Status() string

Status returns the response's status.

type SetSourceSettingsRequest 

type SetSourceSettingsRequest struct {
	// Source name.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Type of the specified source.
	// Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type.
	// Required: No.
	SourceType string `json:"sourceType"`
	// Source settings (varies between source types, may require some probing around).
	// Required: Yes.
	SourceSettings map[string]interface{} `json:"sourceSettings"`
	// contains filtered or unexported fields
}

SetSourceSettingsRequest : Set settings of the specified source.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsourcesettings

func NewSetSourceSettingsRequest 

func NewSetSourceSettingsRequest(
	sourceName string,
	sourceType string,
	sourceSettings map[string]interface{},
) SetSourceSettingsRequest

NewSetSourceSettingsRequest returns a new SetSourceSettingsRequest.

func (SetSourceSettingsRequest) ID 

func (r SetSourceSettingsRequest) ID() string

ID returns the request's message ID.

func (SetSourceSettingsRequest) Receive 

func (r SetSourceSettingsRequest) Receive() (SetSourceSettingsResponse, error)

Receive waits for the response.

func (*SetSourceSettingsRequest) Send 

func (r *SetSourceSettingsRequest) Send(c Client) error

Send sends the request.

func (SetSourceSettingsRequest) SendReceive 

func (r SetSourceSettingsRequest) SendReceive(c Client) (SetSourceSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSourceSettingsRequest) Type 

func (r SetSourceSettingsRequest) Type() string

Type returns the request's message type.

type SetSourceSettingsResponse 

type SetSourceSettingsResponse struct {
	// Source name.
	// Required: Yes.
	SourceName string `json:"sourceName"`
	// Type of the specified source.
	// Required: Yes.
	SourceType string `json:"sourceType"`
	// Updated source settings.
	// Required: Yes.
	SourceSettings map[string]interface{} `json:"sourceSettings"`
	// contains filtered or unexported fields
}

SetSourceSettingsResponse : Response for SetSourceSettingsRequest.

Since obs-websocket version: 4.3.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsourcesettings

func (SetSourceSettingsResponse) Error 

func (r SetSourceSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSourceSettingsResponse) ID 

func (r SetSourceSettingsResponse) ID() string

ID returns the response's message ID.

func (SetSourceSettingsResponse) Status 

func (r SetSourceSettingsResponse) Status() string

Status returns the response's status.

type SetStreamSettingsRequest 

type SetStreamSettingsRequest struct {
	// The type of streaming service configuration, usually `rtmp_custom` or `rtmp_common`.
	// Required: Yes.
	StreamType string `json:"type"`
	// The actual settings of the stream.
	// Required: Yes.
	Settings map[string]interface{} `json:"settings"`
	// The publish URL.
	// Required: No.
	SettingsServer string `json:"settings.server"`
	// The publish key.
	// Required: No.
	SettingsKey string `json:"settings.key"`
	// Indicates whether authentication should be used when connecting to the streaming server.
	// Required: No.
	SettingsUseAuth bool `json:"settings.use-auth"`
	// The username for the streaming service.
	// Required: No.
	SettingsUsername string `json:"settings.username"`
	// The password for the streaming service.
	// Required: No.
	SettingsPassword string `json:"settings.password"`
	// Persist the settings to disk.
	// Required: Yes.
	Save bool `json:"save"`
	// contains filtered or unexported fields
}

SetStreamSettingsRequest : Sets one or more attributes of the current streaming server settings Any options not passed will remain unchanged Returns the updated settings in response If 'type' is different than the current streaming service type, all settings are required Returns the full settings of the stream (the same as GetStreamSettings).

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setstreamsettings

func NewSetStreamSettingsRequest 

func NewSetStreamSettingsRequest(
	_type string,
	settings map[string]interface{},
	settingsServer string,
	settingsKey string,
	settingsUseAuth bool,
	settingsUsername string,
	settingsPassword string,
	save bool,
) SetStreamSettingsRequest

NewSetStreamSettingsRequest returns a new SetStreamSettingsRequest.

func (SetStreamSettingsRequest) ID 

func (r SetStreamSettingsRequest) ID() string

ID returns the request's message ID.

func (SetStreamSettingsRequest) Receive 

func (r SetStreamSettingsRequest) Receive() (SetStreamSettingsResponse, error)

Receive waits for the response.

func (*SetStreamSettingsRequest) Send 

func (r *SetStreamSettingsRequest) Send(c Client) error

Send sends the request.

func (SetStreamSettingsRequest) SendReceive 

func (r SetStreamSettingsRequest) SendReceive(c Client) (SetStreamSettingsResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetStreamSettingsRequest) Type 

func (r SetStreamSettingsRequest) Type() string

Type returns the request's message type.

type SetStreamSettingsResponse 

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

SetStreamSettingsResponse : Response for SetStreamSettingsRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#setstreamsettings

func (SetStreamSettingsResponse) Error 

func (r SetStreamSettingsResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetStreamSettingsResponse) ID 

func (r SetStreamSettingsResponse) ID() string

ID returns the response's message ID.

func (SetStreamSettingsResponse) Status 

func (r SetStreamSettingsResponse) Status() string

Status returns the response's status.

type SetSyncOffsetRequest 

type SetSyncOffsetRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// The desired audio sync offset (in nanoseconds).
	// Required: Yes.
	Offset int `json:"offset"`
	// contains filtered or unexported fields
}

SetSyncOffsetRequest : Set the audio sync offset of a specified source.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsyncoffset

func NewSetSyncOffsetRequest 

func NewSetSyncOffsetRequest(
	source string,
	offset int,
) SetSyncOffsetRequest

NewSetSyncOffsetRequest returns a new SetSyncOffsetRequest.

func (SetSyncOffsetRequest) ID 

func (r SetSyncOffsetRequest) ID() string

ID returns the request's message ID.

func (SetSyncOffsetRequest) Receive 

func (r SetSyncOffsetRequest) Receive() (SetSyncOffsetResponse, error)

Receive waits for the response.

func (*SetSyncOffsetRequest) Send 

func (r *SetSyncOffsetRequest) Send(c Client) error

Send sends the request.

func (SetSyncOffsetRequest) SendReceive 

func (r SetSyncOffsetRequest) SendReceive(c Client) (SetSyncOffsetResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetSyncOffsetRequest) Type 

func (r SetSyncOffsetRequest) Type() string

Type returns the request's message type.

type SetSyncOffsetResponse 

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

SetSyncOffsetResponse : Response for SetSyncOffsetRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setsyncoffset

func (SetSyncOffsetResponse) Error 

func (r SetSyncOffsetResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetSyncOffsetResponse) ID 

func (r SetSyncOffsetResponse) ID() string

ID returns the response's message ID.

func (SetSyncOffsetResponse) Status 

func (r SetSyncOffsetResponse) Status() string

Status returns the response's status.

type SetTextFreetype2PropertiesRequest 

type SetTextFreetype2PropertiesRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Gradient top color.
	// Required: No.
	Color1 int `json:"color1"`
	// Gradient bottom color.
	// Required: No.
	Color2 int `json:"color2"`
	// Custom width (0 to disable).
	// Required: No.
	CustomWidth int `json:"custom_width"`
	// Drop shadow.
	// Required: No.
	DropShadow bool `json:"drop_shadow"`
	// Holds data for the font.
	// Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`.
	// Required: No.
	Font map[string]interface{} `json:"font"`
	// Font face.
	// Required: No.
	FontFace string `json:"font.face"`
	// Font text styling flag.
	// `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`.
	// Required: No.
	FontFlags int `json:"font.flags"`
	// Font text size.
	// Required: No.
	FontSize int `json:"font.size"`
	// Font Style (unknown function).
	// Required: No.
	FontStyle string `json:"font.style"`
	// Read text from the specified file.
	// Required: No.
	FromFile bool `json:"from_file"`
	// Chat log.
	// Required: No.
	LogMode bool `json:"log_mode"`
	// Outline.
	// Required: No.
	Outline bool `json:"outline"`
	// Text content to be displayed.
	// Required: No.
	Text string `json:"text"`
	// File path.
	// Required: No.
	TextFile string `json:"text_file"`
	// Word wrap.
	// Required: No.
	WordWrap bool `json:"word_wrap"`
	// contains filtered or unexported fields
}

SetTextFreetype2PropertiesRequest : Set the current properties of a Text Freetype 2 source.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settextfreetype2properties

func NewSetTextFreetype2PropertiesRequest 

func NewSetTextFreetype2PropertiesRequest(
	source string,
	color1 int,
	color2 int,
	customWidth int,
	dropShadow bool,
	font map[string]interface{},
	fontFace string,
	fontFlags int,
	fontSize int,
	fontStyle string,
	fromFile bool,
	logMode bool,
	outline bool,
	text string,
	textFile string,
	wordWrap bool,
) SetTextFreetype2PropertiesRequest

NewSetTextFreetype2PropertiesRequest returns a new SetTextFreetype2PropertiesRequest.

func (SetTextFreetype2PropertiesRequest) ID 

func (r SetTextFreetype2PropertiesRequest) ID() string

ID returns the request's message ID.

func (SetTextFreetype2PropertiesRequest) Receive 

func (r SetTextFreetype2PropertiesRequest) Receive() (SetTextFreetype2PropertiesResponse, error)

Receive waits for the response.

func (*SetTextFreetype2PropertiesRequest) Send 

func (r *SetTextFreetype2PropertiesRequest) Send(c Client) error

Send sends the request.

func (SetTextFreetype2PropertiesRequest) SendReceive 

func (r SetTextFreetype2PropertiesRequest) SendReceive(c Client) (SetTextFreetype2PropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetTextFreetype2PropertiesRequest) Type 

func (r SetTextFreetype2PropertiesRequest) Type() string

Type returns the request's message type.

type SetTextFreetype2PropertiesResponse 

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

SetTextFreetype2PropertiesResponse : Response for SetTextFreetype2PropertiesRequest.

Since obs-websocket version: 4.5.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settextfreetype2properties

func (SetTextFreetype2PropertiesResponse) Error 

func (r SetTextFreetype2PropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetTextFreetype2PropertiesResponse) ID 

func (r SetTextFreetype2PropertiesResponse) ID() string

ID returns the response's message ID.

func (SetTextFreetype2PropertiesResponse) Status 

func (r SetTextFreetype2PropertiesResponse) Status() string

Status returns the response's status.

type SetTextGDIPlusPropertiesRequest 

type SetTextGDIPlusPropertiesRequest struct {
	// Name of the source.
	// Required: Yes.
	Source string `json:"source"`
	// Text Alignment ("left", "center", "right").
	// Required: No.
	Align string `json:"align"`
	// Background color.
	// Required: No.
	BkColor int `json:"bk-color"`
	// Background opacity (0-100).
	// Required: No.
	BkOpacity int `json:"bk-opacity"`
	// Chat log.
	// Required: No.
	Chatlog bool `json:"chatlog"`
	// Chat log lines.
	// Required: No.
	ChatlogLines int `json:"chatlog_lines"`
	// Text color.
	// Required: No.
	Color int `json:"color"`
	// Extents wrap.
	// Required: No.
	Extents bool `json:"extents"`
	// Extents cx.
	// Required: No.
	ExtentsCx int `json:"extents_cx"`
	// Extents cy.
	// Required: No.
	ExtentsCy int `json:"extents_cy"`
	// File path name.
	// Required: No.
	File string `json:"file"`
	// Read text from the specified file.
	// Required: No.
	ReadFromFile bool `json:"read_from_file"`
	// Holds data for the font.
	// Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`.
	// Required: No.
	Font map[string]interface{} `json:"font"`
	// Font face.
	// Required: No.
	FontFace string `json:"font.face"`
	// Font text styling flag.
	// `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`.
	// Required: No.
	FontFlags int `json:"font.flags"`
	// Font text size.
	// Required: No.
	FontSize int `json:"font.size"`
	// Font Style (unknown function).
	// Required: No.
	FontStyle string `json:"font.style"`
	// Gradient enabled.
	// Required: No.
	Gradient bool `json:"gradient"`
	// Gradient color.
	// Required: No.
	GradientColor int `json:"gradient_color"`
	// Gradient direction.
	// Required: No.
	GradientDir float64 `json:"gradient_dir"`
	// Gradient opacity (0-100).
	// Required: No.
	GradientOpacity int `json:"gradient_opacity"`
	// Outline.
	// Required: No.
	Outline bool `json:"outline"`
	// Outline color.
	// Required: No.
	OutlineColor int `json:"outline_color"`
	// Outline size.
	// Required: No.
	OutlineSize int `json:"outline_size"`
	// Outline opacity (0-100).
	// Required: No.
	OutlineOpacity int `json:"outline_opacity"`
	// Text content to be displayed.
	// Required: No.
	Text string `json:"text"`
	// Text vertical alignment ("top", "center", "bottom").
	// Required: No.
	Valign string `json:"valign"`
	// Vertical text enabled.
	// Required: No.
	Vertical bool `json:"vertical"`
	// Visibility of the scene item.
	// Required: No.
	Render bool `json:"render"`
	// contains filtered or unexported fields
}

SetTextGDIPlusPropertiesRequest : Set the current properties of a Text GDI Plus source.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settextgdiplusproperties

func NewSetTextGDIPlusPropertiesRequest 

func NewSetTextGDIPlusPropertiesRequest(
	source string,
	align string,
	bkColor int,
	bkOpacity int,
	chatlog bool,
	chatlogLines int,
	color int,
	extents bool,
	extentsCx int,
	extentsCy int,
	file string,
	readFromFile bool,
	font map[string]interface{},
	fontFace string,
	fontFlags int,
	fontSize int,
	fontStyle string,
	gradient bool,
	gradientColor int,
	gradientDir float64,
	gradientOpacity int,
	outline bool,
	outlineColor int,
	outlineSize int,
	outlineOpacity int,
	text string,
	valign string,
	vertical bool,
	render bool,
) SetTextGDIPlusPropertiesRequest

NewSetTextGDIPlusPropertiesRequest returns a new SetTextGDIPlusPropertiesRequest.

func (SetTextGDIPlusPropertiesRequest) ID 

func (r SetTextGDIPlusPropertiesRequest) ID() string

ID returns the request's message ID.

func (SetTextGDIPlusPropertiesRequest) Receive 

func (r SetTextGDIPlusPropertiesRequest) Receive() (SetTextGDIPlusPropertiesResponse, error)

Receive waits for the response.

func (*SetTextGDIPlusPropertiesRequest) Send 

func (r *SetTextGDIPlusPropertiesRequest) Send(c Client) error

Send sends the request.

func (SetTextGDIPlusPropertiesRequest) SendReceive 

func (r SetTextGDIPlusPropertiesRequest) SendReceive(c Client) (SetTextGDIPlusPropertiesResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetTextGDIPlusPropertiesRequest) Type 

func (r SetTextGDIPlusPropertiesRequest) Type() string

Type returns the request's message type.

type SetTextGDIPlusPropertiesResponse 

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

SetTextGDIPlusPropertiesResponse : Response for SetTextGDIPlusPropertiesRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settextgdiplusproperties

func (SetTextGDIPlusPropertiesResponse) Error 

func (r SetTextGDIPlusPropertiesResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetTextGDIPlusPropertiesResponse) ID 

func (r SetTextGDIPlusPropertiesResponse) ID() string

ID returns the response's message ID.

func (SetTextGDIPlusPropertiesResponse) Status 

func (r SetTextGDIPlusPropertiesResponse) Status() string

Status returns the response's status.

type SetTransitionDurationRequest 

type SetTransitionDurationRequest struct {
	// Desired duration of the transition (in milliseconds).
	// Required: Yes.
	Duration int `json:"duration"`
	// contains filtered or unexported fields
}

SetTransitionDurationRequest : Set the duration of the currently selected transition if supported.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settransitionduration

func NewSetTransitionDurationRequest 

func NewSetTransitionDurationRequest(duration int) SetTransitionDurationRequest

NewSetTransitionDurationRequest returns a new SetTransitionDurationRequest.

func (SetTransitionDurationRequest) ID 

func (r SetTransitionDurationRequest) ID() string

ID returns the request's message ID.

func (SetTransitionDurationRequest) Receive 

func (r SetTransitionDurationRequest) Receive() (SetTransitionDurationResponse, error)

Receive waits for the response.

func (*SetTransitionDurationRequest) Send 

func (r *SetTransitionDurationRequest) Send(c Client) error

Send sends the request.

func (SetTransitionDurationRequest) SendReceive 

func (r SetTransitionDurationRequest) SendReceive(c Client) (SetTransitionDurationResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetTransitionDurationRequest) Type 

func (r SetTransitionDurationRequest) Type() string

Type returns the request's message type.

type SetTransitionDurationResponse 

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

SetTransitionDurationResponse : Response for SetTransitionDurationRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#settransitionduration

func (SetTransitionDurationResponse) Error 

func (r SetTransitionDurationResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetTransitionDurationResponse) ID 

func (r SetTransitionDurationResponse) ID() string

ID returns the response's message ID.

func (SetTransitionDurationResponse) Status 

func (r SetTransitionDurationResponse) Status() string

Status returns the response's status.

type SetVolumeRequest 

type SetVolumeRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// Desired volume.
	// Must be between `0.0` and `1.0`.
	// Required: Yes.
	Volume float64 `json:"volume"`
	// contains filtered or unexported fields
}

SetVolumeRequest : Set the volume of the specified source.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setvolume

func NewSetVolumeRequest 

func NewSetVolumeRequest(
	source string,
	volume float64,
) SetVolumeRequest

NewSetVolumeRequest returns a new SetVolumeRequest.

func (SetVolumeRequest) ID 

func (r SetVolumeRequest) ID() string

ID returns the request's message ID.

func (SetVolumeRequest) Receive 

func (r SetVolumeRequest) Receive() (SetVolumeResponse, error)

Receive waits for the response.

func (*SetVolumeRequest) Send 

func (r *SetVolumeRequest) Send(c Client) error

Send sends the request.

func (SetVolumeRequest) SendReceive 

func (r SetVolumeRequest) SendReceive(c Client) (SetVolumeResponse, error)

SendReceive sends the request then immediately waits for the response.

func (SetVolumeRequest) Type 

func (r SetVolumeRequest) Type() string

Type returns the request's message type.

type SetVolumeResponse 

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

SetVolumeResponse : Response for SetVolumeRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#setvolume

func (SetVolumeResponse) Error 

func (r SetVolumeResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (SetVolumeResponse) ID 

func (r SetVolumeResponse) ID() string

ID returns the response's message ID.

func (SetVolumeResponse) Status 

func (r SetVolumeResponse) Status() string

Status returns the response's status.

type SourceOrderChangedEvent 

type SourceOrderChangedEvent struct {
	// Name of the scene where items have been reordered.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// contains filtered or unexported fields
}

SourceOrderChangedEvent : Scene items have been reordered.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#sourceorderchanged

func (SourceOrderChangedEvent) RecTimecode 

func (e SourceOrderChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SourceOrderChangedEvent) StreamTimecode 

func (e SourceOrderChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SourceOrderChangedEvent) Type 

func (e SourceOrderChangedEvent) Type() string

Type returns the event's update type.

type StartOutputRequest 

type StartOutputRequest struct {
	// Output name.
	// Required: Yes.
	OutputName string `json:"outputName"`
	// contains filtered or unexported fields
}

StartOutputRequest : Start an output.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startoutput

func NewStartOutputRequest 

func NewStartOutputRequest(outputName string) StartOutputRequest

NewStartOutputRequest returns a new StartOutputRequest.

func (StartOutputRequest) ID 

func (r StartOutputRequest) ID() string

ID returns the request's message ID.

func (StartOutputRequest) Receive 

func (r StartOutputRequest) Receive() (StartOutputResponse, error)

Receive waits for the response.

func (*StartOutputRequest) Send 

func (r *StartOutputRequest) Send(c Client) error

Send sends the request.

func (StartOutputRequest) SendReceive 

func (r StartOutputRequest) SendReceive(c Client) (StartOutputResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartOutputRequest) Type 

func (r StartOutputRequest) Type() string

Type returns the request's message type.

type StartOutputResponse 

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

StartOutputResponse : Response for StartOutputRequest.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startoutput

func (StartOutputResponse) Error 

func (r StartOutputResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartOutputResponse) ID 

func (r StartOutputResponse) ID() string

ID returns the response's message ID.

func (StartOutputResponse) Status 

func (r StartOutputResponse) Status() string

Status returns the response's status.

type StartRecordingRequest 

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

StartRecordingRequest : Start recording. Will return an `error` if recording is already active.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startrecording

func NewStartRecordingRequest 

func NewStartRecordingRequest() StartRecordingRequest

NewStartRecordingRequest returns a new StartRecordingRequest.

func (StartRecordingRequest) ID 

func (r StartRecordingRequest) ID() string

ID returns the request's message ID.

func (StartRecordingRequest) Receive 

func (r StartRecordingRequest) Receive() (StartRecordingResponse, error)

Receive waits for the response.

func (*StartRecordingRequest) Send 

func (r *StartRecordingRequest) Send(c Client) error

Send sends the request.

func (StartRecordingRequest) SendReceive 

func (r StartRecordingRequest) SendReceive(c Client) (StartRecordingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartRecordingRequest) Type 

func (r StartRecordingRequest) Type() string

Type returns the request's message type.

type StartRecordingResponse 

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

StartRecordingResponse : Response for StartRecordingRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startrecording

func (StartRecordingResponse) Error 

func (r StartRecordingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartRecordingResponse) ID 

func (r StartRecordingResponse) ID() string

ID returns the response's message ID.

func (StartRecordingResponse) Status 

func (r StartRecordingResponse) Status() string

Status returns the response's status.

type StartReplayBufferRequest 

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

StartReplayBufferRequest : Start recording into the Replay Buffer. Will return an `error` if the Replay Buffer is already active or if the "Save Replay Buffer" hotkey is not set in OBS' settings. Setting this hotkey is mandatory, even when triggering saves only through obs-websocket.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startreplaybuffer

func NewStartReplayBufferRequest 

func NewStartReplayBufferRequest() StartReplayBufferRequest

NewStartReplayBufferRequest returns a new StartReplayBufferRequest.

func (StartReplayBufferRequest) ID 

func (r StartReplayBufferRequest) ID() string

ID returns the request's message ID.

func (StartReplayBufferRequest) Receive 

func (r StartReplayBufferRequest) Receive() (StartReplayBufferResponse, error)

Receive waits for the response.

func (*StartReplayBufferRequest) Send 

func (r *StartReplayBufferRequest) Send(c Client) error

Send sends the request.

func (StartReplayBufferRequest) SendReceive 

func (r StartReplayBufferRequest) SendReceive(c Client) (StartReplayBufferResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartReplayBufferRequest) Type 

func (r StartReplayBufferRequest) Type() string

Type returns the request's message type.

type StartReplayBufferResponse 

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

StartReplayBufferResponse : Response for StartReplayBufferRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startreplaybuffer

func (StartReplayBufferResponse) Error 

func (r StartReplayBufferResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartReplayBufferResponse) ID 

func (r StartReplayBufferResponse) ID() string

ID returns the response's message ID.

func (StartReplayBufferResponse) Status 

func (r StartReplayBufferResponse) Status() string

Status returns the response's status.

type StartStopRecordingRequest 

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

StartStopRecordingRequest : Toggle recording on or off.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startstoprecording

func NewStartStopRecordingRequest 

func NewStartStopRecordingRequest() StartStopRecordingRequest

NewStartStopRecordingRequest returns a new StartStopRecordingRequest.

func (StartStopRecordingRequest) ID 

func (r StartStopRecordingRequest) ID() string

ID returns the request's message ID.

func (StartStopRecordingRequest) Receive 

func (r StartStopRecordingRequest) Receive() (StartStopRecordingResponse, error)

Receive waits for the response.

func (*StartStopRecordingRequest) Send 

func (r *StartStopRecordingRequest) Send(c Client) error

Send sends the request.

func (StartStopRecordingRequest) SendReceive 

func (r StartStopRecordingRequest) SendReceive(c Client) (StartStopRecordingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartStopRecordingRequest) Type 

func (r StartStopRecordingRequest) Type() string

Type returns the request's message type.

type StartStopRecordingResponse 

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

StartStopRecordingResponse : Response for StartStopRecordingRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startstoprecording

func (StartStopRecordingResponse) Error 

func (r StartStopRecordingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartStopRecordingResponse) ID 

func (r StartStopRecordingResponse) ID() string

ID returns the response's message ID.

func (StartStopRecordingResponse) Status 

func (r StartStopRecordingResponse) Status() string

Status returns the response's status.

type StartStopReplayBufferRequest 

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

StartStopReplayBufferRequest : Toggle the Replay Buffer on/off.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startstopreplaybuffer

func NewStartStopReplayBufferRequest 

func NewStartStopReplayBufferRequest() StartStopReplayBufferRequest

NewStartStopReplayBufferRequest returns a new StartStopReplayBufferRequest.

func (StartStopReplayBufferRequest) ID 

func (r StartStopReplayBufferRequest) ID() string

ID returns the request's message ID.

func (StartStopReplayBufferRequest) Receive 

func (r StartStopReplayBufferRequest) Receive() (StartStopReplayBufferResponse, error)

Receive waits for the response.

func (*StartStopReplayBufferRequest) Send 

func (r *StartStopReplayBufferRequest) Send(c Client) error

Send sends the request.

func (StartStopReplayBufferRequest) SendReceive 

func (r StartStopReplayBufferRequest) SendReceive(c Client) (StartStopReplayBufferResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartStopReplayBufferRequest) Type 

func (r StartStopReplayBufferRequest) Type() string

Type returns the request's message type.

type StartStopReplayBufferResponse 

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

StartStopReplayBufferResponse : Response for StartStopReplayBufferRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#startstopreplaybuffer

func (StartStopReplayBufferResponse) Error 

func (r StartStopReplayBufferResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartStopReplayBufferResponse) ID 

func (r StartStopReplayBufferResponse) ID() string

ID returns the response's message ID.

func (StartStopReplayBufferResponse) Status 

func (r StartStopReplayBufferResponse) Status() string

Status returns the response's status.

type StartStopStreamingRequest 

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

StartStopStreamingRequest : Toggle streaming on or off.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#startstopstreaming

func NewStartStopStreamingRequest 

func NewStartStopStreamingRequest() StartStopStreamingRequest

NewStartStopStreamingRequest returns a new StartStopStreamingRequest.

func (StartStopStreamingRequest) ID 

func (r StartStopStreamingRequest) ID() string

ID returns the request's message ID.

func (StartStopStreamingRequest) Receive 

func (r StartStopStreamingRequest) Receive() (StartStopStreamingResponse, error)

Receive waits for the response.

func (*StartStopStreamingRequest) Send 

func (r *StartStopStreamingRequest) Send(c Client) error

Send sends the request.

func (StartStopStreamingRequest) SendReceive 

func (r StartStopStreamingRequest) SendReceive(c Client) (StartStopStreamingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartStopStreamingRequest) Type 

func (r StartStopStreamingRequest) Type() string

Type returns the request's message type.

type StartStopStreamingResponse 

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

StartStopStreamingResponse : Response for StartStopStreamingRequest.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#startstopstreaming

func (StartStopStreamingResponse) Error 

func (r StartStopStreamingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartStopStreamingResponse) ID 

func (r StartStopStreamingResponse) ID() string

ID returns the response's message ID.

func (StartStopStreamingResponse) Status 

func (r StartStopStreamingResponse) Status() string

Status returns the response's status.

type StartStreamingRequest 

type StartStreamingRequest struct {
	// Special stream configuration.
	// Please note: these won't be saved to OBS' configuration.
	// Required: No.
	Stream map[string]interface{} `json:"stream"`
	// If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common').
	// If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.
	// Required: No.
	StreamType string `json:"stream.type"`
	// Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream.
	// Used to pass data to the RTMP service about the streaming.
	// May be any String, Numeric, or Boolean field.
	// Required: No.
	StreamMetadata map[string]interface{} `json:"stream.metadata"`
	// Settings for the stream.
	// Required: No.
	StreamSettings map[string]interface{} `json:"stream.settings"`
	// The publish URL.
	// Required: No.
	StreamSettingsServer string `json:"stream.settings.server"`
	// The publish key of the stream.
	// Required: No.
	StreamSettingsKey string `json:"stream.settings.key"`
	// Indicates whether authentication should be used when connecting to the streaming server.
	// Required: No.
	StreamSettingsUseAuth bool `json:"stream.settings.use-auth"`
	// If authentication is enabled, the username for the streaming server.
	// Ignored if `use-auth` is not set to `true`.
	// Required: No.
	StreamSettingsUsername string `json:"stream.settings.username"`
	// If authentication is enabled, the password for the streaming server.
	// Ignored if `use-auth` is not set to `true`.
	// Required: No.
	StreamSettingsPassword string `json:"stream.settings.password"`
	// contains filtered or unexported fields
}

StartStreamingRequest : Start streaming. Will return an `error` if streaming is already active.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#startstreaming

func NewStartStreamingRequest 

func NewStartStreamingRequest(
	stream map[string]interface{},
	streamType string,
	streamMetadata map[string]interface{},
	streamSettings map[string]interface{},
	streamSettingsServer string,
	streamSettingsKey string,
	streamSettingsUseAuth bool,
	streamSettingsUsername string,
	streamSettingsPassword string,
) StartStreamingRequest

NewStartStreamingRequest returns a new StartStreamingRequest.

func (StartStreamingRequest) ID 

func (r StartStreamingRequest) ID() string

ID returns the request's message ID.

func (StartStreamingRequest) Receive 

func (r StartStreamingRequest) Receive() (StartStreamingResponse, error)

Receive waits for the response.

func (*StartStreamingRequest) Send 

func (r *StartStreamingRequest) Send(c Client) error

Send sends the request.

func (StartStreamingRequest) SendReceive 

func (r StartStreamingRequest) SendReceive(c Client) (StartStreamingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StartStreamingRequest) Type 

func (r StartStreamingRequest) Type() string

Type returns the request's message type.

type StartStreamingResponse 

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

StartStreamingResponse : Response for StartStreamingRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#startstreaming

func (StartStreamingResponse) Error 

func (r StartStreamingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StartStreamingResponse) ID 

func (r StartStreamingResponse) ID() string

ID returns the response's message ID.

func (StartStreamingResponse) Status 

func (r StartStreamingResponse) Status() string

Status returns the response's status.

type StopOutputRequest 

type StopOutputRequest struct {
	// Output name.
	// Required: Yes.
	OutputName string `json:"outputName"`
	// Force stop (default: false).
	// Required: No.
	Force bool `json:"force"`
	// contains filtered or unexported fields
}

StopOutputRequest : Stop an output.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stopoutput

func NewStopOutputRequest 

func NewStopOutputRequest(
	outputName string,
	force bool,
) StopOutputRequest

NewStopOutputRequest returns a new StopOutputRequest.

func (StopOutputRequest) ID 

func (r StopOutputRequest) ID() string

ID returns the request's message ID.

func (StopOutputRequest) Receive 

func (r StopOutputRequest) Receive() (StopOutputResponse, error)

Receive waits for the response.

func (*StopOutputRequest) Send 

func (r *StopOutputRequest) Send(c Client) error

Send sends the request.

func (StopOutputRequest) SendReceive 

func (r StopOutputRequest) SendReceive(c Client) (StopOutputResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StopOutputRequest) Type 

func (r StopOutputRequest) Type() string

Type returns the request's message type.

type StopOutputResponse 

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

StopOutputResponse : Response for StopOutputRequest.

Since obs-websocket version: 4.7.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stopoutput

func (StopOutputResponse) Error 

func (r StopOutputResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StopOutputResponse) ID 

func (r StopOutputResponse) ID() string

ID returns the response's message ID.

func (StopOutputResponse) Status 

func (r StopOutputResponse) Status() string

Status returns the response's status.

type StopRecordingRequest 

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

StopRecordingRequest : Stop recording. Will return an `error` if recording is not active.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stoprecording

func NewStopRecordingRequest 

func NewStopRecordingRequest() StopRecordingRequest

NewStopRecordingRequest returns a new StopRecordingRequest.

func (StopRecordingRequest) ID 

func (r StopRecordingRequest) ID() string

ID returns the request's message ID.

func (StopRecordingRequest) Receive 

func (r StopRecordingRequest) Receive() (StopRecordingResponse, error)

Receive waits for the response.

func (*StopRecordingRequest) Send 

func (r *StopRecordingRequest) Send(c Client) error

Send sends the request.

func (StopRecordingRequest) SendReceive 

func (r StopRecordingRequest) SendReceive(c Client) (StopRecordingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StopRecordingRequest) Type 

func (r StopRecordingRequest) Type() string

Type returns the request's message type.

type StopRecordingResponse 

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

StopRecordingResponse : Response for StopRecordingRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stoprecording

func (StopRecordingResponse) Error 

func (r StopRecordingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StopRecordingResponse) ID 

func (r StopRecordingResponse) ID() string

ID returns the response's message ID.

func (StopRecordingResponse) Status 

func (r StopRecordingResponse) Status() string

Status returns the response's status.

type StopReplayBufferRequest 

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

StopReplayBufferRequest : Stop recording into the Replay Buffer. Will return an `error` if the Replay Buffer is not active.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stopreplaybuffer

func NewStopReplayBufferRequest 

func NewStopReplayBufferRequest() StopReplayBufferRequest

NewStopReplayBufferRequest returns a new StopReplayBufferRequest.

func (StopReplayBufferRequest) ID 

func (r StopReplayBufferRequest) ID() string

ID returns the request's message ID.

func (StopReplayBufferRequest) Receive 

func (r StopReplayBufferRequest) Receive() (StopReplayBufferResponse, error)

Receive waits for the response.

func (*StopReplayBufferRequest) Send 

func (r *StopReplayBufferRequest) Send(c Client) error

Send sends the request.

func (StopReplayBufferRequest) SendReceive 

func (r StopReplayBufferRequest) SendReceive(c Client) (StopReplayBufferResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StopReplayBufferRequest) Type 

func (r StopReplayBufferRequest) Type() string

Type returns the request's message type.

type StopReplayBufferResponse 

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

StopReplayBufferResponse : Response for StopReplayBufferRequest.

Since obs-websocket version: 4.2.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#stopreplaybuffer

func (StopReplayBufferResponse) Error 

func (r StopReplayBufferResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StopReplayBufferResponse) ID 

func (r StopReplayBufferResponse) ID() string

ID returns the response's message ID.

func (StopReplayBufferResponse) Status 

func (r StopReplayBufferResponse) Status() string

Status returns the response's status.

type StopStreamingRequest 

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

StopStreamingRequest : Stop streaming. Will return an `error` if streaming is not active.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#stopstreaming

func NewStopStreamingRequest 

func NewStopStreamingRequest() StopStreamingRequest

NewStopStreamingRequest returns a new StopStreamingRequest.

func (StopStreamingRequest) ID 

func (r StopStreamingRequest) ID() string

ID returns the request's message ID.

func (StopStreamingRequest) Receive 

func (r StopStreamingRequest) Receive() (StopStreamingResponse, error)

Receive waits for the response.

func (*StopStreamingRequest) Send 

func (r *StopStreamingRequest) Send(c Client) error

Send sends the request.

func (StopStreamingRequest) SendReceive 

func (r StopStreamingRequest) SendReceive(c Client) (StopStreamingResponse, error)

SendReceive sends the request then immediately waits for the response.

func (StopStreamingRequest) Type 

func (r StopStreamingRequest) Type() string

Type returns the request's message type.

type StopStreamingResponse 

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

StopStreamingResponse : Response for StopStreamingRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#stopstreaming

func (StopStreamingResponse) Error 

func (r StopStreamingResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (StopStreamingResponse) ID 

func (r StopStreamingResponse) ID() string

ID returns the response's message ID.

func (StopStreamingResponse) Status 

func (r StopStreamingResponse) Status() string

Status returns the response's status.

type StreamStartedEvent 

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

StreamStartedEvent : Streaming started successfully.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#streamstarted

func (StreamStartedEvent) RecTimecode 

func (e StreamStartedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StreamStartedEvent) StreamTimecode 

func (e StreamStartedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StreamStartedEvent) Type 

func (e StreamStartedEvent) Type() string

Type returns the event's update type.

type StreamStartingEvent 

type StreamStartingEvent struct {
	// Always false (retrocompatibility).
	// Required: Yes.
	PreviewOnly bool `json:"preview-only"`
	// contains filtered or unexported fields
}

StreamStartingEvent : A request to start streaming has been issued.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#streamstarting

func (StreamStartingEvent) RecTimecode 

func (e StreamStartingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StreamStartingEvent) StreamTimecode 

func (e StreamStartingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StreamStartingEvent) Type 

func (e StreamStartingEvent) Type() string

Type returns the event's update type.

type StreamStatusEvent 

type StreamStatusEvent struct {
	// Current streaming state.
	// Required: Yes.
	Streaming bool `json:"streaming"`
	// Current recording state.
	// Required: Yes.
	Recording bool `json:"recording"`
	// Always false (retrocompatibility).
	// Required: Yes.
	PreviewOnly bool `json:"preview-only"`
	// Amount of data per second (in bytes) transmitted by the stream encoder.
	// Required: Yes.
	BytesPerSec int `json:"bytes-per-sec"`
	// Amount of data per second (in kilobits) transmitted by the stream encoder.
	// Required: Yes.
	KbitsPerSec int `json:"kbits-per-sec"`
	// Percentage of dropped frames.
	// Required: Yes.
	Strain float64 `json:"strain"`
	// Total time (in seconds) since the stream started.
	// Required: Yes.
	TotalStreamTime int `json:"total-stream-time"`
	// Total number of frames transmitted since the stream started.
	// Required: Yes.
	NumTotalFrames int `json:"num-total-frames"`
	// Number of frames dropped by the encoder since the stream started.
	// Required: Yes.
	NumDroppedFrames int `json:"num-dropped-frames"`
	// Current framerate.
	// Required: Yes.
	FPS float64 `json:"fps"`
	// contains filtered or unexported fields
}

StreamStatusEvent : Emit every 2 seconds.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#streamstatus

func (StreamStatusEvent) RecTimecode 

func (e StreamStatusEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StreamStatusEvent) StreamTimecode 

func (e StreamStatusEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StreamStatusEvent) Type 

func (e StreamStatusEvent) Type() string

Type returns the event's update type.

type StreamStoppedEvent 

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

StreamStoppedEvent : Streaming stopped successfully.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#streamstopped

func (StreamStoppedEvent) RecTimecode 

func (e StreamStoppedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StreamStoppedEvent) StreamTimecode 

func (e StreamStoppedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StreamStoppedEvent) Type 

func (e StreamStoppedEvent) Type() string

Type returns the event's update type.

type StreamStoppingEvent 

type StreamStoppingEvent struct {
	// Always false (retrocompatibility).
	// Required: Yes.
	PreviewOnly bool `json:"preview-only"`
	// contains filtered or unexported fields
}

StreamStoppingEvent : A request to stop streaming has been issued.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#streamstopping

func (StreamStoppingEvent) RecTimecode 

func (e StreamStoppingEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StreamStoppingEvent) StreamTimecode 

func (e StreamStoppingEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StreamStoppingEvent) Type 

func (e StreamStoppingEvent) Type() string

Type returns the event's update type.

type StudioModeSwitchedEvent 

type StudioModeSwitchedEvent struct {
	// The new enabled state of Studio Mode.
	// Required: Yes.
	NewState bool `json:"new-state"`
	// contains filtered or unexported fields
}

StudioModeSwitchedEvent : Studio Mode has been enabled or disabled.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#studiomodeswitched

func (StudioModeSwitchedEvent) RecTimecode 

func (e StudioModeSwitchedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (StudioModeSwitchedEvent) StreamTimecode 

func (e StudioModeSwitchedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (StudioModeSwitchedEvent) Type 

func (e StudioModeSwitchedEvent) Type() string

Type returns the event's update type.

type SwitchScenesEvent 

type SwitchScenesEvent struct {
	// The new scene.
	// Required: Yes.
	SceneName string `json:"scene-name"`
	// List of sources in the new scene.
	// Same specification as [`GetCurrentScene`](#getcurrentscene).
	// Required: Yes.
	Sources []map[string]interface{} `json:"sources"`
	// contains filtered or unexported fields
}

SwitchScenesEvent : Indicates a scene change.

Since obs-websocket version: 0.3.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#switchscenes

func (SwitchScenesEvent) RecTimecode 

func (e SwitchScenesEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SwitchScenesEvent) StreamTimecode 

func (e SwitchScenesEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SwitchScenesEvent) Type 

func (e SwitchScenesEvent) Type() string

Type returns the event's update type.

type SwitchTransitionEvent 

type SwitchTransitionEvent struct {
	// The name of the new active transition.
	// Required: Yes.
	TransitionName string `json:"transition-name"`
	// contains filtered or unexported fields
}

SwitchTransitionEvent : The active transition has been changed.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#switchtransition

func (SwitchTransitionEvent) RecTimecode 

func (e SwitchTransitionEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (SwitchTransitionEvent) StreamTimecode 

func (e SwitchTransitionEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (SwitchTransitionEvent) Type 

func (e SwitchTransitionEvent) Type() string

Type returns the event's update type.

type ToggleMuteRequest 

type ToggleMuteRequest struct {
	// Source name.
	// Required: Yes.
	Source string `json:"source"`
	// contains filtered or unexported fields
}

ToggleMuteRequest : Inverts the mute status of a specified source.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#togglemute

func NewToggleMuteRequest 

func NewToggleMuteRequest(source string) ToggleMuteRequest

NewToggleMuteRequest returns a new ToggleMuteRequest.

func (ToggleMuteRequest) ID 

func (r ToggleMuteRequest) ID() string

ID returns the request's message ID.

func (ToggleMuteRequest) Receive 

func (r ToggleMuteRequest) Receive() (ToggleMuteResponse, error)

Receive waits for the response.

func (*ToggleMuteRequest) Send 

func (r *ToggleMuteRequest) Send(c Client) error

Send sends the request.

func (ToggleMuteRequest) SendReceive 

func (r ToggleMuteRequest) SendReceive(c Client) (ToggleMuteResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ToggleMuteRequest) Type 

func (r ToggleMuteRequest) Type() string

Type returns the request's message type.

type ToggleMuteResponse 

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

ToggleMuteResponse : Response for ToggleMuteRequest.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#togglemute

func (ToggleMuteResponse) Error 

func (r ToggleMuteResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ToggleMuteResponse) ID 

func (r ToggleMuteResponse) ID() string

ID returns the response's message ID.

func (ToggleMuteResponse) Status 

func (r ToggleMuteResponse) Status() string

Status returns the response's status.

type ToggleStudioModeRequest 

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

ToggleStudioModeRequest : Toggles Studio Mode.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#togglestudiomode

func NewToggleStudioModeRequest 

func NewToggleStudioModeRequest() ToggleStudioModeRequest

NewToggleStudioModeRequest returns a new ToggleStudioModeRequest.

func (ToggleStudioModeRequest) ID 

func (r ToggleStudioModeRequest) ID() string

ID returns the request's message ID.

func (ToggleStudioModeRequest) Receive 

func (r ToggleStudioModeRequest) Receive() (ToggleStudioModeResponse, error)

Receive waits for the response.

func (*ToggleStudioModeRequest) Send 

func (r *ToggleStudioModeRequest) Send(c Client) error

Send sends the request.

func (ToggleStudioModeRequest) SendReceive 

func (r ToggleStudioModeRequest) SendReceive(c Client) (ToggleStudioModeResponse, error)

SendReceive sends the request then immediately waits for the response.

func (ToggleStudioModeRequest) Type 

func (r ToggleStudioModeRequest) Type() string

Type returns the request's message type.

type ToggleStudioModeResponse 

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

ToggleStudioModeResponse : Response for ToggleStudioModeRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#togglestudiomode

func (ToggleStudioModeResponse) Error 

func (r ToggleStudioModeResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (ToggleStudioModeResponse) ID 

func (r ToggleStudioModeResponse) ID() string

ID returns the response's message ID.

func (ToggleStudioModeResponse) Status 

func (r ToggleStudioModeResponse) Status() string

Status returns the response's status.

type TransitionBeginEvent 

type TransitionBeginEvent struct {
	// Transition name.
	// Required: Yes.
	Name string `json:"name"`
	// Transition duration (in milliseconds).
	// Required: Yes.
	Duration int `json:"duration"`
	// Source scene of the transition.
	// Required: Yes.
	FromScene string `json:"from-scene"`
	// Destination scene of the transition.
	// Required: Yes.
	ToScene string `json:"to-scene"`
	// contains filtered or unexported fields
}

TransitionBeginEvent : A transition (other than "cut") has begun.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#transitionbegin

func (TransitionBeginEvent) RecTimecode 

func (e TransitionBeginEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (TransitionBeginEvent) StreamTimecode 

func (e TransitionBeginEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (TransitionBeginEvent) Type 

func (e TransitionBeginEvent) Type() string

Type returns the event's update type.

type TransitionDurationChangedEvent 

type TransitionDurationChangedEvent struct {
	// New transition duration.
	// Required: Yes.
	NewDuration int `json:"new-duration"`
	// contains filtered or unexported fields
}

TransitionDurationChangedEvent : The active transition duration has been changed.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#transitiondurationchanged

func (TransitionDurationChangedEvent) RecTimecode 

func (e TransitionDurationChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (TransitionDurationChangedEvent) StreamTimecode 

func (e TransitionDurationChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (TransitionDurationChangedEvent) Type 

func (e TransitionDurationChangedEvent) Type() string

Type returns the event's update type.

type TransitionListChangedEvent 

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

TransitionListChangedEvent : The list of available transitions has been modified. Transitions have been added, removed, or renamed.

Since obs-websocket version: 4.0.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#transitionlistchanged

func (TransitionListChangedEvent) RecTimecode 

func (e TransitionListChangedEvent) RecTimecode() string

RecTimecode returns the event's recording timecode.

func (TransitionListChangedEvent) StreamTimecode 

func (e TransitionListChangedEvent) StreamTimecode() string

StreamTimeode returns the event's stream timecode.

func (TransitionListChangedEvent) Type 

func (e TransitionListChangedEvent) Type() string

Type returns the event's update type.

type TransitionToProgramRequest 

type TransitionToProgramRequest struct {
	// Change the active transition before switching scenes.
	// Defaults to the active transition.
	// Required: No.
	WithTransition map[string]interface{} `json:"with-transition"`
	// Name of the transition.
	// Required: Yes.
	WithTransitionName string `json:"with-transition.name"`
	// Transition duration (in milliseconds).
	// Required: No.
	WithTransitionDuration int `json:"with-transition.duration"`
	// contains filtered or unexported fields
}

TransitionToProgramRequest : Transitions the currently previewed scene to the main output. Will return an `error` if Studio Mode is not enabled.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#transitiontoprogram

func NewTransitionToProgramRequest 

func NewTransitionToProgramRequest(
	withTransition map[string]interface{},
	withTransitionName string,
	withTransitionDuration int,
) TransitionToProgramRequest

NewTransitionToProgramRequest returns a new TransitionToProgramRequest.

func (TransitionToProgramRequest) ID 

func (r TransitionToProgramRequest) ID() string

ID returns the request's message ID.

func (TransitionToProgramRequest) Receive 

func (r TransitionToProgramRequest) Receive() (TransitionToProgramResponse, error)

Receive waits for the response.

func (*TransitionToProgramRequest) Send 

func (r *TransitionToProgramRequest) Send(c Client) error

Send sends the request.

func (TransitionToProgramRequest) SendReceive 

func (r TransitionToProgramRequest) SendReceive(c Client) (TransitionToProgramResponse, error)

SendReceive sends the request then immediately waits for the response.

func (TransitionToProgramRequest) Type 

func (r TransitionToProgramRequest) Type() string

Type returns the request's message type.

type TransitionToProgramResponse 

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

TransitionToProgramResponse : Response for TransitionToProgramRequest.

Since obs-websocket version: 4.1.0.

https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md#transitiontoprogram

func (TransitionToProgramResponse) Error 

func (r TransitionToProgramResponse) Error() string

Error returns the response's error. When using Receive or SendReceive, this should always return an empty string, because the error will have been returned explictly instead of stored here.

func (TransitionToProgramResponse) ID 

func (r TransitionToProgramResponse) ID() string

ID returns the response's message ID.

func (TransitionToProgramResponse) Status 

func (r TransitionToProgramResponse) Status() string

Status returns the response's status.

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.