Use the getVolume
command in the playerVolume
namespace to get the volume and mute state of a player.
Endpoint
GET
1 |
/players/{playerId}/playerVolume |
Request Parameters
This command requires a playerId
to determine the target of the command. See the Control documentation for details.
Response
Returns a playerVolume
object type with the current volume, mute state, and fixed status of the targeted player. See playerVolume
for more details.
In the event of a failure, returns a globalError
.
Example
Response
1 2 3 4 5 |
{ "volume": 85, "muted": false, "fixed": false } |