---
title: "RenderStreamClusterBase"
description: "API documentation for RenderStreamClusterBase"
url: https://developer.disguise.one/python-api/docs/renderstreamclusterbase/
---

# RenderStreamClusterBase

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

Subclasses: _[RenderStreamCluster](/python-api/docs/renderstreamcluster#renderstreamcluster)_, _[RenderStreamLocalCluster](/python-api/docs/renderstreamlocalcluster#renderstreamlocalcluster)_

## Properties

#### **anyInstanceIsRunning** : _bool_ _(Read-Only)_

#### **anyInstanceIsTransitioning** : _bool_ _(Read-Only)_

#### **channelInstances** : _List\[[ChannelInstance](/python-api/docs/channelinstance#channelinstance)\]_

_UserName: Channel instances_

#### **controller** : _[Machine](/python-api/docs/machine#machine)_

The machine remotely controlling rendering

_UserName: Controller_

#### **nInstances** : _int_ _(Read-Only)_

#### **workloadHealth** : _[WorkloadHealth](/python-api/docs/workloadhealth#workloadhealth)_ _(Read-Only)_

#### **workloadIsStoppable** : _bool_ _(Read-Only)_

## Methods

#### **controllerActive**(self) -> _bool_

#### **getAssignmentForecast**(self, assigners: _[MultiChannelClusterAssignerBase](/python-api/docs/multichannelclusterassignerbase#multichannelclusterassignerbase)_, asset: _[RenderStreamAsset](/python-api/docs/renderstreamasset#renderstreamasset)_, clusterPool: _[ClusterPool](/python-api/docs/clusterpool#clusterpool)_) -> _List\[[ChannelInstance](/python-api/docs/channelinstance#channelinstance)\]_

#### **instanceHealth**(self, iInstance: _int_) -> _[WorkloadHealth](/python-api/docs/workloadhealth#workloadhealth)_

#### **instanceMachine**(self, iInstance: _int_) -> _[RenderStreamMachine](/python-api/docs/renderstreammachine#renderstreammachine)_

#### **reconfigureWorkload**(self, asset: _[RenderStreamAsset](/python-api/docs/renderstreamasset#renderstreamasset)_, cluster: _[ClusterPool](/python-api/docs/clusterpool#clusterpool)_, assigner: _[MultiChannelClusterAssignerBase](/python-api/docs/multichannelclusterassignerbase#multichannelclusterassignerbase)_, framerateDivisor: _int_)

#### **startWorkload**(self, config: _[RenderStreamModuleConfigBase](/python-api/docs/renderstreammoduleconfigbase#renderstreammoduleconfigbase)_)

#### **stopWorkload**(self)