Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateInput(params *CreateInputParams) (*CreateInputResponse, error)
- func (c *Client) GetInputAudioBalance(paramss ...*GetInputAudioBalanceParams) (*GetInputAudioBalanceResponse, error)
- func (c *Client) GetInputAudioMonitorType(paramss ...*GetInputAudioMonitorTypeParams) (*GetInputAudioMonitorTypeResponse, error)
- func (c *Client) GetInputAudioSyncOffset(paramss ...*GetInputAudioSyncOffsetParams) (*GetInputAudioSyncOffsetResponse, error)
- func (c *Client) GetInputAudioTracks(paramss ...*GetInputAudioTracksParams) (*GetInputAudioTracksResponse, error)
- func (c *Client) GetInputDefaultSettings(params *GetInputDefaultSettingsParams) (*GetInputDefaultSettingsResponse, error)
- func (c *Client) GetInputKindList(paramss ...*GetInputKindListParams) (*GetInputKindListResponse, error)
- func (c *Client) GetInputList(paramss ...*GetInputListParams) (*GetInputListResponse, error)
- func (c *Client) GetInputMute(paramss ...*GetInputMuteParams) (*GetInputMuteResponse, error)
- func (c *Client) GetInputPropertiesListPropertyItems(params *GetInputPropertiesListPropertyItemsParams) (*GetInputPropertiesListPropertyItemsResponse, error)
- func (c *Client) GetInputSettings(paramss ...*GetInputSettingsParams) (*GetInputSettingsResponse, error)
- func (c *Client) GetInputVolume(paramss ...*GetInputVolumeParams) (*GetInputVolumeResponse, error)
- func (c *Client) GetSpecialInputs(paramss ...*GetSpecialInputsParams) (*GetSpecialInputsResponse, error)
- func (c *Client) PressInputPropertiesButton(params *PressInputPropertiesButtonParams) (*PressInputPropertiesButtonResponse, error)
- func (c *Client) RemoveInput(paramss ...*RemoveInputParams) (*RemoveInputResponse, error)
- func (c *Client) SetInputAudioBalance(params *SetInputAudioBalanceParams) (*SetInputAudioBalanceResponse, error)
- func (c *Client) SetInputAudioMonitorType(params *SetInputAudioMonitorTypeParams) (*SetInputAudioMonitorTypeResponse, error)
- func (c *Client) SetInputAudioSyncOffset(params *SetInputAudioSyncOffsetParams) (*SetInputAudioSyncOffsetResponse, error)
- func (c *Client) SetInputAudioTracks(params *SetInputAudioTracksParams) (*SetInputAudioTracksResponse, error)
- func (c *Client) SetInputMute(params *SetInputMuteParams) (*SetInputMuteResponse, error)
- func (c *Client) SetInputName(params *SetInputNameParams) (*SetInputNameResponse, error)
- func (c *Client) SetInputSettings(params *SetInputSettingsParams) (*SetInputSettingsResponse, error)
- func (c *Client) SetInputVolume(paramss ...*SetInputVolumeParams) (*SetInputVolumeResponse, error)
- func (c *Client) ToggleInputMute(paramss ...*ToggleInputMuteParams) (*ToggleInputMuteResponse, error)
- type CreateInputParams
- func (o *CreateInputParams) GetRequestName() string
- func (o *CreateInputParams) WithInputKind(x string) *CreateInputParams
- func (o *CreateInputParams) WithInputName(x string) *CreateInputParams
- func (o *CreateInputParams) WithInputSettings(x map[string]any) *CreateInputParams
- func (o *CreateInputParams) WithSceneItemEnabled(x bool) *CreateInputParams
- func (o *CreateInputParams) WithSceneName(x string) *CreateInputParams
- func (o *CreateInputParams) WithSceneUuid(x string) *CreateInputParams
- type CreateInputResponse
- type GetInputAudioBalanceParams
- type GetInputAudioBalanceResponse
- type GetInputAudioMonitorTypeParams
- type GetInputAudioMonitorTypeResponse
- type GetInputAudioSyncOffsetParams
- type GetInputAudioSyncOffsetResponse
- type GetInputAudioTracksParams
- type GetInputAudioTracksResponse
- type GetInputDefaultSettingsParams
- type GetInputDefaultSettingsResponse
- type GetInputKindListParams
- type GetInputKindListResponse
- type GetInputListParams
- type GetInputListResponse
- type GetInputMuteParams
- type GetInputMuteResponse
- type GetInputPropertiesListPropertyItemsParams
- func (o *GetInputPropertiesListPropertyItemsParams) GetRequestName() string
- func (o *GetInputPropertiesListPropertyItemsParams) WithInputName(x string) *GetInputPropertiesListPropertyItemsParams
- func (o *GetInputPropertiesListPropertyItemsParams) WithInputUuid(x string) *GetInputPropertiesListPropertyItemsParams
- func (o *GetInputPropertiesListPropertyItemsParams) WithPropertyName(x string) *GetInputPropertiesListPropertyItemsParams
- type GetInputPropertiesListPropertyItemsResponse
- type GetInputSettingsParams
- type GetInputSettingsResponse
- type GetInputVolumeParams
- type GetInputVolumeResponse
- type GetSpecialInputsParams
- type GetSpecialInputsResponse
- type PressInputPropertiesButtonParams
- func (o *PressInputPropertiesButtonParams) GetRequestName() string
- func (o *PressInputPropertiesButtonParams) WithInputName(x string) *PressInputPropertiesButtonParams
- func (o *PressInputPropertiesButtonParams) WithInputUuid(x string) *PressInputPropertiesButtonParams
- func (o *PressInputPropertiesButtonParams) WithPropertyName(x string) *PressInputPropertiesButtonParams
- type PressInputPropertiesButtonResponse
- type RemoveInputParams
- type RemoveInputResponse
- type SetInputAudioBalanceParams
- func (o *SetInputAudioBalanceParams) GetRequestName() string
- func (o *SetInputAudioBalanceParams) WithInputAudioBalance(x float64) *SetInputAudioBalanceParams
- func (o *SetInputAudioBalanceParams) WithInputName(x string) *SetInputAudioBalanceParams
- func (o *SetInputAudioBalanceParams) WithInputUuid(x string) *SetInputAudioBalanceParams
- type SetInputAudioBalanceResponse
- type SetInputAudioMonitorTypeParams
- func (o *SetInputAudioMonitorTypeParams) GetRequestName() string
- func (o *SetInputAudioMonitorTypeParams) WithInputName(x string) *SetInputAudioMonitorTypeParams
- func (o *SetInputAudioMonitorTypeParams) WithInputUuid(x string) *SetInputAudioMonitorTypeParams
- func (o *SetInputAudioMonitorTypeParams) WithMonitorType(x string) *SetInputAudioMonitorTypeParams
- type SetInputAudioMonitorTypeResponse
- type SetInputAudioSyncOffsetParams
- func (o *SetInputAudioSyncOffsetParams) GetRequestName() string
- func (o *SetInputAudioSyncOffsetParams) WithInputAudioSyncOffset(x float64) *SetInputAudioSyncOffsetParams
- func (o *SetInputAudioSyncOffsetParams) WithInputName(x string) *SetInputAudioSyncOffsetParams
- func (o *SetInputAudioSyncOffsetParams) WithInputUuid(x string) *SetInputAudioSyncOffsetParams
- type SetInputAudioSyncOffsetResponse
- type SetInputAudioTracksParams
- func (o *SetInputAudioTracksParams) GetRequestName() string
- func (o *SetInputAudioTracksParams) WithInputAudioTracks(x *typedefs.InputAudioTracks) *SetInputAudioTracksParams
- func (o *SetInputAudioTracksParams) WithInputName(x string) *SetInputAudioTracksParams
- func (o *SetInputAudioTracksParams) WithInputUuid(x string) *SetInputAudioTracksParams
- type SetInputAudioTracksResponse
- type SetInputMuteParams
- type SetInputMuteResponse
- type SetInputNameParams
- type SetInputNameResponse
- type SetInputSettingsParams
- func (o *SetInputSettingsParams) GetRequestName() string
- func (o *SetInputSettingsParams) WithInputName(x string) *SetInputSettingsParams
- func (o *SetInputSettingsParams) WithInputSettings(x map[string]any) *SetInputSettingsParams
- func (o *SetInputSettingsParams) WithInputUuid(x string) *SetInputSettingsParams
- func (o *SetInputSettingsParams) WithOverlay(x bool) *SetInputSettingsParams
- type SetInputSettingsResponse
- type SetInputVolumeParams
- func (o *SetInputVolumeParams) GetRequestName() string
- func (o *SetInputVolumeParams) WithInputName(x string) *SetInputVolumeParams
- func (o *SetInputVolumeParams) WithInputUuid(x string) *SetInputVolumeParams
- func (o *SetInputVolumeParams) WithInputVolumeDb(x float64) *SetInputVolumeParams
- func (o *SetInputVolumeParams) WithInputVolumeMul(x float64) *SetInputVolumeParams
- type SetInputVolumeResponse
- type ToggleInputMuteParams
- type ToggleInputMuteResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a client for 'inputs' requests.
func (*Client) CreateInput ¶
func (c *Client) CreateInput(params *CreateInputParams) (*CreateInputResponse, error)
Creates a new input, adding it as a scene item to the specified scene.
func (*Client) GetInputAudioBalance ¶
func (c *Client) GetInputAudioBalance(paramss ...*GetInputAudioBalanceParams) (*GetInputAudioBalanceResponse, error)
Gets the audio balance of an input.
func (*Client) GetInputAudioMonitorType ¶
func (c *Client) GetInputAudioMonitorType( paramss ...*GetInputAudioMonitorTypeParams, ) (*GetInputAudioMonitorTypeResponse, error)
Gets the audio monitor type of an input.
The available audio monitor types are:
- `OBS_MONITORING_TYPE_NONE` - `OBS_MONITORING_TYPE_MONITOR_ONLY` - `OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT`
func (*Client) GetInputAudioSyncOffset ¶
func (c *Client) GetInputAudioSyncOffset( paramss ...*GetInputAudioSyncOffsetParams, ) (*GetInputAudioSyncOffsetResponse, error)
Gets the audio sync offset of an input.
Note: The audio sync offset can be negative too!
func (*Client) GetInputAudioTracks ¶
func (c *Client) GetInputAudioTracks(paramss ...*GetInputAudioTracksParams) (*GetInputAudioTracksResponse, error)
Gets the enable state of all audio tracks of an input.
func (*Client) GetInputDefaultSettings ¶
func (c *Client) GetInputDefaultSettings( params *GetInputDefaultSettingsParams, ) (*GetInputDefaultSettingsResponse, error)
Gets the default settings for an input kind.
func (*Client) GetInputKindList ¶
func (c *Client) GetInputKindList(paramss ...*GetInputKindListParams) (*GetInputKindListResponse, error)
Gets an array of all available input kinds in OBS.
func (*Client) GetInputList ¶
func (c *Client) GetInputList(paramss ...*GetInputListParams) (*GetInputListResponse, error)
Gets an array of all inputs in OBS.
func (*Client) GetInputMute ¶
func (c *Client) GetInputMute(paramss ...*GetInputMuteParams) (*GetInputMuteResponse, error)
Gets the audio mute state of an input.
func (*Client) GetInputPropertiesListPropertyItems ¶
func (c *Client) GetInputPropertiesListPropertyItems( params *GetInputPropertiesListPropertyItemsParams, ) (*GetInputPropertiesListPropertyItemsResponse, error)
Gets the items of a list property from an input's properties.
Note: Use this in cases where an input provides a dynamic, selectable list of items. For example, display capture, where it provides a list of available displays.
func (*Client) GetInputSettings ¶
func (c *Client) GetInputSettings(paramss ...*GetInputSettingsParams) (*GetInputSettingsResponse, error)
Gets the settings of an input.
Note: Does not include defaults. To create the entire settings object, overlay `inputSettings` over the `defaultInputSettings` provided by `GetInputDefaultSettings`.
func (*Client) GetInputVolume ¶
func (c *Client) GetInputVolume(paramss ...*GetInputVolumeParams) (*GetInputVolumeResponse, error)
Gets the current volume setting of an input.
func (*Client) GetSpecialInputs ¶
func (c *Client) GetSpecialInputs(paramss ...*GetSpecialInputsParams) (*GetSpecialInputsResponse, error)
Gets the names of all special inputs.
func (*Client) PressInputPropertiesButton ¶
func (c *Client) PressInputPropertiesButton( params *PressInputPropertiesButtonParams, ) (*PressInputPropertiesButtonResponse, error)
Presses a button in the properties of an input.
Some known `propertyName` values are:
- `refreshnocache` - Browser source reload button
Note: Use this in cases where there is a button in the properties of an input that cannot be accessed in any other way. For example, browser sources, where there is a refresh button.
func (*Client) RemoveInput ¶
func (c *Client) RemoveInput(paramss ...*RemoveInputParams) (*RemoveInputResponse, error)
Removes an existing input.
Note: Will immediately remove all associated scene items.
func (*Client) SetInputAudioBalance ¶
func (c *Client) SetInputAudioBalance(params *SetInputAudioBalanceParams) (*SetInputAudioBalanceResponse, error)
Sets the audio balance of an input.
func (*Client) SetInputAudioMonitorType ¶
func (c *Client) SetInputAudioMonitorType( params *SetInputAudioMonitorTypeParams, ) (*SetInputAudioMonitorTypeResponse, error)
Sets the audio monitor type of an input.
func (*Client) SetInputAudioSyncOffset ¶
func (c *Client) SetInputAudioSyncOffset( params *SetInputAudioSyncOffsetParams, ) (*SetInputAudioSyncOffsetResponse, error)
Sets the audio sync offset of an input.
func (*Client) SetInputAudioTracks ¶
func (c *Client) SetInputAudioTracks(params *SetInputAudioTracksParams) (*SetInputAudioTracksResponse, error)
Sets the enable state of audio tracks of an input.
func (*Client) SetInputMute ¶
func (c *Client) SetInputMute(params *SetInputMuteParams) (*SetInputMuteResponse, error)
Sets the audio mute state of an input.
func (*Client) SetInputName ¶
func (c *Client) SetInputName(params *SetInputNameParams) (*SetInputNameResponse, error)
Sets the name of an input (rename).
func (*Client) SetInputSettings ¶
func (c *Client) SetInputSettings(params *SetInputSettingsParams) (*SetInputSettingsResponse, error)
Sets the settings of an input.
func (*Client) SetInputVolume ¶
func (c *Client) SetInputVolume(paramss ...*SetInputVolumeParams) (*SetInputVolumeResponse, error)
Sets the volume setting of an input.
func (*Client) ToggleInputMute ¶
func (c *Client) ToggleInputMute(paramss ...*ToggleInputMuteParams) (*ToggleInputMuteResponse, error)
Toggles the audio mute state of an input.
type CreateInputParams ¶
type CreateInputParams struct {
// The kind of input to be created
InputKind *string `json:"inputKind,omitempty"`
// Name of the new input to created
InputName *string `json:"inputName,omitempty"`
// Settings object to initialize the input with
InputSettings map[string]any `json:"inputSettings,omitempty"`
// Whether to set the created scene item to enabled or disabled
SceneItemEnabled *bool `json:"sceneItemEnabled,omitempty"`
// Name of the scene to add the input to as a scene item
SceneName *string `json:"sceneName,omitempty"`
// UUID of the scene to add the input to as a scene item
SceneUuid *string `json:"sceneUuid,omitempty"`
}
Represents the request body for the CreateInput request.
func NewCreateInputParams ¶
func NewCreateInputParams() *CreateInputParams
func (*CreateInputParams) GetRequestName ¶
func (o *CreateInputParams) GetRequestName() string
Returns the associated request.
func (*CreateInputParams) WithInputKind ¶
func (o *CreateInputParams) WithInputKind(x string) *CreateInputParams
func (*CreateInputParams) WithInputName ¶
func (o *CreateInputParams) WithInputName(x string) *CreateInputParams
func (*CreateInputParams) WithInputSettings ¶
func (o *CreateInputParams) WithInputSettings(x map[string]any) *CreateInputParams
func (*CreateInputParams) WithSceneItemEnabled ¶
func (o *CreateInputParams) WithSceneItemEnabled(x bool) *CreateInputParams
func (*CreateInputParams) WithSceneName ¶
func (o *CreateInputParams) WithSceneName(x string) *CreateInputParams
func (*CreateInputParams) WithSceneUuid ¶
func (o *CreateInputParams) WithSceneUuid(x string) *CreateInputParams
type CreateInputResponse ¶
type CreateInputResponse struct {
// UUID of the newly created input
InputUuid string `json:"inputUuid,omitempty"`
// ID of the newly created scene item
SceneItemId int `json:"sceneItemId,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the CreateInput request.
type GetInputAudioBalanceParams ¶
type GetInputAudioBalanceParams struct {
// Name of the input to get the audio balance of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to get the audio balance of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputAudioBalance request.
func NewGetInputAudioBalanceParams ¶
func NewGetInputAudioBalanceParams() *GetInputAudioBalanceParams
func (*GetInputAudioBalanceParams) GetRequestName ¶
func (o *GetInputAudioBalanceParams) GetRequestName() string
Returns the associated request.
func (*GetInputAudioBalanceParams) WithInputName ¶
func (o *GetInputAudioBalanceParams) WithInputName(x string) *GetInputAudioBalanceParams
func (*GetInputAudioBalanceParams) WithInputUuid ¶
func (o *GetInputAudioBalanceParams) WithInputUuid(x string) *GetInputAudioBalanceParams
type GetInputAudioBalanceResponse ¶
type GetInputAudioBalanceResponse struct {
// Audio balance value from 0.0-1.0
InputAudioBalance float64 `json:"inputAudioBalance,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputAudioBalance request.
type GetInputAudioMonitorTypeParams ¶
type GetInputAudioMonitorTypeParams struct {
// Name of the input to get the audio monitor type of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to get the audio monitor type of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputAudioMonitorType request.
func NewGetInputAudioMonitorTypeParams ¶
func NewGetInputAudioMonitorTypeParams() *GetInputAudioMonitorTypeParams
func (*GetInputAudioMonitorTypeParams) GetRequestName ¶
func (o *GetInputAudioMonitorTypeParams) GetRequestName() string
Returns the associated request.
func (*GetInputAudioMonitorTypeParams) WithInputName ¶
func (o *GetInputAudioMonitorTypeParams) WithInputName(x string) *GetInputAudioMonitorTypeParams
func (*GetInputAudioMonitorTypeParams) WithInputUuid ¶
func (o *GetInputAudioMonitorTypeParams) WithInputUuid(x string) *GetInputAudioMonitorTypeParams
type GetInputAudioMonitorTypeResponse ¶
type GetInputAudioMonitorTypeResponse struct {
// Audio monitor type
MonitorType string `json:"monitorType,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputAudioMonitorType request.
type GetInputAudioSyncOffsetParams ¶
type GetInputAudioSyncOffsetParams struct {
// Name of the input to get the audio sync offset of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to get the audio sync offset of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputAudioSyncOffset request.
func NewGetInputAudioSyncOffsetParams ¶
func NewGetInputAudioSyncOffsetParams() *GetInputAudioSyncOffsetParams
func (*GetInputAudioSyncOffsetParams) GetRequestName ¶
func (o *GetInputAudioSyncOffsetParams) GetRequestName() string
Returns the associated request.
func (*GetInputAudioSyncOffsetParams) WithInputName ¶
func (o *GetInputAudioSyncOffsetParams) WithInputName(x string) *GetInputAudioSyncOffsetParams
func (*GetInputAudioSyncOffsetParams) WithInputUuid ¶
func (o *GetInputAudioSyncOffsetParams) WithInputUuid(x string) *GetInputAudioSyncOffsetParams
type GetInputAudioSyncOffsetResponse ¶
type GetInputAudioSyncOffsetResponse struct {
// Audio sync offset in milliseconds
InputAudioSyncOffset float64 `json:"inputAudioSyncOffset,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputAudioSyncOffset request.
type GetInputAudioTracksParams ¶
type GetInputAudioTracksParams struct {
// Name of the input
InputName *string `json:"inputName,omitempty"`
// UUID of the input
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputAudioTracks request.
func NewGetInputAudioTracksParams ¶
func NewGetInputAudioTracksParams() *GetInputAudioTracksParams
func (*GetInputAudioTracksParams) GetRequestName ¶
func (o *GetInputAudioTracksParams) GetRequestName() string
Returns the associated request.
func (*GetInputAudioTracksParams) WithInputName ¶
func (o *GetInputAudioTracksParams) WithInputName(x string) *GetInputAudioTracksParams
func (*GetInputAudioTracksParams) WithInputUuid ¶
func (o *GetInputAudioTracksParams) WithInputUuid(x string) *GetInputAudioTracksParams
type GetInputAudioTracksResponse ¶
type GetInputAudioTracksResponse struct {
// Object of audio tracks and associated enable states
InputAudioTracks *typedefs.InputAudioTracks `json:"inputAudioTracks,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputAudioTracks request.
type GetInputDefaultSettingsParams ¶
type GetInputDefaultSettingsParams struct {
// Input kind to get the default settings for
InputKind *string `json:"inputKind,omitempty"`
}
Represents the request body for the GetInputDefaultSettings request.
func NewGetInputDefaultSettingsParams ¶
func NewGetInputDefaultSettingsParams() *GetInputDefaultSettingsParams
func (*GetInputDefaultSettingsParams) GetRequestName ¶
func (o *GetInputDefaultSettingsParams) GetRequestName() string
Returns the associated request.
func (*GetInputDefaultSettingsParams) WithInputKind ¶
func (o *GetInputDefaultSettingsParams) WithInputKind(x string) *GetInputDefaultSettingsParams
type GetInputDefaultSettingsResponse ¶
type GetInputDefaultSettingsResponse struct {
// Object of default settings for the input kind
DefaultInputSettings map[string]any `json:"defaultInputSettings,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputDefaultSettings request.
type GetInputKindListParams ¶
type GetInputKindListParams struct {
// True == Return all kinds as unversioned, False == Return with version suffixes (if available)
Unversioned *bool `json:"unversioned,omitempty"`
}
Represents the request body for the GetInputKindList request.
func NewGetInputKindListParams ¶
func NewGetInputKindListParams() *GetInputKindListParams
func (*GetInputKindListParams) GetRequestName ¶
func (o *GetInputKindListParams) GetRequestName() string
Returns the associated request.
func (*GetInputKindListParams) WithUnversioned ¶
func (o *GetInputKindListParams) WithUnversioned(x bool) *GetInputKindListParams
type GetInputKindListResponse ¶
type GetInputKindListResponse struct {
// Array of input kinds
InputKinds []string `json:"inputKinds,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputKindList request.
type GetInputListParams ¶
type GetInputListParams struct {
// Restrict the array to only inputs of the specified kind
InputKind *string `json:"inputKind,omitempty"`
}
Represents the request body for the GetInputList request.
func NewGetInputListParams ¶
func NewGetInputListParams() *GetInputListParams
func (*GetInputListParams) GetRequestName ¶
func (o *GetInputListParams) GetRequestName() string
Returns the associated request.
func (*GetInputListParams) WithInputKind ¶
func (o *GetInputListParams) WithInputKind(x string) *GetInputListParams
type GetInputListResponse ¶
type GetInputListResponse struct {
// Array of inputs
Inputs []*typedefs.Input `json:"inputs,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputList request.
type GetInputMuteParams ¶
type GetInputMuteParams struct {
// Name of input to get the mute state of
InputName *string `json:"inputName,omitempty"`
// UUID of input to get the mute state of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputMute request.
func NewGetInputMuteParams ¶
func NewGetInputMuteParams() *GetInputMuteParams
func (*GetInputMuteParams) GetRequestName ¶
func (o *GetInputMuteParams) GetRequestName() string
Returns the associated request.
func (*GetInputMuteParams) WithInputName ¶
func (o *GetInputMuteParams) WithInputName(x string) *GetInputMuteParams
func (*GetInputMuteParams) WithInputUuid ¶
func (o *GetInputMuteParams) WithInputUuid(x string) *GetInputMuteParams
type GetInputMuteResponse ¶
type GetInputMuteResponse struct {
// Whether the input is muted
InputMuted bool `json:"inputMuted,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputMute request.
type GetInputPropertiesListPropertyItemsParams ¶
type GetInputPropertiesListPropertyItemsParams struct {
// Name of the input
InputName *string `json:"inputName,omitempty"`
// UUID of the input
InputUuid *string `json:"inputUuid,omitempty"`
// Name of the list property to get the items of
PropertyName *string `json:"propertyName,omitempty"`
}
Represents the request body for the GetInputPropertiesListPropertyItems request.
func NewGetInputPropertiesListPropertyItemsParams ¶
func NewGetInputPropertiesListPropertyItemsParams() *GetInputPropertiesListPropertyItemsParams
func (*GetInputPropertiesListPropertyItemsParams) GetRequestName ¶
func (o *GetInputPropertiesListPropertyItemsParams) GetRequestName() string
Returns the associated request.
func (*GetInputPropertiesListPropertyItemsParams) WithInputName ¶
func (o *GetInputPropertiesListPropertyItemsParams) WithInputName(x string) *GetInputPropertiesListPropertyItemsParams
func (*GetInputPropertiesListPropertyItemsParams) WithInputUuid ¶
func (o *GetInputPropertiesListPropertyItemsParams) WithInputUuid(x string) *GetInputPropertiesListPropertyItemsParams
func (*GetInputPropertiesListPropertyItemsParams) WithPropertyName ¶
func (o *GetInputPropertiesListPropertyItemsParams) WithPropertyName( x string, ) *GetInputPropertiesListPropertyItemsParams
type GetInputPropertiesListPropertyItemsResponse ¶
type GetInputPropertiesListPropertyItemsResponse struct {
// Array of items in the list property
PropertyItems []*typedefs.PropertyItem `json:"propertyItems,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputPropertiesListPropertyItems request.
type GetInputSettingsParams ¶
type GetInputSettingsParams struct {
// Name of the input to get the settings of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to get the settings of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputSettings request.
func NewGetInputSettingsParams ¶
func NewGetInputSettingsParams() *GetInputSettingsParams
func (*GetInputSettingsParams) GetRequestName ¶
func (o *GetInputSettingsParams) GetRequestName() string
Returns the associated request.
func (*GetInputSettingsParams) WithInputName ¶
func (o *GetInputSettingsParams) WithInputName(x string) *GetInputSettingsParams
func (*GetInputSettingsParams) WithInputUuid ¶
func (o *GetInputSettingsParams) WithInputUuid(x string) *GetInputSettingsParams
type GetInputSettingsResponse ¶
type GetInputSettingsResponse struct {
// The kind of the input
InputKind string `json:"inputKind,omitempty"`
// Object of settings for the input
InputSettings map[string]any `json:"inputSettings,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputSettings request.
type GetInputVolumeParams ¶
type GetInputVolumeParams struct {
// Name of the input to get the volume of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to get the volume of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the GetInputVolume request.
func NewGetInputVolumeParams ¶
func NewGetInputVolumeParams() *GetInputVolumeParams
func (*GetInputVolumeParams) GetRequestName ¶
func (o *GetInputVolumeParams) GetRequestName() string
Returns the associated request.
func (*GetInputVolumeParams) WithInputName ¶
func (o *GetInputVolumeParams) WithInputName(x string) *GetInputVolumeParams
func (*GetInputVolumeParams) WithInputUuid ¶
func (o *GetInputVolumeParams) WithInputUuid(x string) *GetInputVolumeParams
type GetInputVolumeResponse ¶
type GetInputVolumeResponse struct {
// Volume setting in dB
InputVolumeDb float64 `json:"inputVolumeDb,omitempty"`
// Volume setting in mul
InputVolumeMul float64 `json:"inputVolumeMul,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetInputVolume request.
type GetSpecialInputsParams ¶
type GetSpecialInputsParams struct{}
Represents the request body for the GetSpecialInputs request.
func (*GetSpecialInputsParams) GetRequestName ¶
func (o *GetSpecialInputsParams) GetRequestName() string
Returns the associated request.
type GetSpecialInputsResponse ¶
type GetSpecialInputsResponse struct {
// Name of the Desktop Audio input
Desktop1 string `json:"desktop1,omitempty"`
// Name of the Desktop Audio 2 input
Desktop2 string `json:"desktop2,omitempty"`
// Name of the Mic/Auxiliary Audio input
Mic1 string `json:"mic1,omitempty"`
// Name of the Mic/Auxiliary Audio 2 input
Mic2 string `json:"mic2,omitempty"`
// Name of the Mic/Auxiliary Audio 3 input
Mic3 string `json:"mic3,omitempty"`
// Name of the Mic/Auxiliary Audio 4 input
Mic4 string `json:"mic4,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the GetSpecialInputs request.
type PressInputPropertiesButtonParams ¶
type PressInputPropertiesButtonParams struct {
// Name of the input
InputName *string `json:"inputName,omitempty"`
// UUID of the input
InputUuid *string `json:"inputUuid,omitempty"`
// Name of the button property to press
PropertyName *string `json:"propertyName,omitempty"`
}
Represents the request body for the PressInputPropertiesButton request.
func NewPressInputPropertiesButtonParams ¶
func NewPressInputPropertiesButtonParams() *PressInputPropertiesButtonParams
func (*PressInputPropertiesButtonParams) GetRequestName ¶
func (o *PressInputPropertiesButtonParams) GetRequestName() string
Returns the associated request.
func (*PressInputPropertiesButtonParams) WithInputName ¶
func (o *PressInputPropertiesButtonParams) WithInputName(x string) *PressInputPropertiesButtonParams
func (*PressInputPropertiesButtonParams) WithInputUuid ¶
func (o *PressInputPropertiesButtonParams) WithInputUuid(x string) *PressInputPropertiesButtonParams
func (*PressInputPropertiesButtonParams) WithPropertyName ¶
func (o *PressInputPropertiesButtonParams) WithPropertyName(x string) *PressInputPropertiesButtonParams
type PressInputPropertiesButtonResponse ¶
type PressInputPropertiesButtonResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the PressInputPropertiesButton request.
type RemoveInputParams ¶
type RemoveInputParams struct {
// Name of the input to remove
InputName *string `json:"inputName,omitempty"`
// UUID of the input to remove
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the RemoveInput request.
func NewRemoveInputParams ¶
func NewRemoveInputParams() *RemoveInputParams
func (*RemoveInputParams) GetRequestName ¶
func (o *RemoveInputParams) GetRequestName() string
Returns the associated request.
func (*RemoveInputParams) WithInputName ¶
func (o *RemoveInputParams) WithInputName(x string) *RemoveInputParams
func (*RemoveInputParams) WithInputUuid ¶
func (o *RemoveInputParams) WithInputUuid(x string) *RemoveInputParams
type RemoveInputResponse ¶
type RemoveInputResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the RemoveInput request.
type SetInputAudioBalanceParams ¶
type SetInputAudioBalanceParams struct {
// New audio balance value
InputAudioBalance *float64 `json:"inputAudioBalance,omitempty"`
// Name of the input to set the audio balance of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to set the audio balance of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the SetInputAudioBalance request.
func NewSetInputAudioBalanceParams ¶
func NewSetInputAudioBalanceParams() *SetInputAudioBalanceParams
func (*SetInputAudioBalanceParams) GetRequestName ¶
func (o *SetInputAudioBalanceParams) GetRequestName() string
Returns the associated request.
func (*SetInputAudioBalanceParams) WithInputAudioBalance ¶
func (o *SetInputAudioBalanceParams) WithInputAudioBalance(x float64) *SetInputAudioBalanceParams
func (*SetInputAudioBalanceParams) WithInputName ¶
func (o *SetInputAudioBalanceParams) WithInputName(x string) *SetInputAudioBalanceParams
func (*SetInputAudioBalanceParams) WithInputUuid ¶
func (o *SetInputAudioBalanceParams) WithInputUuid(x string) *SetInputAudioBalanceParams
type SetInputAudioBalanceResponse ¶
type SetInputAudioBalanceResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputAudioBalance request.
type SetInputAudioMonitorTypeParams ¶
type SetInputAudioMonitorTypeParams struct {
// Name of the input to set the audio monitor type of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to set the audio monitor type of
InputUuid *string `json:"inputUuid,omitempty"`
// Audio monitor type
MonitorType *string `json:"monitorType,omitempty"`
}
Represents the request body for the SetInputAudioMonitorType request.
func NewSetInputAudioMonitorTypeParams ¶
func NewSetInputAudioMonitorTypeParams() *SetInputAudioMonitorTypeParams
func (*SetInputAudioMonitorTypeParams) GetRequestName ¶
func (o *SetInputAudioMonitorTypeParams) GetRequestName() string
Returns the associated request.
func (*SetInputAudioMonitorTypeParams) WithInputName ¶
func (o *SetInputAudioMonitorTypeParams) WithInputName(x string) *SetInputAudioMonitorTypeParams
func (*SetInputAudioMonitorTypeParams) WithInputUuid ¶
func (o *SetInputAudioMonitorTypeParams) WithInputUuid(x string) *SetInputAudioMonitorTypeParams
func (*SetInputAudioMonitorTypeParams) WithMonitorType ¶
func (o *SetInputAudioMonitorTypeParams) WithMonitorType(x string) *SetInputAudioMonitorTypeParams
type SetInputAudioMonitorTypeResponse ¶
type SetInputAudioMonitorTypeResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputAudioMonitorType request.
type SetInputAudioSyncOffsetParams ¶
type SetInputAudioSyncOffsetParams struct {
// New audio sync offset in milliseconds
InputAudioSyncOffset *float64 `json:"inputAudioSyncOffset,omitempty"`
// Name of the input to set the audio sync offset of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to set the audio sync offset of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the SetInputAudioSyncOffset request.
func NewSetInputAudioSyncOffsetParams ¶
func NewSetInputAudioSyncOffsetParams() *SetInputAudioSyncOffsetParams
func (*SetInputAudioSyncOffsetParams) GetRequestName ¶
func (o *SetInputAudioSyncOffsetParams) GetRequestName() string
Returns the associated request.
func (*SetInputAudioSyncOffsetParams) WithInputAudioSyncOffset ¶
func (o *SetInputAudioSyncOffsetParams) WithInputAudioSyncOffset(x float64) *SetInputAudioSyncOffsetParams
func (*SetInputAudioSyncOffsetParams) WithInputName ¶
func (o *SetInputAudioSyncOffsetParams) WithInputName(x string) *SetInputAudioSyncOffsetParams
func (*SetInputAudioSyncOffsetParams) WithInputUuid ¶
func (o *SetInputAudioSyncOffsetParams) WithInputUuid(x string) *SetInputAudioSyncOffsetParams
type SetInputAudioSyncOffsetResponse ¶
type SetInputAudioSyncOffsetResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputAudioSyncOffset request.
type SetInputAudioTracksParams ¶
type SetInputAudioTracksParams struct {
// Track settings to apply
InputAudioTracks *typedefs.InputAudioTracks `json:"inputAudioTracks,omitempty"`
// Name of the input
InputName *string `json:"inputName,omitempty"`
// UUID of the input
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the SetInputAudioTracks request.
func NewSetInputAudioTracksParams ¶
func NewSetInputAudioTracksParams() *SetInputAudioTracksParams
func (*SetInputAudioTracksParams) GetRequestName ¶
func (o *SetInputAudioTracksParams) GetRequestName() string
Returns the associated request.
func (*SetInputAudioTracksParams) WithInputAudioTracks ¶
func (o *SetInputAudioTracksParams) WithInputAudioTracks(x *typedefs.InputAudioTracks) *SetInputAudioTracksParams
func (*SetInputAudioTracksParams) WithInputName ¶
func (o *SetInputAudioTracksParams) WithInputName(x string) *SetInputAudioTracksParams
func (*SetInputAudioTracksParams) WithInputUuid ¶
func (o *SetInputAudioTracksParams) WithInputUuid(x string) *SetInputAudioTracksParams
type SetInputAudioTracksResponse ¶
type SetInputAudioTracksResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputAudioTracks request.
type SetInputMuteParams ¶
type SetInputMuteParams struct {
// Whether to mute the input or not
InputMuted *bool `json:"inputMuted,omitempty"`
// Name of the input to set the mute state of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to set the mute state of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the SetInputMute request.
func NewSetInputMuteParams ¶
func NewSetInputMuteParams() *SetInputMuteParams
func (*SetInputMuteParams) GetRequestName ¶
func (o *SetInputMuteParams) GetRequestName() string
Returns the associated request.
func (*SetInputMuteParams) WithInputMuted ¶
func (o *SetInputMuteParams) WithInputMuted(x bool) *SetInputMuteParams
func (*SetInputMuteParams) WithInputName ¶
func (o *SetInputMuteParams) WithInputName(x string) *SetInputMuteParams
func (*SetInputMuteParams) WithInputUuid ¶
func (o *SetInputMuteParams) WithInputUuid(x string) *SetInputMuteParams
type SetInputMuteResponse ¶
type SetInputMuteResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputMute request.
type SetInputNameParams ¶
type SetInputNameParams struct {
// Current input name
InputName *string `json:"inputName,omitempty"`
// Current input UUID
InputUuid *string `json:"inputUuid,omitempty"`
// New name for the input
NewInputName *string `json:"newInputName,omitempty"`
}
Represents the request body for the SetInputName request.
func NewSetInputNameParams ¶
func NewSetInputNameParams() *SetInputNameParams
func (*SetInputNameParams) GetRequestName ¶
func (o *SetInputNameParams) GetRequestName() string
Returns the associated request.
func (*SetInputNameParams) WithInputName ¶
func (o *SetInputNameParams) WithInputName(x string) *SetInputNameParams
func (*SetInputNameParams) WithInputUuid ¶
func (o *SetInputNameParams) WithInputUuid(x string) *SetInputNameParams
func (*SetInputNameParams) WithNewInputName ¶
func (o *SetInputNameParams) WithNewInputName(x string) *SetInputNameParams
type SetInputNameResponse ¶
type SetInputNameResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputName request.
type SetInputSettingsParams ¶
type SetInputSettingsParams struct {
// Name of the input to set the settings of
InputName *string `json:"inputName,omitempty"`
// Object of settings to apply
InputSettings map[string]any `json:"inputSettings,omitempty"`
// UUID of the input to set the settings of
InputUuid *string `json:"inputUuid,omitempty"`
// True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply
// settings.
Overlay *bool `json:"overlay,omitempty"`
}
Represents the request body for the SetInputSettings request.
func NewSetInputSettingsParams ¶
func NewSetInputSettingsParams() *SetInputSettingsParams
func (*SetInputSettingsParams) GetRequestName ¶
func (o *SetInputSettingsParams) GetRequestName() string
Returns the associated request.
func (*SetInputSettingsParams) WithInputName ¶
func (o *SetInputSettingsParams) WithInputName(x string) *SetInputSettingsParams
func (*SetInputSettingsParams) WithInputSettings ¶
func (o *SetInputSettingsParams) WithInputSettings(x map[string]any) *SetInputSettingsParams
func (*SetInputSettingsParams) WithInputUuid ¶
func (o *SetInputSettingsParams) WithInputUuid(x string) *SetInputSettingsParams
func (*SetInputSettingsParams) WithOverlay ¶
func (o *SetInputSettingsParams) WithOverlay(x bool) *SetInputSettingsParams
type SetInputSettingsResponse ¶
type SetInputSettingsResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputSettings request.
type SetInputVolumeParams ¶
type SetInputVolumeParams struct {
// Name of the input to set the volume of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to set the volume of
InputUuid *string `json:"inputUuid,omitempty"`
// Volume setting in dB
InputVolumeDb *float64 `json:"inputVolumeDb,omitempty"`
// Volume setting in mul
InputVolumeMul *float64 `json:"inputVolumeMul,omitempty"`
}
Represents the request body for the SetInputVolume request.
func NewSetInputVolumeParams ¶
func NewSetInputVolumeParams() *SetInputVolumeParams
func (*SetInputVolumeParams) GetRequestName ¶
func (o *SetInputVolumeParams) GetRequestName() string
Returns the associated request.
func (*SetInputVolumeParams) WithInputName ¶
func (o *SetInputVolumeParams) WithInputName(x string) *SetInputVolumeParams
func (*SetInputVolumeParams) WithInputUuid ¶
func (o *SetInputVolumeParams) WithInputUuid(x string) *SetInputVolumeParams
func (*SetInputVolumeParams) WithInputVolumeDb ¶
func (o *SetInputVolumeParams) WithInputVolumeDb(x float64) *SetInputVolumeParams
func (*SetInputVolumeParams) WithInputVolumeMul ¶
func (o *SetInputVolumeParams) WithInputVolumeMul(x float64) *SetInputVolumeParams
type SetInputVolumeResponse ¶
type SetInputVolumeResponse struct {
// contains filtered or unexported fields
}
Represents the response body for the SetInputVolume request.
type ToggleInputMuteParams ¶
type ToggleInputMuteParams struct {
// Name of the input to toggle the mute state of
InputName *string `json:"inputName,omitempty"`
// UUID of the input to toggle the mute state of
InputUuid *string `json:"inputUuid,omitempty"`
}
Represents the request body for the ToggleInputMute request.
func NewToggleInputMuteParams ¶
func NewToggleInputMuteParams() *ToggleInputMuteParams
func (*ToggleInputMuteParams) GetRequestName ¶
func (o *ToggleInputMuteParams) GetRequestName() string
Returns the associated request.
func (*ToggleInputMuteParams) WithInputName ¶
func (o *ToggleInputMuteParams) WithInputName(x string) *ToggleInputMuteParams
func (*ToggleInputMuteParams) WithInputUuid ¶
func (o *ToggleInputMuteParams) WithInputUuid(x string) *ToggleInputMuteParams
type ToggleInputMuteResponse ¶
type ToggleInputMuteResponse struct {
// Whether the input has been muted or unmuted
InputMuted bool `json:"inputMuted,omitempty"`
// contains filtered or unexported fields
}
Represents the response body for the ToggleInputMute request.
Source Files
¶
- xx_generated.createinput.go
- xx_generated.getinputaudiobalance.go
- xx_generated.getinputaudiomonitortype.go
- xx_generated.getinputaudiosyncoffset.go
- xx_generated.getinputaudiotracks.go
- xx_generated.getinputdefaultsettings.go
- xx_generated.getinputkindlist.go
- xx_generated.getinputlist.go
- xx_generated.getinputmute.go
- xx_generated.getinputpropertieslistpropertyitems.go
- xx_generated.getinputsettings.go
- xx_generated.getinputvolume.go
- xx_generated.getspecialinputs.go
- xx_generated.pressinputpropertiesbutton.go
- xx_generated.removeinput.go
- xx_generated.setinputaudiobalance.go
- xx_generated.setinputaudiomonitortype.go
- xx_generated.setinputaudiosyncoffset.go
- xx_generated.setinputaudiotracks.go
- xx_generated.setinputmute.go
- xx_generated.setinputname.go
- xx_generated.setinputsettings.go
- xx_generated.setinputvolume.go
- xx_generated.toggleinputmute.go
- zz_generated.client.go