Skip to main content

GET Color Defaults

Overview


The following table contains important information about the GET method in regards to receiving the color defaults of the player.

GET Color Defaults
MethodGET
URL or Endpoint​/api/projects/projectId/players/options/color-defaults
HeadersAuthorization
ParametersprojectId, filter
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

The description of the parameter is as follows:

filter Parameter
URL Parameter Namefilter
MandatoryNo
Typestring
DescriptionIndicates the field you want to know the color of.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"controlbartextcolor": "ffffff",
"controlbariconsdefaultcolor": "ffffff",
"controlbariconshovercolor": "ffffff",
"controlbartimesliderprogresscolor": "cc0000",
"controlbartimesliderrailcolor": "808080",
"controlbartimesliderdraggercolor": "cc0000",
"controlbartimesliderbuffercolor": "e2e2e2",
"controlbarvolumedraggercolor": "ffffff",
"controlbarvolumeprogresscolor": "ffffff",
"controlbarvolumerailcolor": "9f9f9f",
"controlbarvolumenotifiercolor": "ffffff",
"menulinksdefaultcolor": "ffffff",
"menulinkshovercolor": "cc0000",
"menubackrounddefaultcolor": "000000",
"menubackroundhovercolor": "000000",
"menuautoplayoncolor": "cc0000",
"menuautoplayoffcolor": "a7a7a7",
"controlbarbackgroundcolor": "ffffff00",
"tooltipstextcolor": "ffffff00",
"tooltipsbackroundcolor": "ffffff00",
"controlbartimeslideronaddraggercolor": "ffffff",
"controlbartimeslideronadprogresscolor": "f5c338",
"controlbartimeslideronadrailcolor": "808080"
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
controlbartextcolorstringIndicates the color of the control bar.
controlbariconsdefaultcolorstringIndicates the color of the control bar icon.
controlbariconshovercolorstringIndicates the color of the control bar when hovering.
controlbartimesliderprogresscolorstringIndicates the color of the control bar slider.
controlbartimesliderrailcolorstringIndicates the color of the control bar timeslider.
controlbartimesliderdraggercolorstringIndicates the color of the dragger of the control bar timeslider.
controlbartimesliderbuffercolorstringIndicates the color of the buffer of the control bar timeslider.
controlbarvolumedraggercolorstringIndicates the color of the control bar volume dragger.
controlbarvolumeprogresscolorstringIndicates the color of the control bar volume progress.
controlbarvolumerailcolorstringIndicates the color of the control bar volume rail.
controlbarvolumenotifiercolorstringIndicates the color of the control bar volume notifier.
menulinksdefaultcolorstringIndicates the color of the links menu.
menulinkshovercolorstringIndicates the color of the links menu when hovering.
menubackrounddefaultcolorstringIndicates the color of the menu background.
menubackroundhovercolorstringIndicates the color of the menu background when hovering.
menuautoplayoncolorstringIndicates the color of the menu auto-play when on.
menuautoplayoffcolorstringIndicates the color of the menu auto-play when off.
controlbarbackgroundcolorstringIndicates the color of the control bar background.
tooltipstextcolorstringIndicates the color of the tooltips text.
tooltipsbackroundcolorstringIndicates the color of the tooltips background.
controlbartimeslideronaddraggercolorstringIndicates the color of the dragger of the control bar timeslider.
controlbartimeslideronadprogresscolorstringIndicates the color of the ad progress of the control bar timeslider.
controlbartimeslideronadrailcolorstringIndicates the color of the ad rail of the control bar timeslider.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed