Skip to main content
Paid plans only useLiveStreamingInstances(): LiveStreamingInstanceState[] This is useful when working with multi-instance live streaming to enumerate and display all active (and recently stopped) streaming instances.

​
Return value

An array of LiveStreamingInstanceState objects, each with the following properties:
​
errorMsg
string
Error message for this instance, if any.
​
instanceId
string
The unique identifier for this live streaming instance.
​
isLiveStreaming
boolean
Whether this instance is currently live streaming.
​
layout
Object
The live streaming layout configuration for this instance.

​
Example

import { useLiveStreamingInstances } from '@daily-co/daily-react';

export const StreamingInstancesList = () => {
  const instances = useLiveStreamingInstances();

  if (instances.length === 0) {
    return <div>No live streams</div>;
  }

  return (
    <ul>
      {instances.map((instance) => (
        <li key={instance.instanceId}>
          {instance.instanceId}: {instance.isLiveStreaming ? 'Live' : 'Stopped'}
          {instance.layout?.preset && ` (${instance.layout.preset})`}
        </li>
      ))}
    </ul>
  );
};

​
See also

Hooks

Guides