Jump to Screening Room

Screening Room Integration

Screening Room integration right inside your application.


By: Shotgun Software
Latest Version: v0.3.2 (beta)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-multi-screeningroom

Overview

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for details. This app launches Screening Room for the current context. Jumping into your review session has never been easier! Just click a button and Screening Room will open, focused on the particular shot or asset you are currently working on. This also makes it really easy to see your submitted versions in context or review different variations that you submitted from inside your content creation application.

Documentation

This is a small app that hooks up your current Maya session with Screening Room. It will add an item to the Shotgun menu saying Jump to Screening Room. Clicking this button will launch Screening Room and point it at the current Shotgun Toolkit Context - for example a Shot, Asset or a Task. You can then use Screening Room to browse all submitted content.

Haven't heard about Screening Room? Screening Room is Shotgun's feature for review and playback. For more information, go here: support.shotgunsoftware.com/entries/21684812

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to Project XYZ, in an environment named asset, execute the following command:

> tank Project XYZ install_app asset tk-maya tk-multi-screeningroom

Updating to the latest version

If you already have this item installed in a project and you want to get the latest version, you can run the update command. You can either navigate to the tank command that comes with that specific project, and run it there:

> cd /my_tank_configs/project_xyz
> ./tank updates

Alternatively, you can run your studio tank command and specify the project name to tell it which project to run the update check for:

> tank Project XYZ updates

Collaboration and Evolution

If you have access to the Shotgun Pipeline Toolkit, you also have access to the source code for all apps, engines and frameworks in Github where we store and manage them. Feel free to evolve these items; use them as a base for further independent development, make changes (and submit pull requests back to us!) or simply tinker with them to see how they have been built and how the toolkit works. You can access this code repository at https://github.com/shotgunsoftware/tk-multi-screeningroom.

Special Requirements

  • You need Shotgun Pipeline Toolkit Core API version v0.12.5 or higher to use this.

Configuration

Below is a summary of all the configuration settings used. These settings need to be defined in the environment file where you want to enable this App or Engine.

enable_web_mode

Type: bool

Default Value: True

Description: Toggles the display of a menu item that allows a user to jump the Screening Room Web Player.

init_hook

Type: hook

Default Value: {self}/init.py

Description: This hook contains methods that a user can override in order control how the environment is initialized before screening room is launched.

enable_rv_mode

Type: bool

Default Value: True

Description: Toggles the display of a menu item that allows a user to jump the Screening Room RV Player.

rv_path_windows

Type: str

Default Value: C:\Program Files\RV\RV64.exe

Description: The path to the Rv executable on Windows.

rv_path_mac

Type: str

Default Value: /Applications/RV64.app

Description: The path to the Rv executable on Macosx.

rv_path_linux

Type: str

Default Value: rv

Description: The path to the Rv executable on Linux.

Release Notes

Welcome to the release notes for this App. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!

v0.3.2

2016-Dec-14

Allows to launch RV using a shell function.

v0.3.0

Supports context changes.

v0.2.0

2015-Nov-19

Added a pre-launch hook.

v0.1.10

Fixes a crash when launching RV at the project level from the Desktop app.

v0.1.9

Fixed a bug causing 32 bit RV on Macosx to fail to load.

v0.1.8

Added option to jump into the web version of Screening Room.

Details: There are now two new configuration options which lets you toggle the items that are shown on the Shotgun menu. The first one is the one that lets you jump to Screening Room for RV - this is the functionality that we have had previously. The second one is a new option that allows a user to jump to the web version of Screening Room. This will pop up your default web browser and launch Screening Room there.

v0.1.5

Renames and support for the new name Sgtk.

v0.1.4

Added better metadata for the shell engine.

v0.1.3

Name updated to Screening Room

Details:

  • Name changed to Screening Room

v0.1.2

Details: Now runs in all engines. Updated manifest to require 0.12.5

v0.1.1

Added support for code reload.

v0.1.0

Initial release

Follow

0 Comments

Please sign in to leave a comment.