Scenes class

Scenes Requests

Constructors

Scenes(ObsWebSocket obsWebSocket)

Properties

hashCode → int
The hash code for this object.
no setterinherited
obsWebSocket → ObsWebSocket
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

create(String sceneName, {String? canvasUuid}) → Future<void>
Creates a new scene in OBS.
createScene(String sceneName, {String? canvasUuid}) → Future<void>
Creates a new scene in OBS.
getCurrentPreview() → Future<String>
Gets the current preview scene.
getCurrentPreviewScene() → Future<String>
Gets the current preview scene.
getCurrentProgram() → Future<String>
Gets the current program scene.
getCurrentProgramScene() → Future<String>
Gets the current program scene.
getGroupList() → Future<List<String>>
Gets an array of all groups in OBS.
getList({String? canvasUuid}) → Future<SceneListResponse>
Gets an array of all scenes in OBS.
getSceneList({String? canvasUuid}) → Future<SceneListResponse>
Gets an array of all scenes in OBS.
getSceneSceneTransitionOverride(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<SceneSceneTransitionOverrideResponse>
Gets the scene transition overridden for a scene.
groupList() → Future<List<String>>
Gets an array of all groups in OBS.
list({String? canvasUuid}) → Future<SceneListResponse>
Gets an array of all scenes in OBS.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
remove(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<void>
Removes a scene from OBS.
removeScene(String? sceneName, {String? sceneUuid, String? canvasUuid}) → Future<void>
Removes a scene from OBS.
set(String? sceneName, {required String newSceneName, String? sceneUuid, String? canvasUuid}) → Future<void>
Sets the name of a scene (rename).
setCurrentPreview(String? sceneName, {String? sceneUuid}) → Future<void>
Sets the current preview scene.
setCurrentPreviewScene(String? sceneName, {String? sceneUuid}) → Future<void>
Sets the current preview scene.
setCurrentProgram(String? sceneName, {String? sceneUuid}) → Future<void>
Sets the current program scene.
setCurrentProgramScene(String? sceneName, {String? sceneUuid}) → Future<void>
Sets the current program scene.
setSceneName(String? sceneName, {required String newSceneName, String? sceneUuid, String? canvasUuid}) → Future<void>
Sets the name of a scene (rename).
setSceneSceneTransitionOverride(String? sceneName, {String? sceneUuid, String? canvasUuid, String? transitionName, int? transitionDuration}) → Future<void>
Sets the scene transition overridden for a scene.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited