useLiveStreamingInstances

useLiveStreamingInstances(): LiveStreamingInstanceState[]

useLiveStreamingInstances returns an array of all live streaming instance states. This is useful when working with multi-instance live streaming to enumerate and display all active (and recently stopped) streaming instances.

Return type

An array of LiveStreamingInstanceState objects, each with the following properties:

NameTypeDescription
errorMsgstringError message for this instance, if any
instanceIdstringThe unique identifier for this live streaming instance
isLiveStreamingbooleanWhether this instance is currently live streaming
layoutObjectThe live streaming layout configuration for this instance

Sample code

Related references