Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSubSessionManager Class Reference

Manages subsession lifecycle and communication. More...

#include <ZMVideoSDKSubsessionHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- startSubSession
 Starts subsession.
 
(BOOL) - isSubSessionStarted
 Determines if the subsession has started.
 
(ZMVideoSDKErrors- stopSubSession
 Stops subsession.
 
(ZMVideoSDKErrors- broadcastMessage:
 Broadcast a message to all subsessions.
 

Detailed Description

Manages subsession lifecycle and communication.

Definition at line 84 of file ZMVideoSDKSubsessionHelper.h.

Method Documentation

◆ broadcastMessage:

- (ZMVideoSDKErrors) broadcastMessage: (NSString *) message

Broadcast a message to all subsessions.

Parameters
messageThe message to be broadcast.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.
Note
'onBroadcastMessageFromMainSession' is the corresponding callback notification.

◆ isSubSessionStarted

- (BOOL) isSubSessionStarted

Determines if the subsession has started.

Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startSubSession

- (ZMVideoSDKErrors) startSubSession

Starts subsession.

Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.
Note
'onSubSessionStatusChanged' is the corresponding callback notification.

◆ stopSubSession

- (ZMVideoSDKErrors) stopSubSession

Stops subsession.

Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.
Note
'onSubSessionStatusChanged' is the corresponding callback notification.