docs(ci): Update generated docs - a90dafb [skip ci]

This commit is contained in:
Github Actions 2021-12-30 05:12:42 +00:00
parent a90dafb971
commit 6291cb1532
2 changed files with 139 additions and 0 deletions

View File

@ -1818,6 +1818,60 @@
],
"responseFields": []
},
{
"description": "Gets the audio balance of an input.",
"requestType": "GetInputAudioBalance",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to get the audio balance of",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": [
{
"valueName": "inputAudioBalance",
"valueType": "Number",
"valueDescription": "Audio balance value from 0.0-1.0"
}
]
},
{
"description": "Sets the audio balance of an input.",
"requestType": "SetInputAudioBalance",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"requestFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the input to set the audio balance of",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "inputAudioBalance",
"valueType": "Number",
"valueDescription": "New audio balance value",
"valueRestrictions": ">= 0.0, <= 1.0",
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets the audio sync offset of an input.\n\nNote: The audio sync offset can be negative too!",
"requestType": "GetInputAudioSyncOffset",
@ -3662,6 +3716,28 @@
}
]
},
{
"description": "The audio balance value of an input has changed.",
"eventType": "InputAudioBalanceChanged",
"eventSubscription": "Inputs",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "inputs",
"dataFields": [
{
"valueName": "inputName",
"valueType": "String",
"valueDescription": "Name of the affected input"
},
{
"valueName": "inputAudioBalance",
"valueType": "Number",
"valueDescription": "New audio balance value of the input"
}
]
},
{
"description": "The sync offset of an input has changed.",
"eventType": "InputAudioSyncOffsetChanged",

View File

@ -1263,6 +1263,7 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event.
- [InputShowStateChanged](#inputshowstatechanged)
- [InputMuteStateChanged](#inputmutestatechanged)
- [InputVolumeChanged](#inputvolumechanged)
- [InputAudioBalanceChanged](#inputaudiobalancechanged)
- [InputAudioSyncOffsetChanged](#inputaudiosyncoffsetchanged)
- [InputAudioTracksChanged](#inputaudiotrackschanged)
- [InputAudioMonitorTypeChanged](#inputaudiomonitortypechanged)
@ -1666,6 +1667,24 @@ An input's volume level has changed.
---
### InputAudioBalanceChanged
The audio balance value of an input has changed.
- Complexity Rating: `2/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Data Fields:**
| Name | Type | Description |
| ---- | :---: | ----------- |
| inputName | String | Name of the affected input |
| inputAudioBalance | Number | New audio balance value of the input |
---
### InputAudioSyncOffsetChanged
The sync offset of an input has changed.
@ -2066,6 +2085,8 @@ Studio mode has been enabled or disabled.
- [ToggleInputMute](#toggleinputmute)
- [GetInputVolume](#getinputvolume)
- [SetInputVolume](#setinputvolume)
- [GetInputAudioBalance](#getinputaudiobalance)
- [SetInputAudioBalance](#setinputaudiobalance)
- [GetInputAudioSyncOffset](#getinputaudiosyncoffset)
- [SetInputAudioSyncOffset](#setinputaudiosyncoffset)
- [GetInputAudioMonitorType](#getinputaudiomonitortype)
@ -3128,6 +3149,48 @@ Sets the volume setting of an input.
---
### GetInputAudioBalance
Gets the audio balance of an input.
- Complexity Rating: `2/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Request Fields:**
| Name | Type | Description | Value Restrictions | ?Default Behavior |
| ---- | :---: | ----------- | :----------------: | ----------------- |
| inputName | String | Name of the input to get the audio balance of | None | N/A |
**Response Fields:**
| Name | Type | Description |
| ---- | :---: | ----------- |
| inputAudioBalance | Number | Audio balance value from 0.0-1.0 |
---
### SetInputAudioBalance
Sets the audio balance of an input.
- Complexity Rating: `2/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Request Fields:**
| Name | Type | Description | Value Restrictions | ?Default Behavior |
| ---- | :---: | ----------- | :----------------: | ----------------- |
| inputName | String | Name of the input to set the audio balance of | None | N/A |
| inputAudioBalance | Number | New audio balance value | >= 0.0, <= 1.0 | N/A |
---
### GetInputAudioSyncOffset
Gets the audio sync offset of an input.