Breaking changes#

With the change from UI Toolkit 1.0 to 2.0, the toolkit is no longer one full-screen view controller. In 1.0, UIToolkitVC presented the whole session UI. In 2.0, you place each button and the video surface yourself and decide the layout.

Added#

• Video - add ZMUIToolkitRootVideoView for the local share, remote shares, the participant gallery, and a floating self-video tile. Page dots are hidden when there is only one page. A REC badge appears while cloud recording is active or paused. Picture in Picture is turned on from Settings.
• Buttons - add only the controls you need: ZMUIToolkitAudioBtn , ZMUIToolkitVideoBtn , ZMUIToolkitShareBtn , ZMUIToolkitPauseShareBtn , ZMUIToolkitParticipantsBtn , ZMUIToolkitChatBtn , ZMUIToolkitVirtualBackgroundBtn , ZMUIToolkitSwitchCameraBtn , ZMUIToolkitMoreBtn , and ZMUIToolkitLeaveSessionBtn .
• Participants - the list is searchable and shows a live count. A participant can rename themselves. The host can rename anyone, make host, make co-host, remove a participant, mute everyone, and ask everyone to unmute. A host or a manager can mute another participant or ask that participant to unmute.
• Leave - a non-host leaves only themselves. A host with other people in the session assigns a new host before leaving. End session for all asks for confirmation. A host who is alone ends the session on leave.
• Chat - the chat button shows an unread count. Messages can go to everyone or to one participant, last only for the current session, and can be deleted. The same panel opens from More.
• Virtual background - None, Blur, and images, from its own button or from More. It appears only when virtual background is supported. An image can be removed from the picker. The preview can switch cameras.
• Switch camera: swaps the front and rear cameras. Hide or omit it on a device with only one camera.
• More - choose which of Chat, virtual background, recording, share pause and resume, and Settings are shown. Cancel is always shown. Settings includes rename, network statistics, and Picture in Picture. Cloud recording, including the consent prompt, is one of the More items.

Changed#

New installation instructions for the new UI Toolkit 2.0.

• Swift Package Manager. Add https://github.com/zoom/videosdk-ui-toolkit-ios  and select the swift-package-manager branch. The package name is ZMUIToolkitiOS (iOS 15). Add the ZMUIToolkitiOS library to the app target. It includes ZMUIToolkit and ZoomVideoSDK. Add the ZoomVideoSDKScreenShare library to the broadcast upload extension.

• CocoaPods. Add this to your Podfile.

target 'YourMainAppTarget' do
  use_frameworks!
  pod 'ZMUIToolkitiOS', '2.6.11'
end

target 'YourBroadcastUploadExtensionTarget' do
  use_frameworks!
  pod 'ZMUIToolkitiOS/ZoomVideoSDKScreenShare', '2.6.11'
end

Add ZMUIToolkitiOS/ZoomVideoSDKScreenShare only to the Broadcast Upload Extension target.