sources

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2021 License: Apache-2.0 Imports: 1 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFilterToSourceParams 

type AddFilterToSourceParams struct {
	requests.ParamsBasic

	// Name of the new filter
	FilterName string `json:"filterName"`

	// Filter settings
	FilterSettings map[string]interface{} `json:"filterSettings"`

	// Filter type
	FilterType string `json:"filterType"`

	// Name of the source on which the filter is added
	SourceName string `json:"sourceName"`
}

AddFilterToSourceParams represents the params body for the "AddFilterToSource" request. Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`.

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

func (*AddFilterToSourceParams) Name 

func (o *AddFilterToSourceParams) Name() string

Name just returns "AddFilterToSource".

type AddFilterToSourceResponse 

type AddFilterToSourceResponse struct {
	requests.ResponseBasic
}

AddFilterToSourceResponse represents the response body for the "AddFilterToSource" request. Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`.

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

type Client 

type Client struct {
	*requests.Client
}

Client represents a client for 'sources' requests

func (*Client) AddFilterToSource 

func (c *Client) AddFilterToSource(
	params *AddFilterToSourceParams,
) (*AddFilterToSourceResponse, error)

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

func (*Client) GetBrowserSourceProperties 

func (c *Client) GetBrowserSourceProperties(
	params *GetBrowserSourcePropertiesParams,
) (*GetBrowserSourcePropertiesResponse, error)

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

func (*Client) GetMute 

func (c *Client) GetMute(params *GetMuteParams) (*GetMuteResponse, error)

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

func (*Client) GetSourceFilterInfo added in v0.3.0 

func (c *Client) GetSourceFilterInfo(
	params *GetSourceFilterInfoParams,
) (*GetSourceFilterInfoResponse, error)

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

func (*Client) GetSourceFilters 

func (c *Client) GetSourceFilters(
	params *GetSourceFiltersParams,
) (*GetSourceFiltersResponse, error)

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

func (*Client) GetSourceSettings 

func (c *Client) GetSourceSettings(
	params *GetSourceSettingsParams,
) (*GetSourceSettingsResponse, error)

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

func (*Client) GetSourceTypesList added in v0.2.0 

func (c *Client) GetSourceTypesList(
	paramss ...*GetSourceTypesListParams,
) (*GetSourceTypesListResponse, error)

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

func (*Client) GetSourcesList 

func (c *Client) GetSourcesList(paramss ...*GetSourcesListParams) (*GetSourcesListResponse, error)

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

func (*Client) GetSpecialSources 

func (c *Client) GetSpecialSources(
	paramss ...*GetSpecialSourcesParams,
) (*GetSpecialSourcesResponse, error)

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

func (*Client) GetSyncOffset 

func (c *Client) GetSyncOffset(params *GetSyncOffsetParams) (*GetSyncOffsetResponse, error)

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

func (*Client) GetTextFreetype2Properties 

func (c *Client) GetTextFreetype2Properties(
	params *GetTextFreetype2PropertiesParams,
) (*GetTextFreetype2PropertiesResponse, error)

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

func (*Client) GetTextGDIPlusProperties 

func (c *Client) GetTextGDIPlusProperties(
	params *GetTextGDIPlusPropertiesParams,
) (*GetTextGDIPlusPropertiesResponse, error)

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

func (*Client) GetVolume 

func (c *Client) GetVolume(params *GetVolumeParams) (*GetVolumeResponse, error)

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

func (*Client) MoveSourceFilter 

func (c *Client) MoveSourceFilter(
	params *MoveSourceFilterParams,
) (*MoveSourceFilterResponse, error)

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

func (*Client) RemoveFilterFromSource 

func (c *Client) RemoveFilterFromSource(
	params *RemoveFilterFromSourceParams,
) (*RemoveFilterFromSourceResponse, error)

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

func (*Client) ReorderSourceFilter 

func (c *Client) ReorderSourceFilter(
	params *ReorderSourceFilterParams,
) (*ReorderSourceFilterResponse, error)

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

func (*Client) SetBrowserSourceProperties 

func (c *Client) SetBrowserSourceProperties(
	params *SetBrowserSourcePropertiesParams,
) (*SetBrowserSourcePropertiesResponse, error)

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

func (*Client) SetMute 

func (c *Client) SetMute(params *SetMuteParams) (*SetMuteResponse, error)

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

func (*Client) SetSourceFilterSettings 

func (c *Client) SetSourceFilterSettings(
	params *SetSourceFilterSettingsParams,
) (*SetSourceFilterSettingsResponse, error)

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

