For the complete documentation index, see llms.txt. This page is also available as Markdown.

Entertainment

API to manage entertainment services.

List entertainment.

get

List all available entertainment resources.

Authorizations
hue-application-keystringRequired
Responses
200

Entertainment Success Response

application/json
get/clip/v2/resource/entertainment
GET /clip/v2/resource/entertainment 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",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "renderer": true,
      "proxy": true,
      "max_streams": 1,
      "segments": {
        "configurable": true,
        "max_segments": 1,
        "segments": [
          {
            "start": 1,
            "length": 1
          }
        ]
      }
    }
  ]
}

Get entertainment.

get

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

Authorizations
hue-application-keystringRequired
Path parameters
entertainmentIdstringRequired

ID of the entertainment

Responses
200

Entertainment Success Response

application/json
get/clip/v2/resource/entertainment/{entertainmentId}
GET /clip/v2/resource/entertainment/{entertainmentId} 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",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "renderer": true,
      "proxy": true,
      "max_streams": 1,
      "segments": {
        "configurable": true,
        "max_segments": 1,
        "segments": [
          {
            "start": 1,
            "length": 1
          }
        ]
      }
    }
  ]
}

Update entertainment.

put

Update a single entertainment resource from its given {entertainmentId}.

Authorizations
hue-application-keystringRequired
Path parameters
entertainmentIdstringRequired

ID of the entertainment

Body
typestringOptional

Type of the supported resources (always entertainment here)

Responses
200

Success

application/json
put/clip/v2/resource/entertainment/{entertainmentId}
PUT /clip/v2/resource/entertainment/{entertainmentId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

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

Last updated

Was this helpful?