ZMVideoSDKSessionContext Class Reference

Session context information for a Zoom Video SDK session. More...

#include <ZMVideoSDK.h>

Inherits NSObject.

Properties
NSString *	sessionName
	Session name.
NSString *	sessionPassword
	Session password (optional).
NSString *	userName
	User name(required).
NSString *	token
	JWT token to join session.
ZMVideoSDKVideoOption *	videoOption
	Video option.
ZMVideoSDKAudioOption *	audioOption
	Audio option.
id< ZMVideoSDKVideoSourcePreProcessor >	preProcessor
	Set delegate. (optional).
id< ZMVideoSDKVideoSource >	externalVideoSource
	Set delegate (optional).
id< ZMVideoSDKVirtualAudioMic >	virtualAudioMic
	Set virtual audio delegate (optional).
id< ZMVideoSDKVirtualAudioSpeaker >	virtualAudioSpeaker
	Set virtual audio speaker delegate (optional).
unsigned int	sessionIdleTimeoutMins
	[Optional] The amount of time in minutes after which an idle session will end.
BOOL	autoLoadMutliStream
	Whether to automatically load multi streams when entering a session, default value is YES, optional.

Detailed Description

Session context information for a Zoom Video SDK session.

Definition at line 145 of file ZMVideoSDK.h.

Property Documentation

audioOption

- (ZMVideoSDKAudioOption*) audioOption

readwritenonatomicretain

Audio option.

Definition at line 175 of file ZMVideoSDK.h.

autoLoadMutliStream

- (BOOL) autoLoadMutliStream

readwritenonatomicassign

Whether to automatically load multi streams when entering a session, default value is YES, optional.

Definition at line 202 of file ZMVideoSDK.h.

externalVideoSource

- (id<ZMVideoSDKVideoSource>) externalVideoSource

readwritenonatomicassign

Set delegate (optional).

Definition at line 184 of file ZMVideoSDK.h.

preProcessor

- (id<ZMVideoSDKVideoSourcePreProcessor>) preProcessor

readwritenonatomicassign

Set delegate. (optional).

Definition at line 180 of file ZMVideoSDK.h.

sessionIdleTimeoutMins

- (unsigned int) sessionIdleTimeoutMins

readwritenonatomicassign

[Optional] The amount of time in minutes after which an idle session will end.

Note

When there is only one user remaining in a session, that session is considered idle.

Default value: 40. If the value is less than 0, the session will stay alive indefinitely.

Definition at line 198 of file ZMVideoSDK.h.

sessionName

- (NSString*) sessionName

readwritenonatomicretain

Session name.

Definition at line 150 of file ZMVideoSDK.h.

sessionPassword

- (NSString*) sessionPassword

readwritenonatomicretain

Session password (optional).

Definition at line 155 of file ZMVideoSDK.h.

token

- (NSString*) token

readwritenonatomicretain

JWT token to join session.

Definition at line 165 of file ZMVideoSDK.h.

userName

- (NSString*) userName

readwritenonatomicretain

User name(required).

Definition at line 160 of file ZMVideoSDK.h.

videoOption

- (ZMVideoSDKVideoOption*) videoOption

readwritenonatomicretain

Video option.

Definition at line 170 of file ZMVideoSDK.h.

virtualAudioMic

- (id<ZMVideoSDKVirtualAudioMic>) virtualAudioMic

readwritenonatomicassign

Set virtual audio delegate (optional).

Definition at line 188 of file ZMVideoSDK.h.

virtualAudioSpeaker

- (id<ZMVideoSDKVirtualAudioSpeaker>) virtualAudioSpeaker

readwritenonatomicassign

Set virtual audio speaker delegate (optional).

Definition at line 192 of file ZMVideoSDK.h.