func (*Client) SetSourceFilterVisibility added in v0.3.0 

func (c *Client) SetSourceFilterVisibility(
	params *SetSourceFilterVisibilityParams,
) (*SetSourceFilterVisibilityResponse, error)

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

func (*Client) SetSourceSettings 

func (c *Client) SetSourceSettings(
	params *SetSourceSettingsParams,
) (*SetSourceSettingsResponse, error)

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

func (*Client) SetSyncOffset 

func (c *Client) SetSyncOffset(params *SetSyncOffsetParams) (*SetSyncOffsetResponse, error)

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

func (*Client) SetTextFreetype2Properties 

func (c *Client) SetTextFreetype2Properties(
	params *SetTextFreetype2PropertiesParams,
) (*SetTextFreetype2PropertiesResponse, error)

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

func (*Client) SetTextGDIPlusProperties 

func (c *Client) SetTextGDIPlusProperties(
	params *SetTextGDIPlusPropertiesParams,
) (*SetTextGDIPlusPropertiesResponse, error)

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

func (*Client) SetVolume 

func (c *Client) SetVolume(params *SetVolumeParams) (*SetVolumeResponse, error)

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

func (*Client) TakeSourceScreenshot added in v0.2.0 

func (c *Client) TakeSourceScreenshot(
	params *TakeSourceScreenshotParams,
) (*TakeSourceScreenshotResponse, error)

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

func (*Client) ToggleMute 

func (c *Client) ToggleMute(params *ToggleMuteParams) (*ToggleMuteResponse, error)

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

type GetBrowserSourcePropertiesParams 

type GetBrowserSourcePropertiesParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetBrowserSourcePropertiesParams represents the params body for the "GetBrowserSourceProperties" request. Get current properties for a Browser Source.

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

func (*GetBrowserSourcePropertiesParams) Name 

func (o *GetBrowserSourcePropertiesParams) Name() string

Name just returns "GetBrowserSourceProperties".

type GetBrowserSourcePropertiesResponse 

type GetBrowserSourcePropertiesResponse struct {
	requests.ResponseBasic

	// CSS to inject.
	Css string `json:"css"`

	// Framerate.
	Fps int `json:"fps"`

	// Height.
	Height int `json:"height"`

	// Indicates that a local file is in use.
	IsLocalFile bool `json:"is_local_file"`

	// file path.
	LocalFile string `json:"local_file"`

	// Indicates whether the source should be shutdown when not visible.
	Shutdown bool `json:"shutdown"`

	// Source name.
	Source string `json:"source"`

	// Url.
	Url string `json:"url"`

	// Width.
	Width int `json:"width"`
}

GetBrowserSourcePropertiesResponse represents the response body for the "GetBrowserSourceProperties" request. Get current properties for a Browser Source.

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

type GetMuteParams 

type GetMuteParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetMuteParams represents the params body for the "GetMute" request. Get the mute status of a specified source.

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

func (*GetMuteParams) Name 

func (o *GetMuteParams) Name() string

Name just returns "GetMute".

type GetMuteResponse 

type GetMuteResponse struct {
	requests.ResponseBasic

	// Mute status of the source.
	Muted bool `json:"muted"`

	// Source name.
	Name string `json:"name"`
}

GetMuteResponse represents the response body for the "GetMute" request. Get the mute status of a specified source.

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

type GetSourceFilterInfoParams added in v0.3.0 

type GetSourceFilterInfoParams struct {
	requests.ParamsBasic

	// Source filter name
	FilterName string `json:"filterName"`

	// Source name
	SourceName string `json:"sourceName"`
}

GetSourceFilterInfoParams represents the params body for the "GetSourceFilterInfo" request. List filters applied to a source

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

func (*GetSourceFilterInfoParams) Name added in v0.3.0 

func (o *GetSourceFilterInfoParams) Name() string

Name just returns "GetSourceFilterInfo".

type GetSourceFilterInfoResponse added in v0.3.0 

type GetSourceFilterInfoResponse struct {
	requests.ResponseBasic

	// Filter status (enabled or not)
	Enabled bool `json:"enabled"`

	// Filter name
	Name string `json:"name"`

	// Filter settings
	Settings map[string]interface{} `json:"settings"`

	// Filter type
	Type string `json:"type"`
}

GetSourceFilterInfoResponse represents the response body for the "GetSourceFilterInfo" request. List filters applied to a source

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

type GetSourceFiltersParams 

type GetSourceFiltersParams struct {
	requests.ParamsBasic

	// Source name
	SourceName string `json:"sourceName"`
}

GetSourceFiltersParams represents the params body for the "GetSourceFilters" request. List filters applied to a source

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

