Skip to content

Feature/scene item transitions #1322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Feature/scene item transitions #1322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
538dfa8
feat: Add per-scene-item transition support
aab18011 Nov 4, 2025
29c7a4e
Update RequestHandler_SceneItems.cpp
LinuxMainframe Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/requesthandler/RequestHandler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,12 @@ const std::unordered_map<std::string, RequestMethodHandler> RequestHandler::_han
{"GetSceneItemPrivateSettings", &RequestHandler::GetSceneItemPrivateSettings},
{"SetSceneItemPrivateSettings", &RequestHandler::SetSceneItemPrivateSettings},

// Scene Item Transitions
{"GetSceneItemShowTransition", &RequestHandler::GetSceneItemShowTransition},
{"SetSceneItemShowTransition", &RequestHandler::SetSceneItemShowTransition},
{"GetSceneItemHideTransition", &RequestHandler::GetSceneItemHideTransition},
{"SetSceneItemHideTransition", &RequestHandler::SetSceneItemHideTransition},

// Outputs
{"GetVirtualCamStatus", &RequestHandler::GetVirtualCamStatus},
{"ToggleVirtualCam", &RequestHandler::ToggleVirtualCam},
Expand Down
6 changes: 6 additions & 0 deletions src/requesthandler/RequestHandler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ class RequestHandler {
RequestResult GetSceneItemPrivateSettings(const Request &);
RequestResult SetSceneItemPrivateSettings(const Request &);

// Scene Item Transitions
RequestResult GetSceneItemShowTransition(const Request &);
RequestResult SetSceneItemShowTransition(const Request &);
RequestResult GetSceneItemHideTransition(const Request &);
RequestResult SetSceneItemHideTransition(const Request &);

// Outputs
RequestResult GetVirtualCamStatus(const Request &);
RequestResult ToggleVirtualCam(const Request &);
Expand Down
214 changes: 213 additions & 1 deletion src/requesthandler/RequestHandler_SceneItems.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program. If not, see <https://www.gnu.org/licenses/>
*/

#include <optional>
#include "RequestHandler.h"

/**
Expand Down Expand Up @@ -839,3 +839,215 @@ RequestResult RequestHandler::SetSceneItemPrivateSettings(const Request &request

return RequestResult::Success();
}

/**
* Gets the show transition for a scene item.
*
* Scenes and Groups
*
* @requestField ?sceneName | String | Name of the scene the item is in
* @requestField ?sceneUuid | String | UUID of the scene the item is in
* @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
*
* @responseField transitionName | String | Name of the transition or null if none set
* @responseField transitionUuid | String | UUID of the transition or null if none set
* @responseField transitionKind | String | Kind of the transition or null if none set
* @responseField transitionDuration | Number | Duration of the transition in milliseconds or null if none set
*
* @requestType GetSceneItemShowTransition
* @complexity 2
* @rpcVersion -1
* @initialVersion 5.7.0
* @api requests
* @category scene items
*/
RequestResult RequestHandler::GetSceneItemShowTransition(const Request &request)
{
RequestStatus::RequestStatus statusCode;
std::string comment;
OBSSceneItemAutoRelease sceneItem =
request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
if (!sceneItem)
return RequestResult::Error(statusCode, comment);

json responseData;

OBSSourceAutoRelease transition = obs_sceneitem_get_transition(sceneItem, true);
if (transition) {
responseData["transitionName"] = obs_source_get_name(transition);
responseData["transitionUuid"] = obs_source_get_uuid(transition);
responseData["transitionKind"] = obs_source_get_id(transition);
responseData["transitionDuration"] = obs_sceneitem_get_transition_duration(sceneItem, true);
} else {
responseData["transitionName"] = nullptr;
responseData["transitionUuid"] = nullptr;
responseData["transitionKind"] = nullptr;
responseData["transitionDuration"] = nullptr;
}

return RequestResult::Success(responseData);
}

/**
* Sets the show transition for a scene item.
*
* Scenes and Groups
*
* @requestField ?sceneName | String | Name of the scene the item is in
* @requestField ?sceneUuid | String | UUID of the scene the item is in
* @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
* @requestField ?transitionName | String | Name of the transition to set. Pass null to remove transition | null
* @requestField ?transitionDuration | Number | Duration of the transition in milliseconds | >= 0
*
* @requestType SetSceneItemShowTransition
* @complexity 3
* @rpcVersion -1
* @initialVersion 5.7.0
* @api requests
* @category scene items
*/
RequestResult RequestHandler::SetSceneItemShowTransition(const Request &request)
{
RequestStatus::RequestStatus statusCode;
std::string comment;
OBSSceneItemAutoRelease sceneItem =
request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
if (!sceneItem)
return RequestResult::Error(statusCode, comment);

// Get transition name if provided
std::optional<std::string> transitionName;
if (request.RequestData.contains("transitionName") && !request.RequestData["transitionName"].is_null()) {
if (!request.ValidateString("transitionName", statusCode, comment))
return RequestResult::Error(statusCode, comment);
transitionName = request.RequestData["transitionName"];
}

// Set transition if provided
if (transitionName) {
OBSSourceAutoRelease transition = Utils::Obs::SearchHelper::GetSceneTransitionByName(transitionName.value());
if (!transition)
return RequestResult::Error(RequestStatus::ResourceNotFound,
"No transition was found with the name '" + transitionName.value() + "'.");
obs_sceneitem_set_transition(sceneItem, true, transition);
} else if (request.RequestData.contains("transitionName") && request.RequestData["transitionName"].is_null()) {
// Remove transition if explicitly set to null
obs_sceneitem_set_transition(sceneItem, true, nullptr);
}

// Set duration if provided
if (request.RequestData.contains("transitionDuration")) {
if (!request.ValidateNumber("transitionDuration", statusCode, comment, 0))
return RequestResult::Error(statusCode, comment);
uint32_t duration = request.RequestData["transitionDuration"];
obs_sceneitem_set_transition_duration(sceneItem, true, duration);
}

return RequestResult::Success();
}

/**
* Gets the hide transition for a scene item.
*
* Scenes and Groups
*
* @requestField ?sceneName | String | Name of the scene the item is in
* @requestField ?sceneUuid | String | UUID of the scene the item is in
* @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
*
* @responseField transitionName | String | Name of the transition or null if none set
* @responseField transitionUuid | String | UUID of the transition or null if none set
* @responseField transitionKind | String | Kind of the transition or null if none set
* @responseField transitionDuration | Number | Duration of the transition in milliseconds or null if none set
*
* @requestType GetSceneItemHideTransition
* @complexity 2
* @rpcVersion -1
* @initialVersion 5.7.0
* @api requests
* @category scene items
*/
RequestResult RequestHandler::GetSceneItemHideTransition(const Request &request)
{
RequestStatus::RequestStatus statusCode;
std::string comment;
OBSSceneItemAutoRelease sceneItem =
request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
if (!sceneItem)
return RequestResult::Error(statusCode, comment);

json responseData;

OBSSourceAutoRelease transition = obs_sceneitem_get_transition(sceneItem, false);
if (transition) {
responseData["transitionName"] = obs_source_get_name(transition);
responseData["transitionUuid"] = obs_source_get_uuid(transition);
responseData["transitionKind"] = obs_source_get_id(transition);
responseData["transitionDuration"] = obs_sceneitem_get_transition_duration(sceneItem, false);
} else {
responseData["transitionName"] = nullptr;
responseData["transitionUuid"] = nullptr;
responseData["transitionKind"] = nullptr;
responseData["transitionDuration"] = nullptr;
}

return RequestResult::Success(responseData);
}

/**
* Sets the hide transition for a scene item.
*
* Scenes and Groups
*
* @requestField ?sceneName | String | Name of the scene the item is in
* @requestField ?sceneUuid | String | UUID of the scene the item is in
* @requestField sceneItemId | Number | Numeric ID of the scene item | >= 0
* @requestField ?transitionName | String | Name of the transition to set. Pass null to remove transition | null
* @requestField ?transitionDuration | Number | Duration of the transition in milliseconds | >= 0
*
* @requestType SetSceneItemHideTransition
* @complexity 3
* @rpcVersion -1
* @initialVersion 5.7.0
* @api requests
* @category scene items
*/
RequestResult RequestHandler::SetSceneItemHideTransition(const Request &request)
{
RequestStatus::RequestStatus statusCode;
std::string comment;
OBSSceneItemAutoRelease sceneItem =
request.ValidateSceneItem(statusCode, comment, OBS_WEBSOCKET_SCENE_FILTER_SCENE_OR_GROUP);
if (!sceneItem)
return RequestResult::Error(statusCode, comment);

// Get transition name if provided
std::optional<std::string> transitionName;
if (request.RequestData.contains("transitionName") && !request.RequestData["transitionName"].is_null()) {
if (!request.ValidateString("transitionName", statusCode, comment))
return RequestResult::Error(statusCode, comment);
transitionName = request.RequestData["transitionName"];
}

// Set transition if provided
if (transitionName) {
OBSSourceAutoRelease transition = Utils::Obs::SearchHelper::GetSceneTransitionByName(transitionName.value());
if (!transition)
return RequestResult::Error(RequestStatus::ResourceNotFound,
"No transition was found with the name '" + transitionName.value() + "'.");
obs_sceneitem_set_transition(sceneItem, false, transition);
} else if (request.RequestData.contains("transitionName") && request.RequestData["transitionName"].is_null()) {
// Remove transition if explicitly set to null
obs_sceneitem_set_transition(sceneItem, false, nullptr);
}

// Set duration if provided
if (request.RequestData.contains("transitionDuration")) {
if (!request.ValidateNumber("transitionDuration", statusCode, comment, 0))
return RequestResult::Error(statusCode, comment);
uint32_t duration = request.RequestData["transitionDuration"];
obs_sceneitem_set_transition_duration(sceneItem, false, duration);
}

return RequestResult::Success();
}