onUserSubStreamAvailable property

(void Function(String userId, bool available)?) onUserSubStreamAvailable
final

A Remote User Published/Unpublished Substream Video

The substream is usually used for screen sharing images. If you receive the onUserSubStreamAvailable (userId, true) callback, it indicates that the user has available substream video.

You can then call startRemoteView to subscribe to the remote user’s video. If the subscription is successful, you will receive the onFirstVideoFrame (userId) callback, which indicates that the first frame of the user is rendered.

  • Parameters:
    • available(bool):
      • Whether the user published (or unpublished) substream video.
        • true: published;
        • false: unpublished.
    • userId(String):
      • User ID of the remote user.

Note

The API used to display substream images is startRemoteView,

Implementation

final void Function(String userId, bool available)? onUserSubStreamAvailable;