func (*GetSourceFiltersParams) Name 

func (o *GetSourceFiltersParams) Name() string

Name just returns "GetSourceFilters".

type GetSourceFiltersResponse 

type GetSourceFiltersResponse struct {
	requests.ResponseBasic

	Filters []struct {
		// Filter status (enabled or not)
		Enabled bool `json:"enabled"`

		// Filter name
		Name string `json:"name"`

		// Filter settings
		Settings map[string]interface{} `json:"settings"`

		// Filter type
		Type string `json:"type"`
	} `json:"filters"`
}

GetSourceFiltersResponse represents the response body for the "GetSourceFilters" request. List filters applied to a source

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

type GetSourceSettingsParams 

type GetSourceSettingsParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName"`

	// Type of the specified source. Useful for type-checking if you expect a specific settings
	// schema.
	SourceType string `json:"sourceType"`
}

GetSourceSettingsParams represents the params body for the "GetSourceSettings" request. Get settings of the specified source

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

func (*GetSourceSettingsParams) Name 

func (o *GetSourceSettingsParams) Name() string

Name just returns "GetSourceSettings".

type GetSourceSettingsResponse 

type GetSourceSettingsResponse struct {
	requests.ResponseBasic

	// Source name
	SourceName string `json:"sourceName"`

	// Source settings (varies between source types, may require some probing around).
	SourceSettings map[string]interface{} `json:"sourceSettings"`

	// Type of the specified source
	SourceType string `json:"sourceType"`
}

GetSourceSettingsResponse represents the response body for the "GetSourceSettings" request. Get settings of the specified source

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

type GetSourceTypesListParams added in v0.2.0 

type GetSourceTypesListParams struct {
	requests.ParamsBasic
}

GetSourceTypesListParams represents the params body for the "GetSourceTypesList" request. Get a list of all available sources types

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

func (*GetSourceTypesListParams) Name added in v0.2.0 

func (o *GetSourceTypesListParams) Name() string

Name just returns "GetSourceTypesList".

type GetSourceTypesListResponse added in v0.2.0 

type GetSourceTypesListResponse struct {
	requests.ResponseBasic

	Types []struct {
		Caps struct {
			// True if interaction with this sources of this type is possible
			CanInteract bool `json:"canInteract"`

			// True if sources of this type should not be fully duplicated
			DoNotDuplicate bool `json:"doNotDuplicate"`

			// True if sources of this type may cause a feedback loop if it's audio is monitored and
			// shouldn't be
			DoNotSelfMonitor bool `json:"doNotSelfMonitor"`

			// True if sources of this type provide audio
			HasAudio bool `json:"hasAudio"`

			// True if sources of this type provide video
			HasVideo bool `json:"hasVideo"`

			// True if source of this type provide frames asynchronously
			IsAsync bool `json:"isAsync"`

			// True if sources of this type composite one or more sub-sources
			IsComposite bool `json:"isComposite"`
		} `json:"caps"`

		// Default settings of this source type
		DefaultSettings map[string]interface{} `json:"defaultSettings"`

		// Display name of the source type
		DisplayName string `json:"displayName"`

		// Type. Value is one of the following: "input", "filter", "transition" or "other"
		Type string `json:"type"`

		// Non-unique internal source type ID
		TypeId string `json:"typeId"`
	} `json:"types"`
}

GetSourceTypesListResponse represents the response body for the "GetSourceTypesList" request. Get a list of all available sources types

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

type GetSourcesListParams 

type GetSourcesListParams struct {
	requests.ParamsBasic
}

GetSourcesListParams represents the params body for the "GetSourcesList" request. List all sources available in the running OBS instance

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

func (*GetSourcesListParams) Name 

func (o *GetSourcesListParams) Name() string

Name just returns "GetSourcesList".

type GetSourcesListResponse 

type GetSourcesListResponse struct {
	requests.ResponseBasic

	Sources []struct {
		// Unique source name
		Name string `json:"name"`

		// Source type. Value is one of the following: "input", "filter", "transition", "scene" or
		// "unknown"
		Type string `json:"type"`

		// Non-unique source internal type (a.k.a type id)
		TypeId string `json:"typeId"`
	} `json:"sources"`
}

GetSourcesListResponse represents the response body for the "GetSourcesList" request. List all sources available in the running OBS instance

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

type GetSpecialSourcesParams 

type GetSpecialSourcesParams struct {
	requests.ParamsBasic
}

GetSpecialSourcesParams represents the params body for the "GetSpecialSources" request. Get configured special sources like Desktop Audio and Mic/Aux sources.

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

