Skip to navigation
latest2026.01.16 DevSound Service

Get Sink

Gets a Sound sink

Path parameters

sinkstringRequired
The sink id.

Response

OK
volumeinteger
Volume of the sink, in percentage
isDefaultboolean
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.

displayNamestringOptionalRead-only
Display name of the sink
stateintegerOptionalRead-only
The state of the sink
deviceClassintegerOptionalRead-only
The class of the device the sink belongs to
mutedbooleanOptionalRead-only
Whether the sink is muted or not

Errors

400
Bad Request Error