Update Sink | Machani Robotics SDK

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

sinkstringRequired

The sink id.

updateMaskstringOptionalformat: "field-mask"

The fields to update.

This endpoint expects an object.

volumeintegerRequired

Volume of the sink, in percentage

isDefaultbooleanRequired

Whether this sink is the default or not

namestringOptional

Resource name of an Sound sink. Format: //system.v1.engine.core.machanirobotics.com/Sinks/{Sink}

The {Sound_sink} in the resource name is the id of the sink.

volumeinteger

Volume of the sink, in percentage

isDefaultboolean

Whether this sink is the default or not

namestring

Resource name of an Sound sink. Format: //system.v1.engine.core.machanirobotics.com/Sinks/{Sink}

The {Sound_sink} in the resource name is the id of the sink.

displayNamestringRead-only

Display name of the sink

stateintegerRead-only

The state of the sink

deviceClassintegerRead-only

The class of the device the sink belongs to

mutedbooleanRead-only

Whether the sink is muted or not

400

Bad Request Error

1	curl -X PATCH https://api.machanirobotics.com/v1/management/sound/sinks/sink \
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/Sinks/sink123",
5	"displayName": "Office Speaker",
6	"state": 2,
7	"deviceClass": 3,
8	"muted": false
9	}