func (*GetSpecialSourcesParams) Name 

func (o *GetSpecialSourcesParams) Name() string

Name just returns "GetSpecialSources".

type GetSpecialSourcesResponse 

type GetSpecialSourcesResponse struct {
	requests.ResponseBasic

	// Name of the first Desktop Audio capture source.
	Desktop1 string `json:"desktop-1"`

	// Name of the second Desktop Audio capture source.
	Desktop2 string `json:"desktop-2"`

	// Name of the first Mic/Aux input source.
	Mic1 string `json:"mic-1"`

	// Name of the second Mic/Aux input source.
	Mic2 string `json:"mic-2"`

	// NAme of the third Mic/Aux input source.
	Mic3 string `json:"mic-3"`
}

GetSpecialSourcesResponse represents the response body for the "GetSpecialSources" request. Get configured special sources like Desktop Audio and Mic/Aux sources.

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

type GetSyncOffsetParams 

type GetSyncOffsetParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetSyncOffsetParams represents the params body for the "GetSyncOffset" request. Get the audio sync offset of a specified source.

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

func (*GetSyncOffsetParams) Name 

func (o *GetSyncOffsetParams) Name() string

Name just returns "GetSyncOffset".

type GetSyncOffsetResponse 

type GetSyncOffsetResponse struct {
	requests.ResponseBasic

	// Source name.
	Name string `json:"name"`

	// The audio sync offset (in nanoseconds).
	Offset int `json:"offset"`
}

GetSyncOffsetResponse represents the response body for the "GetSyncOffset" request. Get the audio sync offset of a specified source.

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

type GetTextFreetype2PropertiesParams 

type GetTextFreetype2PropertiesParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetTextFreetype2PropertiesParams represents the params body for the "GetTextFreetype2Properties" request. Get the current properties of a Text Freetype 2 source.

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

func (*GetTextFreetype2PropertiesParams) Name 

func (o *GetTextFreetype2PropertiesParams) Name() string

Name just returns "GetTextFreetype2Properties".

type GetTextFreetype2PropertiesResponse 

type GetTextFreetype2PropertiesResponse struct {
	requests.ResponseBasic

	// Gradient top color.
	Color1 int `json:"color1"`

	// Gradient bottom color.
	Color2 int `json:"color2"`

	// Custom width (0 to disable).
	CustomWidth int `json:"custom_width"`

	// Drop shadow.
	DropShadow bool `json:"drop_shadow"`

	Font struct {
		// Font face.
		Face string `json:"face"`

		// Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`
		Flags int `json:"flags"`

		// Font text size.
		Size int `json:"size"`

		// Font Style (unknown function).
		Style string `json:"style"`
	} `json:"font"`

	// Read text from the specified file.
	FromFile bool `json:"from_file"`

	// Chat log.
	LogMode bool `json:"log_mode"`

	// Outline.
	Outline bool `json:"outline"`

	// Source name
	Source string `json:"source"`

	// Text content to be displayed.
	Text string `json:"text"`

	// File path.
	TextFile string `json:"text_file"`

	// Word wrap.
	WordWrap bool `json:"word_wrap"`
}

GetTextFreetype2PropertiesResponse represents the response body for the "GetTextFreetype2Properties" request. Get the current properties of a Text Freetype 2 source.

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

type GetTextGDIPlusPropertiesParams 

type GetTextGDIPlusPropertiesParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetTextGDIPlusPropertiesParams represents the params body for the "GetTextGDIPlusProperties" request. Get the current properties of a Text GDI Plus source.

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

func (*GetTextGDIPlusPropertiesParams) Name 

func (o *GetTextGDIPlusPropertiesParams) Name() string

Name just returns "GetTextGDIPlusProperties".

type GetTextGDIPlusPropertiesResponse 

