Sign in

v1

latestOpenAPI 3.1.02026-07-246652306.5 KB
playerVolume

setRelativeVolume

Use the setRelativeVolume command to increase or decrease volume and set the player's mute state.

Returns an empty body with a success value of true if successful. The player generates a playerVolume event if the volume was changed.

post/players/{playerId}/playerVolume/relative

Request body

volumeDeltainteger nullable

(Optional) Between -100 and 100 to indicate the amount to increase or decrease the volume for the player. If your app submits a number outside of this range, you will receive an ERROR_INVALID_PARAMETER error. The player adds this value to the current volume and keeps the result in the range of 0 to 100.

mutedboolean nullable

(Optional) True to mute the player or false to unmute the player. If not specified, the existing mute state is maintained.

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).