EntertainmentConfiguration

API to manage entertainment configuration.

List entertainment configuration.

get

List all available entertainment configuration resources.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

EntertainmentConfiguration Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/entertainment_configuration

HTTPcURLJavaScriptPython

GET /clip/v2/resource/entertainment_configuration HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "metadata": {
        "name": "text"
      },
      "configuration_type": "screen",
      "status": "active",
      "stream_proxy": {
        "mode": "auto",
        "node": {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      },
      "channels": [
        {
          "channel_id": 1,
          "position": {
            "x": 1,
            "y": 1,
            "z": 1
          },
          "members": [
            {
              "service": {
                "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
                "rtype": "device"
              },
              "index": 1
            }
          ]
        }
      ],
      "locations": {
        "service_locations": [
          {
            "service": {
              "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
              "rtype": "device"
            },
            "positions": [
              {
                "x": 1,
                "y": 1,
                "z": 1
              }
            ]
          }
        ]
      },
      "light_services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Get entertainment configuration.

get

Get details of a single entertainment configuration resource from its given {entertainmentConfigurationId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

entertainmentConfigurationIdstringRequired

ID of the entertainment configuration

Responses

200

EntertainmentConfiguration Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get/clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "metadata": {
        "name": "text"
      },
      "configuration_type": "screen",
      "status": "active",
      "stream_proxy": {
        "mode": "auto",
        "node": {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      },
      "channels": [
        {
          "channel_id": 1,
          "position": {
            "x": 1,
            "y": 1,
            "z": 1
          },
          "members": [
            {
              "service": {
                "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
                "rtype": "device"
              },
              "index": 1
            }
          ]
        }
      ],
      "locations": {
        "service_locations": [
          {
            "service": {
              "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
              "rtype": "device"
            },
            "positions": [
              {
                "x": 1,
                "y": 1,
                "z": 1
              }
            ]
          }
        ]
      },
      "light_services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ]
    }
  ]
}

Update entertainment configuration.

put

Update a single entertainment configuration resource from its given {entertainmentConfigurationId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

entertainmentConfigurationIdstringRequired

ID of the entertainment configuration

Body

application/json

typestringOptional

Type of the supported resources (always entertainment_configuration here)

configuration_typestring · enumOptionalPossible values:

actionstring · enumOptional

Start or stop streaming.

Possible values:

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put/clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/entertainment_configuration/{entertainmentConfigurationId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "type": "text",
  "metadata": {
    "name": "text"
  },
  "configuration_type": "screen",
  "action": "start"
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}