type GetTextGDIPlusPropertiesResponse struct {
	requests.ResponseBasic

	// Text Alignment ("left", "center", "right").
	Align string `json:"align"`

	// Background color.
	BkColor int `json:"bk-color"`

	// Background opacity (0-100).
	BkOpacity int `json:"bk-opacity"`

	// Chat log.
	Chatlog bool `json:"chatlog"`

	// Chat log lines.
	ChatlogLines int `json:"chatlog_lines"`

	// Text color.
	Color int `json:"color"`

	// Extents wrap.
	Extents bool `json:"extents"`

	// Extents cx.
	ExtentsCx int `json:"extents_cx"`

	// Extents cy.
	ExtentsCy int `json:"extents_cy"`

	// File path name.
	File string `json:"file"`

	Font struct {
		// Font face.
		Face string `json:"face"`

		// Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`
		Flags int `json:"flags"`

		// Font text size.
		Size int `json:"size"`

		// Font Style (unknown function).
		Style string `json:"style"`
	} `json:"font"`

	// Gradient enabled.
	Gradient bool `json:"gradient"`

	// Gradient color.
	GradientColor int `json:"gradient_color"`

	// Gradient direction.
	GradientDir float64 `json:"gradient_dir"`

	// Gradient opacity (0-100).
	GradientOpacity int `json:"gradient_opacity"`

	// Outline.
	Outline bool `json:"outline"`

	// Outline color.
	OutlineColor int `json:"outline_color"`

	// Outline opacity (0-100).
	OutlineOpacity int `json:"outline_opacity"`

	// Outline size.
	OutlineSize int `json:"outline_size"`

	// Read text from the specified file.
	ReadFromFile bool `json:"read_from_file"`

	// Source name.
	Source string `json:"source"`

	// Text content to be displayed.
	Text string `json:"text"`

	// Text vertical alignment ("top", "center", "bottom").
	Valign string `json:"valign"`

	// Vertical text enabled.
	Vertical bool `json:"vertical"`
}

GetTextGDIPlusPropertiesResponse represents the response body for the "GetTextGDIPlusProperties" request. Get the current properties of a Text GDI Plus source.

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

type GetVolumeParams 

type GetVolumeParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

GetVolumeParams represents the params body for the "GetVolume" request. Get the volume of the specified source.

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

func (*GetVolumeParams) Name 

func (o *GetVolumeParams) Name() string

Name just returns "GetVolume".

type GetVolumeResponse 

type GetVolumeResponse struct {
	requests.ResponseBasic

	// Indicates whether the source is muted.
	Muted bool `json:"muted"`

	// Source name.
	Name string `json:"name"`

	// Volume of the source. Between `0.0` and `1.0`.
	Volume float64 `json:"volume"`
}

GetVolumeResponse represents the response body for the "GetVolume" request. Get the volume of the specified source.

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

type MoveSourceFilterParams 

type MoveSourceFilterParams struct {
	requests.ParamsBasic

	// Name of the filter to reorder
	FilterName string `json:"filterName"`

	// How to move the filter around in the source's filter chain. Either "up", "down", "top" or
	// "bottom".
	MovementType string `json:"movementType"`

	// Name of the source to which the filter belongs
	SourceName string `json:"sourceName"`
}

MoveSourceFilterParams represents the params body for the "MoveSourceFilter" request. Move a filter in the chain (relative positioning)

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

func (*MoveSourceFilterParams) Name 

func (o *MoveSourceFilterParams) Name() string

Name just returns "MoveSourceFilter".

type MoveSourceFilterResponse 

type MoveSourceFilterResponse struct {
	requests.ResponseBasic
}

MoveSourceFilterResponse represents the response body for the "MoveSourceFilter" request. Move a filter in the chain (relative positioning)

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

type RemoveFilterFromSourceParams 

type RemoveFilterFromSourceParams struct {
	requests.ParamsBasic

	// Name of the filter to remove
	FilterName string `json:"filterName"`

	// Name of the source from which the specified filter is removed
	SourceName string `json:"sourceName"`
}

RemoveFilterFromSourceParams represents the params body for the "RemoveFilterFromSource" request. Remove a filter from a source

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

func (*RemoveFilterFromSourceParams) Name 

func (o *RemoveFilterFromSourceParams) Name() string

Name just returns "RemoveFilterFromSource".

type RemoveFilterFromSourceResponse 

type RemoveFilterFromSourceResponse struct {
	requests.ResponseBasic
}

RemoveFilterFromSourceResponse represents the response body for the "RemoveFilterFromSource" request. Remove a filter from a source

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

type ReorderSourceFilterParams 

type ReorderSourceFilterParams struct {
	requests.ParamsBasic

	// Name of the filter to reorder
	FilterName string `json:"filterName"`

	// Desired position of the filter in the chain
	NewIndex int `json:"newIndex"`

	// Name of the source to which the filter belongs
	SourceName string `json:"sourceName"`
}

ReorderSourceFilterParams represents the params body for the "ReorderSourceFilter" request. Move a filter in the chain (absolute index positioning)

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

func (*ReorderSourceFilterParams) Name 

func (o *ReorderSourceFilterParams) Name() string

Name just returns "ReorderSourceFilter".

type ReorderSourceFilterResponse 

type ReorderSourceFilterResponse struct {
	requests.ResponseBasic
}

