SceneService
A list of all methods in the SceneService
service. Click on the method name to view detailed information about that method.
Methods | Description |
---|---|
GetScenesAsync | List all available scenes |
CreateSceneAsync | Creates a new scene |
GetSceneAsync | Get details of a single scene from its given {sceneId} |
UpdateSceneAsync | Update a single scene from its given {sceneId} |
DeleteSceneAsync | Delete a single scene from its given {sceneId} |
GetScenesAsync
List all available scenes
- HTTP Method:
GET
- Endpoint:
/clip/v2/resource/scene
Return Type
GetScenesOkResponse
Example Usage Code Snippet
using OpenHue;
var client = new OpenHueClient();
var response = await client.Scene.GetScenesAsync();
Console.WriteLine(response);
CreateSceneAsync
Creates a new scene
- HTTP Method:
POST
- Endpoint:
/clip/v2/resource/scene
Parameters
Name | Type | Required | Description |
---|---|---|---|
input | ScenePost | ❌ | The request body. |
Return Type
CreateSceneOkResponse
Example Usage Code Snippet
using OpenHue;
using OpenHue.Models;
var client = new OpenHueClient();
var target = new ResourceIdentifier();
var action = new ActionPost.ActionPostAction();
var actionsItem = new ActionPost(target, action);
var actions = new List<ActionPost>() { actionsItem };
var metadata = new SceneMetadata();
var group = new ResourceIdentifier();
var input = new ScenePost(actions, metadata, group);
var response = await client.Scene.CreateSceneAsync(input);
Console.WriteLine(response);
GetSceneAsync
Get details of a single scene from its given {sceneId}
- HTTP Method:
GET
- Endpoint:
/clip/v2/resource/scene/{sceneId}
Parameters
Name | Type | Required | Description |
---|---|---|---|
sceneId | string | ✅ | ID of the scene. |
Return Type
GetSceneOkResponse
Example Usage Code Snippet
using OpenHue;
var client = new OpenHueClient();
var response = await client.Scene.GetSceneAsync("sceneId");
Console.WriteLine(response);
UpdateSceneAsync
Update a single scene from its given {sceneId}
- HTTP Method:
PUT
- Endpoint:
/clip/v2/resource/scene/{sceneId}
Parameters
Name | Type | Required | Description |
---|---|---|---|
input | ScenePut | ❌ | The request body. |
sceneId | string | ✅ | ID of the scene. |
Return Type
UpdateSceneOkResponse
Example Usage Code Snippet
using OpenHue;
using OpenHue.Models;
var client = new OpenHueClient();
var input = new ScenePut();
var response = await client.Scene.UpdateSceneAsync(input, "sceneId");
Console.WriteLine(response);
DeleteSceneAsync
Delete a single scene from its given {sceneId}
- HTTP Method:
DELETE
- Endpoint:
/clip/v2/resource/scene/{sceneId}
Parameters
Name | Type | Required | Description |
---|---|---|---|
sceneId | string | ✅ | ID of the scene. |
Return Type
DeleteSceneOkResponse
Example Usage Code Snippet
using OpenHue;
var client = new OpenHueClient();
var response = await client.Scene.DeleteSceneAsync("sceneId");
Console.WriteLine(response);
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs