Backstage

Introduction

By default, livestreams are created in backstage mode, while in backstage mode, streams can only be accessed by admin-like users. This is necessary because it makes it possible to create the setup in advance and to notify and grant access to viewers when the event starts. To allow regular users to join a call ahead of time, even if the call is still in backstage mode you can create the call and set the join ahead time backstage setting. The default value of join_ahead_time_seconds is 0, which means that users can only join the call when the call starts.

Configuration

To create a call in backstage mode and allow users to join ahead of the scheduled time you can use the join_ahead_time_seconds settings option.

JavaScript

startsAt = new Date(Date.now() + 30 * 60 * 1000);
client.call('livestream', 'test-outgoing-call').getOrCreate({
    data: {
        starts_at: startsAt.toISOString(),
        created_by_id: 'john',
        settings_override: {
            backstage: {
                enabled: true,
                join_ahead_time_seconds: 300,
            },
        },
    },
});

Python

# create a call with backstage enabled, starts_at set
# and join_ahead_of_time_seconds set to 5 minutes
from datetime import datetime, timedelta, timezone
starts_at = datetime.now(timezone.utc) + timedelta(minutes=30)

call = client.video.call("livestream", uuid.uuid4())
response = call.get_or_create(
    data=CallRequest(
        starts_at=starts_at,
        created_by_id=user_id,
        settings_override=CallSettingsRequest(
            backstage=BackstageSettingsRequest(
                enabled=True,
                join_ahead_time_seconds=300,
            ),
        ),
    )
)

cURL

# create a call with backstage mode and join ahead time settings
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "Content-Type: application/json" \
  -H "stream-auth-type: jwt" \
  -d '{
    "data": {
      "starts_at": "2022-01-01T00:00:00Z",
      "created_by_id": "john",
      "settings_override": {
        "backstage": {
            "enabled": true,
            "join_ahead_time_seconds": 300
          }
         },
      }
    }'

You can change the backstage mode and join ahead time settings on the call type or on the call level. Allowing the users to join a call in backstage is optional.

JavaScript

// call level
call.update({
  settings_override: {
    backstage: {
      enabled: true,
      join_ahead_time_seconds: 300,
    },
  },
});

// or call type level
client.video.updateCallType('<call type name>', {
  settings: {
    backstage: {
      enabled: true,
      join_ahead_time_seconds: 300,
    },
  },
});

Python

# call level update
call.update(
    settings_override=CallSettingsRequest(
        backstage=BackstageSettingsRequest(
            enabled=True,
            join_ahead_time_seconds=300,
        ),
    ),
)

# call type level update
call_type_name = '<call type name>'
client.video.update_call_type(
    settings=CallSettingsRequest(
        backstage=BackstageSettingsRequest(
            enabled=True,
            join_ahead_time_seconds=300,
        ),
    ),
)

cURL

# call level update
curl -X PATCH "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE_NAME}/${CALL_ID}?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt" \
  -H "Content-Type: application/json" \
  -d '{
  "settings_override": {
      "backstage": {
        "enabled": true,
        "join_ahead_time_seconds": 300
      }
    }
  }'

# call type level update
curl -X PUT "https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE_NAME}?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt" \
  -H "Content-Type: application/json" \
  -d '{
    "settings": {
      "backstage": {
        "enabled": true,
        "join_ahead_time_seconds": 300
      }
    }
  }'

Setting the backstage mode to false means that calls won't be created in backstage mode, and anyone can join the call.

Backstage Permissions

When a call is in backstage mode, only users with the join-backstage capability are allowed to join.

JavaScript

client.video.updateCallType('<call type name>', {
  grants: {
    host: [VideoOwnCapability.JOIN_BACKSTAGE],
  },
});

Python

callTypeName = '<call type name>'
client.video.update_call_type(
    grants={"host": [OwnCapability.JOIN_BACKSTAGE.to_str()]},
)

cURL

curl -X PUT "https://video.stream-io-api.com/api/v2/video/calltypes/${CALL_TYPE_NAME}?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt" \
  -H "Content-Type: application/json" \
  -d '{
    "grants": {
      "host": ["join-backstage"]
    }
  }'

With this approach you can add multiple members that have the join-backstage capability, which allows you to have multiple hosts. Or, you can bypass this check and allow users to join by creating time with specifying the join_ahead_time_seconds backstage option.

Go Live

When the hosts are ready to start the stream and allow viewers to join, you can call the GoLive method.

Optionally, you can start the HLS broadcast and/or recording at the same time as going live.

JavaScript

call.goLive();

// optionally start HLS broadcast and/or recording
call.goLive({ start_hls: true, start_recording: true });

Python

call.go_live(start_hls=True, start_recording=True)

cURL

curl -X POST "https://video.stream-io-api.com/api/v2/video/call/livestream/${CALL_ID}/go_live?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt"

# optionally start HLS broadcast and/or recording
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/livestream/${CALL_ID}/go_live?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt" \
  -H "Content-Type: application/json" \
  -d '{ "start_hls": true, "start_recording": true }'

It's also possible to send push notifications to call members on this event, for more information see the Call Types page.

Stop Live

When the stream ends the StopLive endpoint will remove the viewers that are still in the call, and prevent from new viewers to join.

A call can enter and leave backstage mode multiple times.

JavaScript

call.stopLive();

Python

call.stop_live()

cURL

curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE_NAME}/${CALL_ID}/stop_live?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H "stream-auth-type: jwt"

# call stopLive with starts_at update
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE_NAME}/${CALL_ID}/stop_live?api_key=${API_KEY}" \
  -H "Authorization: ${TOKEN}" \
  -H " stream-auth-type: jwt" \