ReorderSourceFilterResponse represents the response body for the "ReorderSourceFilter" request. Move a filter in the chain (absolute index positioning)

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

type SetBrowserSourcePropertiesParams 

type SetBrowserSourcePropertiesParams struct {
	requests.ParamsBasic

	// CSS to inject.
	Css string `json:"css"`

	// Framerate.
	Fps int `json:"fps"`

	// Height.
	Height int `json:"height"`

	// Indicates that a local file is in use.
	IsLocalFile bool `json:"is_local_file"`

	// file path.
	LocalFile string `json:"local_file"`

	// Visibility of the scene item.
	Render bool `json:"render"`

	// Indicates whether the source should be shutdown when not visible.
	Shutdown bool `json:"shutdown"`

	// Name of the source.
	Source string `json:"source"`

	// Url.
	Url string `json:"url"`

	// Width.
	Width int `json:"width"`
}

SetBrowserSourcePropertiesParams represents the params body for the "SetBrowserSourceProperties" request. Set current properties for a Browser Source.

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

func (*SetBrowserSourcePropertiesParams) Name 

func (o *SetBrowserSourcePropertiesParams) Name() string

Name just returns "SetBrowserSourceProperties".

type SetBrowserSourcePropertiesResponse 

type SetBrowserSourcePropertiesResponse struct {
	requests.ResponseBasic
}

SetBrowserSourcePropertiesResponse represents the response body for the "SetBrowserSourceProperties" request. Set current properties for a Browser Source.

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

type SetMuteParams 

type SetMuteParams struct {
	requests.ParamsBasic

	// Desired mute status.
	Mute bool `json:"mute"`

	// Source name.
	Source string `json:"source"`
}

SetMuteParams represents the params body for the "SetMute" request. Sets the mute status of a specified source.

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

func (*SetMuteParams) Name 

func (o *SetMuteParams) Name() string

Name just returns "SetMute".

type SetMuteResponse 

type SetMuteResponse struct {
	requests.ResponseBasic
}

SetMuteResponse represents the response body for the "SetMute" request. Sets the mute status of a specified source.

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

type SetSourceFilterSettingsParams 

type SetSourceFilterSettingsParams struct {
	requests.ParamsBasic

	// Name of the filter to reconfigure
	FilterName string `json:"filterName"`

	// New settings. These will be merged to the current filter settings.
	FilterSettings map[string]interface{} `json:"filterSettings"`

	// Name of the source to which the filter belongs
	SourceName string `json:"sourceName"`
}

SetSourceFilterSettingsParams represents the params body for the "SetSourceFilterSettings" request. Update settings of a filter

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

func (*SetSourceFilterSettingsParams) Name 

func (o *SetSourceFilterSettingsParams) Name() string

Name just returns "SetSourceFilterSettings".

type SetSourceFilterSettingsResponse 

type SetSourceFilterSettingsResponse struct {
	requests.ResponseBasic
}

SetSourceFilterSettingsResponse represents the response body for the "SetSourceFilterSettings" request. Update settings of a filter

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

type SetSourceFilterVisibilityParams added in v0.3.0 

type SetSourceFilterVisibilityParams struct {
	requests.ParamsBasic

	// New filter state
	FilterEnabled string `json:"filterEnabled"`

	// Source filter name
	FilterName string `json:"filterName"`

	// Source name
	SourceName string `json:"sourceName"`
}

SetSourceFilterVisibilityParams represents the params body for the "SetSourceFilterVisibility" request. Change the visibility/enabled state of a filter

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

func (*SetSourceFilterVisibilityParams) Name added in v0.3.0 

func (o *SetSourceFilterVisibilityParams) Name() string

Name just returns "SetSourceFilterVisibility".

type SetSourceFilterVisibilityResponse added in v0.3.0 

type SetSourceFilterVisibilityResponse struct {
	requests.ResponseBasic
}

SetSourceFilterVisibilityResponse represents the response body for the "SetSourceFilterVisibility" request. Change the visibility/enabled state of a filter

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

type SetSourceSettingsParams 

type SetSourceSettingsParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName"`

	// Source settings (varies between source types, may require some probing around).
	SourceSettings map[string]interface{} `json:"sourceSettings"`

	// Type of the specified source. Useful for type-checking to avoid settings a set of settings
	// incompatible with the actual source's type.
	SourceType string `json:"sourceType"`
}

SetSourceSettingsParams represents the params body for the "SetSourceSettings" request. Set settings of the specified source.

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

func (*SetSourceSettingsParams) Name 

func (o *SetSourceSettingsParams) Name() string

