Unity Video SDK API Reference Documentation
Loading...
Searching...
No Matches
ZMVideoSDKShareHelper Class Reference

Public Member Functions

void StopShare (Action< ZMVideoSDKErrors > callback)
 
bool IsSharingOut ()
 
bool IsScreenSharingOut ()
 
bool IsOtherUserSharingScreen ()
 
void LockScreenShare (bool enable, Action< ZMVideoSDKErrors > callback)
 
bool IsScreenSharingLocked ()
 
void EnableShareDeviceAudio (bool enable, Action< ZMVideoSDKErrors > callback)
 
bool IsShareDeviceAudioEnabled ()
 

Detailed Description

Definition at line 3 of file ZMVideoSDKShareHelper.cs.

Member Function Documentation

◆ EnableShareDeviceAudio()

void ZMVideoSDKShareHelper.EnableShareDeviceAudio ( bool  enable,
Action< ZMVideoSDKErrors callback 
)
inline

Enable or disable the device sound when sharing. The SDK does not support sharing device audio, for example, when you've enabled virtual speaker. This feature need Build.VERSION.SDK_INT >=29 and has RECORD_AUDIO Permission.

Parameters
enabletrue to enable. false to disable.
Returns
If the function succeeds, the return value is ZMVideoSDKErrors#Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors

Definition at line 130 of file ZMVideoSDKShareHelper.cs.

131 {
132 _videoSDKShareHelper.EnableShareDeviceAudio(enable, callback);
133 }

◆ IsOtherUserSharingScreen()

bool ZMVideoSDKShareHelper.IsOtherUserSharingScreen ( )
inline

Determine whether other user is sharing.

Returns
true indicates another user is sharing, otherwise false.

Definition at line 96 of file ZMVideoSDKShareHelper.cs.

97 {
98 return _videoSDKShareHelper.IsOtherUserSharingScreen();
99 }

◆ IsScreenSharingLocked()

bool ZMVideoSDKShareHelper.IsScreenSharingLocked ( )
inline

Determine whether sharing the view or screen is locked.

Returns
true indicates that sharing is locked, otherwise false.

Definition at line 118 of file ZMVideoSDKShareHelper.cs.

119 {
120 return _videoSDKShareHelper.IsScreenSharingLocked();
121 }

◆ IsScreenSharingOut()

bool ZMVideoSDKShareHelper.IsScreenSharingOut ( )
inline

Determine whether the current user is sharing the screen.

Returns
true indicates the current user is sharing the screen, otherwise false.

Definition at line 86 of file ZMVideoSDKShareHelper.cs.

87 {
88 return _videoSDKShareHelper.IsScreenSharingOut();
89 }

◆ IsShareDeviceAudioEnabled()

bool ZMVideoSDKShareHelper.IsShareDeviceAudioEnabled ( )
inline

Determine if the SDK has enabled share device sound.

Returns
true if enabled, otherwise false.

Definition at line 140 of file ZMVideoSDKShareHelper.cs.

141 {
142 return _videoSDKShareHelper.IsShareDeviceAudioEnabled();
143 }

◆ IsSharingOut()

bool ZMVideoSDKShareHelper.IsSharingOut ( )
inline

Determine whether the current user is sharing.

Returns
true indicates the current user is sharing, otherwise false.

Definition at line 76 of file ZMVideoSDKShareHelper.cs.

77 {
78 return _videoSDKShareHelper.IsSharingOut();
79 }

◆ LockScreenShare()

void ZMVideoSDKShareHelper.LockScreenShare ( bool  enable,
Action< ZMVideoSDKErrors callback 
)
inline

Lock sharing the view or screen. Only the host can call this method.

Parameters
locktrue to lock sharing.
Returns
If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZMVideoSDKErrors.

Definition at line 108 of file ZMVideoSDKShareHelper.cs.

109 {
110 _videoSDKShareHelper.LockScreenShare(enable, callback);
111 }

◆ StopShare()

void ZMVideoSDKShareHelper.StopShare ( Action< ZMVideoSDKErrors callback)
inline

Share a selected screen through Intent.

Parameters
datathe intent data for retriving the MediaProjection obtained from a succesful screen capture request. see:https://developer.android.com/reference/android/media/projection/MediaProjectionManager.html
Returns
If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZMVideoSDKErrors. Stop view or screen share.
If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZMVideoSDKErrors.

Definition at line 66 of file ZMVideoSDKShareHelper.cs.

67 {
68 _videoSDKShareHelper.StopShare(callback);
69 }