ZoomVideoSDKSessionContext Class Reference

A Class contains the session information. More...

#include <ZoomVideoSDK.h>

Inherits NSObject.

Properties
NSString *_Nullable	sessionName
	[Required] Session Name.
NSString *_Nullable	sessionPassword
	[Optional] Session Password.
NSString *_Nullable	userName
	[Required] User Name.
NSString *_Nullable	token
	[Required] JWT token to join session.
NSInteger	sessionIdleTimeoutMins
	[Optional] The amount of time in minutes after which an idle session will end.
BOOL	enable5GHighBandWidth
	[Optional] Whether to cancel the bandwidth limit, If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained.Bandwidth is not limited by default. If it is a wifi network, the bandwidth is not limited, and this setting is invalid.
ZoomVideoSDKAudioOptions *_Nullable	audioOption
	[Optional] Audio Option.
ZoomVideoSDKVideoOptions *_Nullable	videoOption
	[Optional] Video Option.
id< ZoomVideoSDKVideoSource > _Nullable	externalVideoSourceDelegate
	[Optional] Session external video source delegate.
id< ZoomVideoSDKVideoSourcePreProcessor > _Nullable	preProcessorDelegate
	[Optional] Session pre-processer delegate.
id< ZoomVideoSDKVirtualAudioMic > _Nullable	virtualAudioMicDelegate
	[Optional] Session external audio source delegate.
id< ZoomVideoSDKVirtualAudioSpeaker > _Nullable	virtualAudioSpeakerDelegate
	[Optional] Session virtual speaker.
BOOL	autoLoadMutliStream
	[Optional] Whether to automatically load multiple video streams when joining the session.
ZoomVideoSDKFrameDataFormat	externalVideoSourceDataFormat
	[Optional] The frame data format used for external video source initialization.

Detailed Description

A Class contains the session information.

Definition at line 148 of file ZoomVideoSDK.h.

Property Documentation

audioOption

- (ZoomVideoSDKAudioOptions* _Nullable) audioOption

readwritenonatomicstrong

[Optional] Audio Option.

Definition at line 177 of file ZoomVideoSDK.h.

autoLoadMutliStream

- (BOOL) autoLoadMutliStream

readwritenonatomicassign

[Optional] Whether to automatically load multiple video streams when joining the session.

Note

Default value: YES. Set to NO to disable auto-loading of multi-stream video.

Definition at line 207 of file ZoomVideoSDK.h.

enable5GHighBandWidth

- (BOOL) enable5GHighBandWidth

readwritenonatomicassign

[Optional] Whether to cancel the bandwidth limit, If YES is set, the network bandwidth is no longer limited, and better audio and video quality can be obtained.Bandwidth is not limited by default. If it is a wifi network, the bandwidth is not limited, and this setting is invalid.

Definition at line 173 of file ZoomVideoSDK.h.

externalVideoSourceDataFormat

- (ZoomVideoSDKFrameDataFormat) externalVideoSourceDataFormat

readwritenonatomicassign

[Optional] The frame data format used for external video source initialization.

Note

Effective when externalVideoSourceDelegate is set. Default is ZoomVideoSDKFrameDataFormat_I420.

Definition at line 212 of file ZoomVideoSDK.h.

externalVideoSourceDelegate

- (id<ZoomVideoSDKVideoSource> _Nullable) externalVideoSourceDelegate

readwritenonatomicweak

[Optional] Session external video source delegate.

Definition at line 186 of file ZoomVideoSDK.h.

preProcessorDelegate

- (id<ZoomVideoSDKVideoSourcePreProcessor> _Nullable) preProcessorDelegate

readwritenonatomicweak

[Optional] Session pre-processer delegate.

Definition at line 191 of file ZoomVideoSDK.h.

sessionIdleTimeoutMins

- (NSInteger) sessionIdleTimeoutMins

readwritenonatomicassign

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

Note

Default value: 40. If the value is less than 0, the session will stay alive indefinitely.When there is only one user remaining in a session, that session is considered idle.

Definition at line 169 of file ZoomVideoSDK.h.

sessionName

- (NSString* _Nullable) sessionName

readwritenonatomiccopy

[Required] Session Name.

Definition at line 152 of file ZoomVideoSDK.h.

sessionPassword

- (NSString* _Nullable) sessionPassword

readwritenonatomiccopy

[Optional] Session Password.

Definition at line 156 of file ZoomVideoSDK.h.

token

- (NSString* _Nullable) token

readwritenonatomiccopy

[Required] JWT token to join session.

Definition at line 164 of file ZoomVideoSDK.h.

userName

- (NSString* _Nullable) userName

readwritenonatomiccopy

[Required] User Name.

Definition at line 160 of file ZoomVideoSDK.h.

videoOption

- (ZoomVideoSDKVideoOptions* _Nullable) videoOption

readwritenonatomicstrong

[Optional] Video Option.

Definition at line 181 of file ZoomVideoSDK.h.

virtualAudioMicDelegate

- (id<ZoomVideoSDKVirtualAudioMic> _Nullable) virtualAudioMicDelegate

readwritenonatomicweak

[Optional] Session external audio source delegate.

Definition at line 196 of file ZoomVideoSDK.h.

virtualAudioSpeakerDelegate

- (id<ZoomVideoSDKVirtualAudioSpeaker> _Nullable) virtualAudioSpeakerDelegate

readwritenonatomicweak

[Optional] Session virtual speaker.

Definition at line 201 of file ZoomVideoSDK.h.