Name just returns "SetSourceSettings".

type SetSourceSettingsResponse 

type SetSourceSettingsResponse struct {
	requests.ResponseBasic

	// Source name
	SourceName string `json:"sourceName"`

	// Updated source settings
	SourceSettings map[string]interface{} `json:"sourceSettings"`

	// Type of the specified source
	SourceType string `json:"sourceType"`
}

SetSourceSettingsResponse represents the response body for the "SetSourceSettings" request. Set settings of the specified source.

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

type SetSyncOffsetParams 

type SetSyncOffsetParams struct {
	requests.ParamsBasic

	// The desired audio sync offset (in nanoseconds).
	Offset int `json:"offset"`

	// Source name.
	Source string `json:"source"`
}

SetSyncOffsetParams represents the params body for the "SetSyncOffset" request. Set the audio sync offset of a specified source.

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

func (*SetSyncOffsetParams) Name 

func (o *SetSyncOffsetParams) Name() string

Name just returns "SetSyncOffset".

type SetSyncOffsetResponse 

type SetSyncOffsetResponse struct {
	requests.ResponseBasic
}

SetSyncOffsetResponse represents the response body for the "SetSyncOffset" request. Set the audio sync offset of a specified source.

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

type SetTextFreetype2PropertiesParams 

type SetTextFreetype2PropertiesParams struct {
	requests.ParamsBasic

	// Gradient top color.
	Color1 int `json:"color1"`

	// Gradient bottom color.
	Color2 int `json:"color2"`

	// Custom width (0 to disable).
	CustomWidth int `json:"custom_width"`

	// Drop shadow.
	DropShadow bool `json:"drop_shadow"`

	Font struct {
		// Font face.
		Face string `json:"face"`

		// Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`
		Flags int `json:"flags"`

		// Font text size.
		Size int `json:"size"`

		// Font Style (unknown function).
		Style string `json:"style"`
	} `json:"font"`

	// Read text from the specified file.
	FromFile bool `json:"from_file"`

	// Chat log.
	LogMode bool `json:"log_mode"`

	// Outline.
	Outline bool `json:"outline"`

	// Source name.
	Source string `json:"source"`

	// Text content to be displayed.
	Text string `json:"text"`

	// File path.
	TextFile string `json:"text_file"`

	// Word wrap.
	WordWrap bool `json:"word_wrap"`
}

SetTextFreetype2PropertiesParams represents the params body for the "SetTextFreetype2Properties" request. Set the current properties of a Text Freetype 2 source.

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

func (*SetTextFreetype2PropertiesParams) Name 

func (o *SetTextFreetype2PropertiesParams) Name() string

Name just returns "SetTextFreetype2Properties".

type SetTextFreetype2PropertiesResponse 

type SetTextFreetype2PropertiesResponse struct {
	requests.ResponseBasic
}

SetTextFreetype2PropertiesResponse represents the response body for the "SetTextFreetype2Properties" request. Set the current properties of a Text Freetype 2 source.

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

type SetTextGDIPlusPropertiesParams 

type SetTextGDIPlusPropertiesParams struct {
	requests.ParamsBasic

	// Text Alignment ("left", "center", "right").
	Align string `json:"align"`

	// Background color.
	BkColor int `json:"bk-color"`

	// Background opacity (0-100).
	BkOpacity int `json:"bk-opacity"`

	// Chat log.
	Chatlog bool `json:"chatlog"`

	// Chat log lines.
	ChatlogLines int `json:"chatlog_lines"`

	// Text color.
	Color int `json:"color"`

	// Extents wrap.
	Extents bool `json:"extents"`

	// Extents cx.
	ExtentsCx int `json:"extents_cx"`

	// Extents cy.
	ExtentsCy int `json:"extents_cy"`

	// File path name.
	File string `json:"file"`

	Font struct {
		// Font face.
		Face string `json:"face"`

		// Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`
		Flags int `json:"flags"`

		// Font text size.
		Size int `json:"size"`

		// Font Style (unknown function).
		Style string `json:"style"`
	} `json:"font"`

	// Gradient enabled.
	Gradient bool `json:"gradient"`

	// Gradient color.
	GradientColor int `json:"gradient_color"`

	// Gradient direction.
	GradientDir float64 `json:"gradient_dir"`

	// Gradient opacity (0-100).
	GradientOpacity int `json:"gradient_opacity"`

	// Outline.
	Outline bool `json:"outline"`

	// Outline color.
	OutlineColor int `json:"outline_color"`

	// Outline opacity (0-100).
	OutlineOpacity int `json:"outline_opacity"`

	// Outline size.
	OutlineSize int `json:"outline_size"`

	// Read text from the specified file.
	ReadFromFile bool `json:"read_from_file"`

	// Visibility of the scene item.
	Render bool `json:"render"`

	// Name of the source.
	Source string `json:"source"`

	// Text content to be displayed.
	Text string `json:"text"`

	// Text vertical alignment ("top", "center", "bottom").
	Valign string `json:"valign"`

	// Vertical text enabled.
	Vertical bool `json:"vertical"`
}

