sources

package
v0.7.1 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2021 License: Apache-2.0 Imports: 2 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,omitempty"`

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

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

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

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`. Since 4.5.0.

func (*AddFilterToSourceParams) GetSelfName added in v0.5.0 

func (o *AddFilterToSourceParams) GetSelfName() string

GetSelfName 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`. Since v4.5.0.

type Caps added in v0.6.0 

type 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"`
}

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) CreateSource added in v0.5.0 

func (c *Client) CreateSource(params *CreateSourceParams) (*CreateSourceResponse, error)

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

func (*Client) GetAudioActive added in v0.5.0 

func (c *Client) GetAudioActive(params *GetAudioActiveParams) (*GetAudioActiveResponse, error)

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

func (*Client) GetAudioMonitorType added in v0.4.0 

func (c *Client) GetAudioMonitorType(params *GetAudioMonitorTypeParams) (*GetAudioMonitorTypeResponse, error)

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

func (*Client) GetMediaSourcesList added in v0.5.0 

func (c *Client) GetMediaSourcesList(paramss ...*GetMediaSourcesListParams) (*GetMediaSourcesListResponse, error)

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

func (*Client) GetMute 

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

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

func (*Client) GetSourceActive added in v0.5.0 

func (c *Client) GetSourceActive(params *GetSourceActiveParams) (*GetSourceActiveResponse, error)

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

func (*Client) GetSourceDefaultSettings added in v0.5.0 

func (c *Client) GetSourceDefaultSettings(
	params *GetSourceDefaultSettingsParams,
) (*GetSourceDefaultSettingsResponse, error)

GetSourceDefaultSettings 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) GetTracks added in v0.5.0 

func (c *Client) GetTracks(params *GetTracksParams) (*GetTracksResponse, error)

GetTracks 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) RefreshBrowserSource added in v0.5.0 

func (c *Client) RefreshBrowserSource(params *RefreshBrowserSourceParams) (*RefreshBrowserSourceResponse, error)

RefreshBrowserSource 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) SetAudioMonitorType added in v0.4.0 

func (c *Client) SetAudioMonitorType(params *SetAudioMonitorTypeParams) (*SetAudioMonitorTypeResponse, error)

SetAudioMonitorType 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) SetSourceName added in v0.4.0 

func (c *Client) SetSourceName(params *SetSourceNameParams) (*SetSourceNameResponse, error)

SetSourceName 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) SetTracks added in v0.5.0 

func (c *Client) SetTracks(params *SetTracksParams) (*SetTracksResponse, error)

SetTracks 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 CreateSourceParams added in v0.5.0 

type CreateSourceParams struct {
	requests.ParamsBasic

	// Scene to add the new source to.
	SceneName string `json:"sceneName,omitempty"`

	// Set the created SceneItem as visible or not. Defaults to true
	SetVisible bool `json:"setVisible"`

	// Source kind, Eg. `vlc_source`.
	SourceKind string `json:"sourceKind,omitempty"`

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

	// Source settings data.
	SourceSettings map[string]interface{} `json:"sourceSettings,omitempty"`
}

CreateSourceParams represents the params body for the "CreateSource" request. Create a source and add it as a sceneitem to a scene. Since 4.9.0.

func (*CreateSourceParams) GetSelfName added in v0.5.0 

func (o *CreateSourceParams) GetSelfName() string

GetSelfName just returns "CreateSource".

type CreateSourceResponse added in v0.5.0 

type CreateSourceResponse struct {
	requests.ResponseBasic

	// ID of the SceneItem in the scene.
	ItemId int `json:"itemId,omitempty"`
}

CreateSourceResponse represents the response body for the "CreateSource" request. Create a source and add it as a sceneitem to a scene. Since v4.9.0.

type GetAudioActiveParams added in v0.5.0 

type GetAudioActiveParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

GetAudioActiveParams represents the params body for the "GetAudioActive" request. Get the audio's active status of a specified source. Since 4.9.0.

func (*GetAudioActiveParams) GetSelfName added in v0.5.0 

func (o *GetAudioActiveParams) GetSelfName() string

GetSelfName just returns "GetAudioActive".

type GetAudioActiveResponse added in v0.5.0 

type GetAudioActiveResponse struct {
	requests.ResponseBasic

	// Audio active status of the source.
	AudioActive bool `json:"audioActive"`
}

