ftrack-connect-rv

Welcome to the documentation for ftrack connect RV.

Getting started

To get started with using the ftrack connect RV plugin, follow this guide and you will be up and running quickly.

Installing the RV package

First, you will need to install the integration package in RV:

  1. Download the standalone package for RV from the ftrack Integrations page.

  2. Launch RV and install the rvpkg package from RV’s preferences.

Launching

You can launch RV with the integration either as an action using ftrack Connect or via the rvlink protocol from the web interface.

Using ftrack Connect

ftrack connect RV comes bundled with ftrack Connect package and allows you to start launch RV with the ftrack review panels without any additional configuration.

Note

If you are running Linux, you will need to set the environment variable RV_INSTALLATION_PATH to the root folder of the RV installation for ftrack Connect to find the installation.

From the web interface

Running ftrack Connect RV via the rvlink protocol requires a bit more setup, but does not require you to be running Connect in order to use ftrack review in RV. To do so, follow the instructions below.

  1. Setup the RV protocol handler for your browser.

  2. The RV integration currently requires that the ftrack legacy Python API is available and configured with valid credentials. To do so, you can either configure credentials via environment variables and set PYTHONPATH (globally) to point to the legacy API or extract the legacy Python API archive within the installed RV package’s Python directory and edit the file ftrack.py, adding API credentials.

    See also

    Getting started with the legacy Python API

Using

For guide on how to use the plugin see internal reviews documentation.

Building from source

Note

Unless you are doing any modifications, there should be no need to build the plugin yourself. See Getting started for instructions on how to install and run the plugin.

Building plugin

You can build manually from the source for more control. First obtain a copy of the source by either downloading the zipball or cloning the public repository:

git clone git@bitbucket.org:ftrack/ftrack-connect-rv.git

Build the plugin (Will build the plugin and dependencies in build/plugin):

python setup.py build_plugin

See Getting started for instructions on how to install and run the plugin.

Building documentation from source

To build the documentation from source:

python setup.py build_sphinx

Then view in your browser:

file:///path/to/ftrack-connect-rv/build/doc/html/index.html

Running tests against the source

With a copy of the source it is also possible to run the unit tests:

python setup.py test

Dependencies

Additional For building

Additional For testing

Glossary

ftrack connect

Integration of ftrack with other systems and the desktop. Provided by a core service that runs on each individuals machine and then separate integration plugins into a variety of third-party software.

See also

ftrack connect

ftrack connect package

ftrack connect package is a pre-built bundle of ftrack connect and the most commonly used ftrack connect plugins.

RV

RV is a desktop review tool by Teak Software that lets you playback every shot on the VFX timeline and compare versions of renders quickly. See website for more information

Release and migration notes

Find out information about what has changed between versions and any important migration notes to be aware of when switching to a new version.

Release Notes

Upcoming

26 May 2023
  • fixed

    ApiRv does not play Entity selections.

  • fixed

    LoggingLog initialization breaks due to utf8 conversion.

  • fixed

    ApiRv breaks not being able to parse tempdata.

  • fixed

    UXPanel size too small at startup.

5.0

7 September 2021
  • changed

    Port to python 3 and PySide2.

  • changed

    Refactor to support RV 20XX

  • fixed

    ApiFailed to jump to index error.

Warning

From this version the support for ftrack-connect 1.X is dropped, and only ftrack-conenct 2.0 will be supported up to the integration EOL.

4.0

14 January 2020
  • changed

    Moved from Qt Webkit to Qt WebEngine for Qt 5.12 / RV 7.5+

  • changed

    SetupExposing dependencies folder to resultan build folder

  • changed

    SetupBuild resultant folder renamed with the plugin name + version

  • changed

    Setupftrack-location-compatibility version updated to 0.3.3

  • changed

    SetupPip compatibility for version 19.3.0 or higher

3.7

17 November 2017
  • fixed

    Fail gracefully if a single asset version fails to load.

3.6

28 June 2017
  • fixed

    Unable to add notes with annotations.

  • fixed

    Plugin outputs error if installation location is not found for RV under Linux.

  • fixed

    The action is registered twice in ftrack connect.

3.5

30 May 2017
  • fixed

    RV crashes when loading a previously loaded version for the second time.

3.4

17 May 2017
  • new

    DocumentationAdded installation instructions.

  • fixed

    New versions of RV are not found in their default installation directory.

Indices and tables