Spotlight a user

Spotlighting a user calls attention to that user's video for everyone in the session, regardless of who is talking. Spotlight is typically used by a host to emphasize a speaker or presenter. The Video SDK for macOS supports spotlighting multiple users at once.

Spotlight a user

To highlight a user's video for all participants, call spotLightVideo on the ZMVideoSDKVideoHelper with that user.

ZMVideoSDK.shared()?.getVideoHelper()?.spotLightVideo(user)

[[[ZMVideoSDK sharedVideoSDK] getVideoHelper] spotLightVideo:user];

Remove spotlight from a user

To drop a user from the spotlight, call unSpotLightVideo with that user.

ZMVideoSDK.shared()?.getVideoHelper()?.unSpotLightVideo(user)

[[[ZMVideoSDK sharedVideoSDK] getVideoHelper] unSpotLightVideo:user];

Remove spotlight from everyone

To clear the spotlight for every user at once, call unSpotlightAllVideos.

ZMVideoSDK.shared()?.getVideoHelper()?.unSpotlightAllVideos()

[[[ZMVideoSDK sharedVideoSDK] getVideoHelper] unSpotlightAllVideos];

Get the list of spotlighted users

Use getSpotlightedVideoUserList to retrieve every user who is currently spotlighted. This is useful when you need to render a different layout for spotlighted users (for example, in a larger view) or to update the UI when a user joins mid-session.

if let spotlighted = ZMVideoSDK.shared()?.getVideoHelper()?.getSpotlightedVideoUserList() {
    for user in spotlighted {
        // Adjust your UI for each spotlighted user.
    }
}

NSArray<ZMVideoSDKUser *> *spotlighted = [[[ZMVideoSDK sharedVideoSDK] getVideoHelper] getSpotlightedVideoUserList];
for (ZMVideoSDKUser *user in spotlighted) {
    // Adjust your UI for each spotlighted user.
}

To react to spotlight changes as they happen, implement onSpotlightVideoChanged.