Summary

This document outlines the process of creating a shareable Stage Link in Fusion that will load a preconfigured stage layout with a specified play time. The following example creates a Stage Link with the following configuration:

• Stage will present 2 players on a 1 x 2 grid
• Stage Link will expire after 7 days
• When loaded, the players on the Stage will begin playing from June 1, 2023 07:00 EST

 

Steps to Generate Stage Link

• Determine the orchidId and id of each camera to display on the Stage.
• Construct a Stage Matrix JSON object that represents the layout of players on the Stage.

 

// Example Layout Stage Matrix

"stageMatrix":

    [

      // Define the first Stage row.

      [

        // First cell (left) 

        {

          "columnSpan": 1,

          "rowSpan": 1,

          "camera": {

            "id": 542,

            "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

          }

        },

        // Second cell (right)

        {

          "columnSpan": 1,

          "rowSpan": 1,

          "camera": {

            "id": 673,

            "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

          }

        }

      ]

    ]

• Execute an HTTP POST request to the Fusion /service/layouts endpoint. Properly configure the following properties of the Request Body:
  • expiresInSec - The length of time the Stage Link will be valid.
  • playbackStartTimeMs - The desired Stage Playback time in epoch milliseconds.
  • shared - Set to true for a shared Stage Link.
  • stageMatrix - Stage Matrix JSON object described in Step 2.
  • cameras - Array of camera IDs for all cameras present in the stageMatrix.

// Example POST /service/layouts request body.

{

  "shared": true,

  "expiresInSec": 604800,

  "playbackStartTimeMs": 1685617200000,

  "name": "New layout",

  "stageMatrix": [

    [

      {

        "columnSpan": 1,

        "rowSpan": 1,

        "camera": {

          "id": 542,

          "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

        }

      },

      {

        "columnSpan": 1,

        "rowSpan": 1,

        "camera": {

          "id": 673,

          "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

        }

      }

    ]

  ],

  "cameras": [

    {

      "id": 542,

      "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

    },

    {

      "id": 673,

      "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

    }

  ]

}

• Retrieve the id that is returned in the response body. This id will be used to access the Stage Link.

// Example response body

{

  "id": "5e0f5d16-c0c9-4185-920a-84936a26168a",

  "shared": true,

  // Created on June 1, 2023 16:43:23 EST. Will expire June 8, 2023 16:43:23 EST  

  "expirationMs": 1686257003076, 

  "playbackStartTimeMs": 1685617200000,

  "name": "New layout",

  "stageMatrix": [

    [

      {

        "columnSpan": 1,

        "rowSpan": 1,

        "camera": {

          "id": 542,

          "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

        }

      },

      {

        "columnSpan": 1,

        "rowSpan": 1,

        "camera": {

          "id": 673,

          "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd"

        }

      }

    ]

  ],

  "cameras": [

    {

      "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd",

      "id": 542,

      "exists": true,

      "hasPermission": true

    },

    {

      "orchidId": "88c47414-18c3-4579-83a1-125e1ecb4cbd",

      "id": 673,

      "exists": true,

      "hasPermission": true

    }

  ]

}

 

• Access the shared Stage Link using the following schema:  <base-fusion-url>/#!/stage/<layout-id>

For example:

https://demo.ipconfigure.com/#!/stage/54e01c65-b34c-4159-8ece-88f8c330b27c