SetTextGDIPlusPropertiesParams represents the params body for the "SetTextGDIPlusProperties" request. Set the current properties of a Text GDI Plus source.

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

func (*SetTextGDIPlusPropertiesParams) Name 

func (o *SetTextGDIPlusPropertiesParams) Name() string

Name just returns "SetTextGDIPlusProperties".

type SetTextGDIPlusPropertiesResponse 

type SetTextGDIPlusPropertiesResponse struct {
	requests.ResponseBasic
}

SetTextGDIPlusPropertiesResponse represents the response body for the "SetTextGDIPlusProperties" request. Set the current properties of a Text GDI Plus source.

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

type SetVolumeParams 

type SetVolumeParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`

	// Desired volume. Must be between `0.0` and `1.0`.
	Volume float64 `json:"volume"`
}

SetVolumeParams represents the params body for the "SetVolume" request. Set the volume of the specified source.

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

func (*SetVolumeParams) Name 

func (o *SetVolumeParams) Name() string

Name just returns "SetVolume".

type SetVolumeResponse 

type SetVolumeResponse struct {
	requests.ResponseBasic
}

SetVolumeResponse represents the response body for the "SetVolume" request. Set the volume of the specified source.

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

type TakeSourceScreenshotParams added in v0.2.0 

type TakeSourceScreenshotParams struct {
	requests.ParamsBasic

	// Format of the Data URI encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other
	// value supported by Qt's Image module)
	EmbedPictureFormat string `json:"embedPictureFormat"`

	// Screenshot height. Defaults to the source's base height.
	Height int `json:"height"`

	// Full file path (file extension included) where the captured image is to be saved. Can be in a
	// format different from `pictureFormat`. Can be a relative path.
	SaveToFilePath string `json:"saveToFilePath"`

	// Source name. Note that, since scenes are also sources, you can also provide a scene name.
	SourceName string `json:"sourceName"`

	// Screenshot width. Defaults to the source's base width.
	Width int `json:"width"`
}

TakeSourceScreenshotParams represents the params body for the "TakeSourceScreenshot" request. Takes a picture snapshot of a source and then can either or both: - Send it over as a Data URI (base64-encoded data) in the response (by specifying `embedPictureFormat` in the request) - Save it to disk (by specifying `saveToFilePath` in the request)

At least `embedPictureFormat` or `saveToFilePath` must be specified.

Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is preserved if only one of these two parameters is specified.

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

func (*TakeSourceScreenshotParams) Name added in v0.2.0 

func (o *TakeSourceScreenshotParams) Name() string

Name just returns "TakeSourceScreenshot".

type TakeSourceScreenshotResponse added in v0.2.0 

type TakeSourceScreenshotResponse struct {
	requests.ResponseBasic

	// Absolute path to the saved image file (if `saveToFilePath` was specified in the request)
	ImageFile string `json:"imageFile"`

	// Image Data URI (if `embedPictureFormat` was specified in the request)
	Img string `json:"img"`

	// Source name
	SourceName string `json:"sourceName"`
}

TakeSourceScreenshotResponse represents the response body for the "TakeSourceScreenshot" request. Takes a picture snapshot of a source and then can either or both: - Send it over as a Data URI (base64-encoded data) in the response (by specifying `embedPictureFormat` in the request) - Save it to disk (by specifying `saveToFilePath` in the request)

At least `embedPictureFormat` or `saveToFilePath` must be specified.

Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is preserved if only one of these two parameters is specified.

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

type ToggleMuteParams 

type ToggleMuteParams struct {
	requests.ParamsBasic

	// Source name.
	Source string `json:"source"`
}

ToggleMuteParams represents the params body for the "ToggleMute" request. Inverts the mute status of a specified source.

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

func (*ToggleMuteParams) Name 

func (o *ToggleMuteParams) Name() string

Name just returns "ToggleMute".

type ToggleMuteResponse 

type ToggleMuteResponse struct {
	requests.ResponseBasic
}

ToggleMuteResponse represents the response body for the "ToggleMute" request. Inverts the mute status of a specified source.

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

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.