Regions

Our API.stream services are available globally.

Placing Your Broadcasts

If all of the sources of your broadcast are likely to be situated in the same region, you may optionally instruct the Live API to try to place your broadcast resources in that region to optimize for latency. This can be accomplished when creating the project as follows:

  // Create a new project and try to place it in an optimal location
  const response = await api.LiveApi().project?.createProject( {
    collectionId: state.collectionId,
    // find a region close to Meteor Crater Natural Landmark
    location: {
      latitude: 35.028055555556,
      longitude: -111.02222222222
    }
    ...
  } );

note

Specifying an ideal location for your broadcast is considered a 'hint' to API.stream services. Our backend services may place your broadcast in another region pending service availability, requested feature availability, and other considerations.

Determining Broadcast Location

Once your broadcast is started, you may determine the actual location by querying the Live API as follows:

  // after a broadcast has started, query its status to determine where it was placed
  const response = await api.LiveApi().project?.getProjectBroadcastStatus( {
    collectionId: state.collectionId,
    projectId: state.projectId,
  } );

  console.log(response.status?.region?.toString())

Regions

The following table iterates the currently available regions for API.stream services.

Region	Location
REGION_EU_CENTRAL_1	Frankfurt, Germany
REGION_EU_WEST_1	London, United Kingdom
REGION_US_EAST_1	New York City, United States
REGION_US_WEST_1	San Francisco, United States
REGION_CA_EAST_1	Toronto, Canada
REGION_AP_SOUTHEAST_2	Sydney, Australia

Status

Status for each region is available from our status portal.