Update Source | Machani Robotics SDK

Updates info regarding a Sound source. This can be used to set a Sound source as default, or change its volume.

sourcestringRequired

The source id.

updateMaskstringOptionalformat: "field-mask"

The fields to update.

This endpoint expects an object.

volumeintegerRequired

Volume of the source, in percentage

isDefaultbooleanRequired

Whether this source is the default or not

namestringOptional

Resource name of an Sound source. Format: //system.v1.engine.core.machanirobotics.com/Sources/{source}

The {Sound_source} in the resource name is the id of the source.

volumeinteger

Volume of the source, in percentage

isDefaultboolean

Whether this source is the default or not

namestring

Resource name of an Sound source. Format: //system.v1.engine.core.machanirobotics.com/Sources/{source}

The {Sound_source} in the resource name is the id of the source.

displayNamestringRead-only

Display name of the source

stateintegerRead-only

The state of the source

deviceClassintegerRead-only

The class of the device the source belongs to

mutedbooleanRead-only

Whether the source is muted or not

400

Bad Request Error

1	curl -X PATCH https://api.machanirobotics.com/v1/management/sound/sources/source \
2	-H "Content-Type: application/json" \
3	-d '{
4	"volume": 75,
5	"isDefault": true
6	}'

1	{
2	"volume": 75,
3	"isDefault": true,
4	"name": "//system.v1.engine.core.machanirobotics.com/Sources/speaker123",
5	"displayName": "Main Speaker",
6	"state": 2,
7	"deviceClass": 3,
8	"muted": false
9	}