class RED::ILicense

Interface that exposes license management methods. More...

#include <REDILicense.h>

Inherits: IREDObject.

Public functions:

Public static functions:

Detailed description:

Interface that exposes license management methods.

The RED::ILicense interface exposes the REDsdk licensing API. It enables customers to disarm the REDsdk license checks in order to deploy their applications to their own customers.

There are two licensing modes in REDsdk: per-seat or software vendor licensing. Each mode comes with its own API to set up a license.

Whatever the licensing mode you chose, licensing your REDsdk-based application is the very first step in running it. If you miss or fail to license correctly your application, REDsdk API calls will fail.

In both modes, the customer is provided with a customer ID uniquely identifying him in Redway3d's customers list. This ID is encrypted and privately held to respect customer's privacy. Alternatively, he may have received a generic customer ID with a temporary license key for evaluation purpose.

In this mode, the customer ID must be supplied to REDsdk using RED::ILicense::SetOnlineLicense.

A connection is initiated with the Redway3d's licensing servers waiting for a green light. This process is blocking as no other REDsdk call can be operated as long as a valid license has not been received.

In this mode, a REDsdk customer must also have received a license key along with his customer ID. Both information need to be supplied to the API to remove REDsdk protection.

The CID_REDResourceManager is the only object that exposes this interface.

A customer should always have those lines of code inserted into his application after having created a RED::IResourceManager instance and before any call to the other RED::Factory methods:

  // create the unique instance of the REDResourceManager:
  RED::Object* resmgr = RED::Factory::CreateInstance( CID_REDResourceManager );
  if( resmgr == NULL )
    ERROR;

  // get the interface to the RED resource manager
  RED::IResourceManager *iresmgr = _resmgr->As<RED::IResourceManager>();

  // get the interface to the licensing API
  RED::ILicense* ilicense = _resmgr->As< RED::ILicense >();

  // setup the customer licensing information (per-seat mode)
  ilicense->SetOnlineLicense( my_customer_ID );
  // or (software vendor mode)
  ilicense->SetLicense( my_license_key, my_customer_ID );

You can then check if your application is correctly activated by calling RED::ILicense::IsProductActivated.

Upon success, those lines of code definitely disarm the REDsdk protection.

Functions documentation