GetAudioActiveResponse represents the response body for the "GetAudioActive" request. Get the audio's active status of a specified source. Since v4.9.0.

type GetAudioMonitorTypeParams added in v0.4.0 

type GetAudioMonitorTypeParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

GetAudioMonitorTypeParams represents the params body for the "GetAudioMonitorType" request. Get the audio monitoring type of the specified source. Since 4.8.0.

func (*GetAudioMonitorTypeParams) GetSelfName added in v0.5.0 

func (o *GetAudioMonitorTypeParams) GetSelfName() string

GetSelfName just returns "GetAudioMonitorType".

type GetAudioMonitorTypeResponse added in v0.4.0 

type GetAudioMonitorTypeResponse struct {
	requests.ResponseBasic

	// The monitor type in use. Options: `none`, `monitorOnly`, `monitorAndOutput`.
	MonitorType string `json:"monitorType,omitempty"`
}

GetAudioMonitorTypeResponse represents the response body for the "GetAudioMonitorType" request. Get the audio monitoring type of the specified source. Since v4.8.0.

type GetMediaSourcesListParams added in v0.5.0 

type GetMediaSourcesListParams struct {
	requests.ParamsBasic
}

GetMediaSourcesListParams represents the params body for the "GetMediaSourcesList" request. List the media state of all media sources (vlc and media source) Since 4.9.0.

func (*GetMediaSourcesListParams) GetSelfName added in v0.5.0 

func (o *GetMediaSourcesListParams) GetSelfName() string

GetSelfName just returns "GetMediaSourcesList".

type GetMediaSourcesListResponse added in v0.5.0 

type GetMediaSourcesListResponse struct {
	requests.ResponseBasic

	MediaSources []*MediaSource `json:"mediaSources,omitempty"`
}

GetMediaSourcesListResponse represents the response body for the "GetMediaSourcesList" request. List the media state of all media sources (vlc and media source) Since v4.9.0.

type GetMuteParams 

type GetMuteParams struct {
	requests.ParamsBasic

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

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

func (*GetMuteParams) GetSelfName added in v0.5.0 

func (o *GetMuteParams) GetSelfName() string

GetSelfName 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,omitempty"`
}

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

type GetSourceActiveParams added in v0.5.0 

type GetSourceActiveParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

GetSourceActiveParams represents the params body for the "GetSourceActive" request. Get the source's active status of a specified source (if it is showing in the final mix). Since 4.9.1.

func (*GetSourceActiveParams) GetSelfName added in v0.5.0 

func (o *GetSourceActiveParams) GetSelfName() string

GetSelfName just returns "GetSourceActive".

type GetSourceActiveResponse added in v0.5.0 

type GetSourceActiveResponse struct {
	requests.ResponseBasic

	// Source active status of the source.
	SourceActive bool `json:"sourceActive"`
}

GetSourceActiveResponse represents the response body for the "GetSourceActive" request. Get the source's active status of a specified source (if it is showing in the final mix). Since v4.9.1.

type GetSourceDefaultSettingsParams added in v0.5.0 

type GetSourceDefaultSettingsParams struct {
	requests.ParamsBasic

	// Source kind. Also called "source id" in libobs terminology.
	SourceKind string `json:"sourceKind,omitempty"`
}

GetSourceDefaultSettingsParams represents the params body for the "GetSourceDefaultSettings" request. Get the default settings for a given source type. Since 4.9.0.

func (*GetSourceDefaultSettingsParams) GetSelfName added in v0.5.0 

func (o *GetSourceDefaultSettingsParams) GetSelfName() string

GetSelfName just returns "GetSourceDefaultSettings".

type GetSourceDefaultSettingsResponse added in v0.5.0 

type GetSourceDefaultSettingsResponse struct {
	requests.ResponseBasic

	// Settings object for source.
	DefaultSettings map[string]interface{} `json:"defaultSettings,omitempty"`

	// Source kind. Same value as the `sourceKind` parameter.
	SourceKind string `json:"sourceKind,omitempty"`
}

GetSourceDefaultSettingsResponse represents the response body for the "GetSourceDefaultSettings" request. Get the default settings for a given source type. Since v4.9.0.

type GetSourceFilterInfoParams added in v0.3.0 

