Plugin SDK for macOS Swift API Reference
Swift API documentation for PluginSDK
Loading...
Searching...
No Matches
ZoomToolSuiteAPI.Meeting.Video

Declaration

class Video

ObjC Types and Enums Used by This Swift API

Members

canSpotlight(iUserId:completion:meetingType:)

static func canSpotlight(iUserId: UInt32, completion: @escaping (ZoomToolSuiteProxyCanSpotlightResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check whether we can spotlight someone's video

  • Parameters:
  • iUserId: userid
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

canUnSpotlight(iUserId:completion:meetingType:)

static func canUnSpotlight(iUserId: UInt32, completion: @escaping (ZoomToolSuiteCanUnSpotlightResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check whether we can unspotlight someone's video

  • Parameters:
  • iUserId: userid
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isShowAvatar(completion:meetingType:)

static func isShowAvatar(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

is avatar show

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

muteMyVideo(completion:meetingType:)

static func muteMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

mute my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

pinMyVideo(completion:meetingType:)

static func pinMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

pin my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

showAvatar(show:completion:meetingType:)

static func showAvatar(show: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

show avatar

  • Parameters:
  • show: show or not
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

spotlightMyVideo(completion:meetingType:)

static func spotlightMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

spotlight my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

spotlightVideo(iUserId:completion:meetingType:)

static func spotlightVideo(iUserId: UInt32, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

spolight someone's video

  • Parameters:
  • iUserId: userid
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

toggleMyVideoPinStatus(completion:meetingType:)

static func toggleMyVideoPinStatus(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

toggle my video pin status

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

toggleMyVideoSpotlightStatus(completion:meetingType:)

static func toggleMyVideoSpotlightStatus(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

toggle my video spotlight status

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

toggleMyVideoStatus(completion:meetingType:)

static func toggleMyVideoStatus(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

toggle my video status

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

unmuteMyVideo(completion:meetingType:)

static func unmuteMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

unmute my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

unpinMyVideo(completion:meetingType:)

static func unpinMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

unpin my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

unSpotlightAllVideos(completion:meetingType:)

static func unSpotlightAllVideos(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

unspotlight all videos

  • Parameters:
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

unSpotlightMyVideo(completion:meetingType:)

static func unSpotlightMyVideo(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

unSpotlight my video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

unSpotlightVideo(iUserId:completion:meetingType:)

static func unSpotlightVideo(iUserId: UInt32, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

unspotlight someone's video

  • Parameters:
  • iUserId: userid
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful