Skip to navigation

Get Source

Gets a Sound source

Path parameters

sourcestringRequired
The source id.

Response

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

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

Errors

400
Bad Request Error