type GetSourceFilterInfoParams struct {
	requests.ParamsBasic

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

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

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

func (*GetSourceFilterInfoParams) GetSelfName added in v0.5.0 

func (o *GetSourceFilterInfoParams) GetSelfName() string

GetSelfName 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,omitempty"`

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

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

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

type GetSourceFiltersParams 

type GetSourceFiltersParams struct {
	requests.ParamsBasic

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

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

func (*GetSourceFiltersParams) GetSelfName added in v0.5.0 

func (o *GetSourceFiltersParams) GetSelfName() string

GetSelfName just returns "GetSourceFilters".

type GetSourceFiltersResponse 

type GetSourceFiltersResponse struct {
	requests.ResponseBasic

	// The filters for this object.
	Filters []*typedefs.Filter `json:"filters,omitempty"`
}

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

type GetSourceSettingsParams 

type GetSourceSettingsParams struct {
	requests.ParamsBasic

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

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

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

func (*GetSourceSettingsParams) GetSelfName added in v0.5.0 

func (o *GetSourceSettingsParams) GetSelfName() string

GetSelfName just returns "GetSourceSettings".

type GetSourceSettingsResponse 

type GetSourceSettingsResponse struct {
	requests.ResponseBasic

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

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

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

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

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 Since 4.3.0.

func (*GetSourceTypesListParams) GetSelfName added in v0.5.0 

func (o *GetSourceTypesListParams) GetSelfName() string

GetSelfName just returns "GetSourceTypesList".

type GetSourceTypesListResponse added in v0.2.0 

type GetSourceTypesListResponse struct {
	requests.ResponseBasic

	Types []*Type `json:"types,omitempty"`
}

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

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 Since 4.3.0.

func (*GetSourcesListParams) GetSelfName added in v0.5.0 

func (o *GetSourcesListParams) GetSelfName() string

GetSelfName just returns "GetSourcesList".

type GetSourcesListResponse 

type GetSourcesListResponse struct {
	requests.ResponseBasic

	Sources []*Source `json:"sources,omitempty"`
}

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

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. Since 4.1.0.

func (*GetSpecialSourcesParams) GetSelfName added in v0.5.0 

func (o *GetSpecialSourcesParams) GetSelfName() string

GetSelfName just returns "GetSpecialSources".

type GetSpecialSourcesResponse 

type GetSpecialSourcesResponse struct {
	requests.ResponseBasic

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

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

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

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

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

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

type GetSyncOffsetParams 

type GetSyncOffsetParams struct {
	requests.ParamsBasic

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

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

func (*GetSyncOffsetParams) GetSelfName added in v0.5.0 

func (o *GetSyncOffsetParams) GetSelfName() string

GetSelfName just returns "GetSyncOffset".

type GetSyncOffsetResponse 

type GetSyncOffsetResponse struct {
	requests.ResponseBasic

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

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

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

type GetTextFreetype2PropertiesParams 

type GetTextFreetype2PropertiesParams struct {
	requests.ParamsBasic

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

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

func (*GetTextFreetype2PropertiesParams) GetSelfName added in v0.5.0 

func (o *GetTextFreetype2PropertiesParams) GetSelfName() string

GetSelfName just returns "GetTextFreetype2Properties".

type GetTextFreetype2PropertiesResponse 

type GetTextFreetype2PropertiesResponse struct {
	requests.ResponseBasic

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

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

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

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

	// The font specification for this object.
	Font *typedefs.Font `json:"font,omitempty"`

	// 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,omitempty"`

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

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

	// 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. Since v4.5.0.

type GetTextGDIPlusPropertiesParams 

type GetTextGDIPlusPropertiesParams struct {
	requests.ParamsBasic

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

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

func (*GetTextGDIPlusPropertiesParams) GetSelfName added in v0.5.0 

func (o *GetTextGDIPlusPropertiesParams) GetSelfName() string

GetSelfName just returns "GetTextGDIPlusProperties".

type GetTextGDIPlusPropertiesResponse 

type GetTextGDIPlusPropertiesResponse struct {
	requests.ResponseBasic

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

	// Background color.
	BkColor int `json:"bk_color,omitempty"`

	// Background opacity (0-100).
	BkOpacity int `json:"bk_opacity,omitempty"`

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

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

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

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

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

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

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

	// The font specification for this object.
	Font *typedefs.Font `json:"font,omitempty"`

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

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

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

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

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

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

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

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

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

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

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

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

	// 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. Since v4.1.0.

type GetTracksParams added in v0.5.0 

type GetTracksParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

GetTracksParams represents the params body for the "GetTracks" request. Gets whether an audio track is active for a source. Since 4.9.1.

func (*GetTracksParams) GetSelfName added in v0.5.0 

func (o *GetTracksParams) GetSelfName() string

GetSelfName just returns "GetTracks".

type GetTracksResponse added in v0.5.0 

type GetTracksResponse struct {
	requests.ResponseBasic

	Track1 bool `json:"track1"`

	Track2 bool `json:"track2"`

	Track3 bool `json:"track3"`

	Track4 bool `json:"track4"`

	Track5 bool `json:"track5"`

	Track6 bool `json:"track6"`
}

GetTracksResponse represents the response body for the "GetTracks" request. Gets whether an audio track is active for a source. Since v4.9.1.

type GetVolumeParams 

type GetVolumeParams struct {
	requests.ParamsBasic

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

	// Output volume in decibels of attenuation instead of amplitude/mul.
	UseDecibel bool `json:"useDecibel"`
}

GetVolumeParams represents the params body for the "GetVolume" request. Get the volume of the specified source. Default response uses mul format, NOT SLIDER PERCENTAGE. Since 4.0.0.

func (*GetVolumeParams) GetSelfName added in v0.5.0 

func (o *GetVolumeParams) GetSelfName() string

GetSelfName 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,omitempty"`

	// Volume of the source. Between `0.0` and `20.0` if using mul, under `26.0` if using dB.
	Volume float64 `json:"volume,omitempty"`
}

GetVolumeResponse represents the response body for the "GetVolume" request. Get the volume of the specified source. Default response uses mul format, NOT SLIDER PERCENTAGE. Since v4.0.0.

type MediaSource added in v0.6.0 

type MediaSource struct {
	// The current state of media for that source. States: `none`, `playing`, `opening`, `buffering`, `paused`,
	// `stopped`, `ended`, `error`, `unknown`
	MediaState string `json:"mediaState,omitempty"`

	// Unique source internal type (a.k.a `ffmpeg_source` or `vlc_source`)
	SourceKind string `json:"sourceKind,omitempty"`

	// Unique source name
	SourceName string `json:"sourceName,omitempty"`
}

type MoveSourceFilterParams 

type MoveSourceFilterParams struct {
	requests.ParamsBasic

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

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

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

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

func (*MoveSourceFilterParams) GetSelfName added in v0.5.0 

func (o *MoveSourceFilterParams) GetSelfName() string

GetSelfName 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) Since v4.5.0.

type RefreshBrowserSourceParams added in v0.5.0 

type RefreshBrowserSourceParams struct {
	requests.ParamsBasic

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

RefreshBrowserSourceParams represents the params body for the "RefreshBrowserSource" request. Refreshes the specified browser source. Since 4.9.0.

func (*RefreshBrowserSourceParams) GetSelfName added in v0.5.0 

func (o *RefreshBrowserSourceParams) GetSelfName() string

GetSelfName just returns "RefreshBrowserSource".

type RefreshBrowserSourceResponse added in v0.5.0 

type RefreshBrowserSourceResponse struct {
	requests.ResponseBasic
}

RefreshBrowserSourceResponse represents the response body for the "RefreshBrowserSource" request. Refreshes the specified browser source. Since v4.9.0.

type RemoveFilterFromSourceParams 

type RemoveFilterFromSourceParams struct {
	requests.ParamsBasic

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

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

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

func (*RemoveFilterFromSourceParams) GetSelfName added in v0.5.0 

func (o *RemoveFilterFromSourceParams) GetSelfName() string

GetSelfName 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 Since v4.5.0.

type ReorderSourceFilterParams 

type ReorderSourceFilterParams struct {
	requests.ParamsBasic

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

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

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

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

func (*ReorderSourceFilterParams) GetSelfName added in v0.5.0 

func (o *ReorderSourceFilterParams) GetSelfName() string

GetSelfName 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) Since v4.5.0.

type SetAudioMonitorTypeParams added in v0.4.0 

type SetAudioMonitorTypeParams struct {
	requests.ParamsBasic

	// The monitor type to use. Options: `none`, `monitorOnly`, `monitorAndOutput`.
	MonitorType string `json:"monitorType,omitempty"`

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

SetAudioMonitorTypeParams represents the params body for the "SetAudioMonitorType" request. Set the audio monitoring type of the specified source. Since 4.8.0.

func (*SetAudioMonitorTypeParams) GetSelfName added in v0.5.0 

func (o *SetAudioMonitorTypeParams) GetSelfName() string

GetSelfName just returns "SetAudioMonitorType".

type SetAudioMonitorTypeResponse added in v0.4.0 

type SetAudioMonitorTypeResponse struct {
	requests.ResponseBasic
}

SetAudioMonitorTypeResponse represents the response body for the "SetAudioMonitorType" request. Set the audio monitoring type of the specified source. Since v4.8.0.

type SetMuteParams 

type SetMuteParams struct {
	requests.ParamsBasic

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

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

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

func (*SetMuteParams) GetSelfName added in v0.5.0 

func (o *SetMuteParams) GetSelfName() string

GetSelfName 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. Since v4.0.0.

type SetSourceFilterSettingsParams 

type SetSourceFilterSettingsParams struct {
	requests.ParamsBasic

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

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

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

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

func (*SetSourceFilterSettingsParams) GetSelfName added in v0.5.0 

func (o *SetSourceFilterSettingsParams) GetSelfName() string

GetSelfName just returns "SetSourceFilterSettings".

type SetSourceFilterSettingsResponse 

type SetSourceFilterSettingsResponse struct {
	requests.ResponseBasic
}

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

type SetSourceFilterVisibilityParams added in v0.3.0 

type SetSourceFilterVisibilityParams struct {
	requests.ParamsBasic

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

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

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

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

func (*SetSourceFilterVisibilityParams) GetSelfName added in v0.5.0 

func (o *SetSourceFilterVisibilityParams) GetSelfName() string

GetSelfName 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 Since v4.7.0.

type SetSourceNameParams added in v0.4.0 

type SetSourceNameParams struct {
	requests.ParamsBasic

	// New source name.
	NewName string `json:"newName,omitempty"`

	// Source name.
	SourceName string `json:"sourceName,omitempty"`
}

SetSourceNameParams represents the params body for the "SetSourceName" request. Sets (aka rename) the name of a source. Also works with scenes since scenes are technically sources in OBS.

Note: If the new name already exists as a source, obs-websocket will return an error. Since 4.8.0.

func (*SetSourceNameParams) GetSelfName added in v0.5.0 

func (o *SetSourceNameParams) GetSelfName() string

GetSelfName just returns "SetSourceName".

type SetSourceNameResponse added in v0.4.0 

type SetSourceNameResponse struct {
	requests.ResponseBasic
}

SetSourceNameResponse represents the response body for the "SetSourceName" request. Sets (aka rename) the name of a source. Also works with scenes since scenes are technically sources in OBS.

Note: If the new name already exists as a source, obs-websocket will return an error. Since v4.8.0.

type SetSourceSettingsParams 

type SetSourceSettingsParams struct {
	requests.ParamsBasic

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

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

	// 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,omitempty"`
}

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

func (*SetSourceSettingsParams) GetSelfName added in v0.5.0 

func (o *SetSourceSettingsParams) GetSelfName() string

GetSelfName just returns "SetSourceSettings".

type SetSourceSettingsResponse 

type SetSourceSettingsResponse struct {
	requests.ResponseBasic

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

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

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

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

type SetSyncOffsetParams 

type SetSyncOffsetParams struct {
	requests.ParamsBasic

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

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

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

func (*SetSyncOffsetParams) GetSelfName added in v0.5.0 

func (o *SetSyncOffsetParams) GetSelfName() string

GetSelfName 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. Since v4.2.0.

type SetTextFreetype2PropertiesParams 

type SetTextFreetype2PropertiesParams struct {
	requests.ParamsBasic

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

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

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

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

	// The font specification for this object.
	Font *typedefs.Font `json:"font,omitempty"`

	// 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,omitempty"`

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

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

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

func (*SetTextFreetype2PropertiesParams) GetSelfName added in v0.5.0 

func (o *SetTextFreetype2PropertiesParams) GetSelfName() string

GetSelfName 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. Since v4.5.0.

type SetTextGDIPlusPropertiesParams 

type SetTextGDIPlusPropertiesParams struct {
	requests.ParamsBasic

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

	// Background color.
	BkColor int `json:"bk_color,omitempty"`

	// Background opacity (0-100).
	BkOpacity int `json:"bk_opacity,omitempty"`

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

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

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

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

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

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

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

	// The font specification for this object.
	Font *typedefs.Font `json:"font,omitempty"`

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

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

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

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

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

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

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

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

	// 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,omitempty"`

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

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

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

func (*SetTextGDIPlusPropertiesParams) GetSelfName added in v0.5.0 

func (o *SetTextGDIPlusPropertiesParams) GetSelfName() string

GetSelfName 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. Since v4.1.0.

type SetTracksParams added in v0.5.0 

type SetTracksParams struct {
	requests.ParamsBasic

	// Whether audio track is active or not.
	Active bool `json:"active"`

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

	// Audio tracks 1-6.
	Track int `json:"track,omitempty"`
}

SetTracksParams represents the params body for the "SetTracks" request. Changes whether an audio track is active for a source. Since 4.9.1.

func (*SetTracksParams) GetSelfName added in v0.5.0 

func (o *SetTracksParams) GetSelfName() string

GetSelfName just returns "SetTracks".

type SetTracksResponse added in v0.5.0 

type SetTracksResponse struct {
	requests.ResponseBasic
}

SetTracksResponse represents the response body for the "SetTracks" request. Changes whether an audio track is active for a source. Since v4.9.1.

type SetVolumeParams 

type SetVolumeParams struct {
	requests.ParamsBasic

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

	// Interperet `volume` data as decibels instead of amplitude/mul.
	UseDecibel bool `json:"useDecibel"`

	// Desired volume. Must be between `0.0` and `20.0` for mul, and under 26.0 for dB. OBS will interpret dB values
	// under -100.0 as Inf. Note: The OBS volume sliders only reach a maximum of 1.0mul/0.0dB, however OBS actually
	// supports larger values.
	Volume float64 `json:"volume,omitempty"`
}

SetVolumeParams represents the params body for the "SetVolume" request. Set the volume of the specified source. Default request format uses mul, NOT SLIDER PERCENTAGE. Since 4.0.0.

func (*SetVolumeParams) GetSelfName added in v0.5.0 

func (o *SetVolumeParams) GetSelfName() string

GetSelfName 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. Default request format uses mul, NOT SLIDER PERCENTAGE. Since v4.0.0.

type Source added in v0.6.0 

type Source struct {
	// Unique source name
	Name string `json:"name,omitempty"`

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

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

type TakeSourceScreenshotParams added in v0.2.0 

type TakeSourceScreenshotParams struct {
	requests.ParamsBasic

	// Compression ratio between -1 and 100 to write the image with. -1 is automatic, 1 is smallest file/most
	// compression, 100 is largest file/least compression. Varies with image type.
	CompressionQuality int `json:"compressionQuality,omitempty"`

	// 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,omitempty"`

	// Format to save the image file as (one of the values provided in the `supported-image-export-formats` response
	// field of `GetVersion`). If not specified, tries to guess based on file extension.
	FileFormat string `json:"fileFormat,omitempty"`

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

	// 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,omitempty"`

	// Source name. Note: Since scenes are also sources, you can also provide a scene name. If not provided, the
	// currently active scene is used.
	SourceName string `json:"sourceName,omitempty"`

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

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. Since 4.6.0.

func (*TakeSourceScreenshotParams) GetSelfName added in v0.5.0 

func (o *TakeSourceScreenshotParams) GetSelfName() string

GetSelfName 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,omitempty"`

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

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

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. Since v4.6.0.

type ToggleMuteParams 

type ToggleMuteParams struct {
	requests.ParamsBasic

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

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

func (*ToggleMuteParams) GetSelfName added in v0.5.0 

func (o *ToggleMuteParams) GetSelfName() string

GetSelfName 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. Since v4.0.0.

type Type added in v0.6.0 

type Type struct {
	Caps *Caps `json:"caps,omitempty"`

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

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

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.