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

Declaration

class Share

ObjC Types and Enums Used by This Swift API

Members

canShareCamera(completion:meetingType:)

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

can share camera

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

canShareVideoFile(completion:meetingType:)

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

check whether we can share video file

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

canStartShare(completion:meetingType:)

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

check whether can share or not

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

canSwitchShareNextCamera(completion:meetingType:)

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

can switch share next camera

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

enableOptimizeForSharedVideoFeature(bEnable:completion:meetingType:)

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

enable optimize for share video

  • Parameters:
  • bEnable: true is enable, false is disable
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

enableShareComputerSoundFeature(bEnable:completion:meetingType:)

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

enable share computer sound feature

  • Parameters:
  • bEnable: true is enable, false is disable
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

getAudioShareMode(completion:meetingType:)

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

get audio share model

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

getSharingStatus(userId:completion:meetingType:)

static func getSharingStatus(userId: UInt, completion: @escaping (ZoomToolSuiteGetSharingStatusResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

get user sharing status

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

isOptimizeForSharedVideoFeatureOn(_:)

static func isOptimizeForSharedVideoFeatureOn(_ meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check whether optimize for share video is turn on or not

  • Parameter meetingType: meeting type
  • Returns: whether optimize for share video is turn on or not

isShareComputerSoundFeatureOn(_:)

static func isShareComputerSoundFeatureOn(_ meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check whether support share computer sound is turn on or not

  • Parameter meetingType: meeting type
  • Returns: whether share computer sound is turn on or not

isSupportOptimizeForSharedVideo(_:)

static func isSupportOptimizeForSharedVideo(_ meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check if support optimize for share video

  • Parameter meetingType: meeting type
  • Returns: whether this meeting support optimize for share video

isSupportShareComputerSound(_:)

static func isSupportShareComputerSound(_ meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

check if support share computer sound

  • Parameter meetingType: meeting type
  • Returns: whether this meeting support share computer sound

pauseResumeShareToggle(completion:meetingType:)

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

Pause or resume sharing

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

setAudioShareMode(mode:completion:meetingType:)

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

set audio share model

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

startAppShare(vAppID:completion:meetingType:)

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

start window share

  • Parameters:
  • vAppIDs: window id list
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

startAudioShare(completion:meetingType:)

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

start audio share

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

startCameraShare(completion:meetingType:)

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

start camera share

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

startFrameShare(completion:meetingType:)

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

start frame share

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

startMonitorShare(vMonitorID:completion:meetingType:)

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

start monitor share

  • Parameters:
  • vMonitorIDs: monitor id list
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

startVideoFileShare(filePath:completion:meetingType:)

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

start video file share

  • Parameters:
  • filePath: video file path
  • completion: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successfu

startWhiteBoardShare(completion:meetingType:)

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

start white board share

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

stopShare(completion:meetingType:)

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

stop share

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

switchShareNextCamera(completion:meetingType:)

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

switch share next camera

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