SceneItems class

Record Requests

Constructors

SceneItems(ObsWebSocket obsWebSocket)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

obsWebSocket → ObsWebSocket

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createSceneItem({String? sceneName, String? sceneUuid, String? canvasUuid, String? sourceName, String? sourceUuid, bool? sceneItemEnabled}) → Future<int>

Creates a new scene item using a source.

duplicateSceneItem({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, String? destinationSceneName, String? destinationSceneUuid}) → Future<int>

Duplicates a scene item, copying all transform and crop info.

getEnabled({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<bool>

Gets the enable state of a scene item.

getGroupSceneItemList(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<List<SceneItemDetail>>

Basically GetSceneItemList, but for groups.

getId({String? sceneName, String? sceneUuid, String? canvasUuid, required String sourceName, int? searchOffset}) → Future<int>

Searches a scene for a source, and returns its id.

getIndex({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<int>

Gets the index position of a scene item in a scene.

getLocked({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<bool>

Gets the lock state of a scene item.

getSceneItemBlendMode({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<String>

Gets the blend mode of a scene item.

getSceneItemEnabled({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<bool>

Gets the enable state of a scene item.

getSceneItemId({String? sceneName, String? sceneUuid, String? canvasUuid, required String sourceName, int? searchOffset}) → Future<int>

Searches a scene for a source, and returns its id.

getSceneItemIndex({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<int>

Gets the index position of a scene item in a scene.

getSceneItemList(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<List<SceneItemDetail>>

Gets a list of all scene items in a scene.

getSceneItemLocked({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<bool>

Gets the lock state of a scene item.

getSceneItemPrivateSettings({String? sceneName, String? sceneUuid, required int sceneItemId}) → Future<Map<String, dynamic>>

Gets the private settings of a scene item.

getSceneItemSource({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<Map<String, dynamic>>

Gets the source associated with a scene item.

getSceneItemTransform({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<Map<String, dynamic>>

Gets the transform (position, scale, rotation, crop) of a scene item.

getSceneItemTransformTyped({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<SceneItemTransform>

Strongly-typed companion to getSceneItemTransform. Returns the transform parsed into a SceneItemTransform.

groupList(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<List<SceneItemDetail>>

Basically GetSceneItemList, but for groups.

list(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<List<SceneItemDetail>>

Gets a list of all scene items in a scene.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeSceneItem({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId}) → Future<void>

Removes a scene item from a scene.

setEnabled(SceneItemEnableStateChanged sceneItemEnableStateChanged, {String? sceneUuid, String? canvasUuid}) → Future<void>

Sets the enable state of a scene item.

setIndex({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required int sceneItemIndex}) → Future<void>

Sets the index position of a scene item in a scene.

setLocked({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required bool sceneItemLocked}) → Future<void>

Sets the lock state of a scene item.

setSceneItemBlendMode({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required String sceneItemBlendMode}) → Future<void>

Sets the blend mode of a scene item.

setSceneItemEnabled(SceneItemEnableStateChanged sceneItemEnableStateChanged, {String? sceneUuid, String? canvasUuid}) → Future<void>

Sets the enable state of a scene item.

setSceneItemIndex({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required int sceneItemIndex}) → Future<void>

Sets the index position of a scene item in a scene.

setSceneItemLocked({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required bool sceneItemLocked}) → Future<void>

Sets the lock state of a scene item.

setSceneItemPrivateSettings({String? sceneName, String? sceneUuid, required int sceneItemId, required Map<String, dynamic> sceneItemSettings}) → Future<void>

Sets the private settings of a scene item.

setSceneItemTransform({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required Map<String, dynamic> sceneItemTransform, bool validateKeys = true}) → Future<void>

Sets the transform (position, scale, rotation, crop) of a scene item.

setSceneItemTransformTyped({String? sceneName, String? sceneUuid, String? canvasUuid, required int sceneItemId, required SceneItemTransform transform}) → Future<void>

Strongly-typed companion to setSceneItemTransform. Only the non-null fields of transform are forwarded to OBS.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited