Video SDK for Windows API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSessionContext Struct Reference

Configuration context for joining a Zoom Video SDK session. More...

#include <zoom_video_sdk_def.h>

Public Member Functions

 ZoomVideoSDKSessionContext ()
 

Data Fields

const zchar_tsessionName
 The name of the session to join.
 
const zchar_tsessionPassword
 The password for the session.
 
const zchar_tuserName
 The display name of the user in the session.
 
const zchar_ttoken
 The JWT token used for session authentication.
 
ZoomVideoSDKVideoOption videoOption
 Video configuration options.
 
ZoomVideoSDKAudioOption audioOption
 Audio configuration options.
 
IZoomVideoSDKVideoSourcePreProcessorpreProcessor
 Pointer to the camera data preprocessor object.
 
IZoomVideoSDKVideoSourceexternalVideoSource
 Pointer to the virtual camera source object. Use this to provide your own external video stream.
 
IZoomVideoSDKVirtualAudioMicvirtualAudioMic
 Pointer to the virtual microphone object. Use this to provide custom audio input.
 
IZoomVideoSDKVirtualAudioSpeakervirtualAudioSpeaker
 Pointer to the virtual speaker object. Use this to receive and process audio output.
 
unsigned int sessionIdleTimeoutMins
 The duration (in minutes) before an idle session times out. If set to 0, the session will never timeout automatically.
 
bool autoLoadMutliStream
 Whether to automatically load multiple video streams when joining a session.
 

Detailed Description

Configuration context for joining a Zoom Video SDK session.

Definition at line 482 of file zoom_video_sdk_def.h.

Constructor & Destructor Documentation

◆ ZoomVideoSDKSessionContext()

ZoomVideoSDKSessionContext::ZoomVideoSDKSessionContext ( )
inline

Definition at line 549 of file zoom_video_sdk_def.h.

550 {
551 sessionName = nullptr;
552 sessionPassword = nullptr;
553 userName = nullptr;
554 token = nullptr;
555 preProcessor = nullptr;
556 externalVideoSource = nullptr;
557 virtualAudioMic = nullptr;
558 virtualAudioSpeaker = nullptr;
560 autoLoadMutliStream = true;
561 }
IZoomVideoSDKVideoSourcePreProcessor * preProcessor
Pointer to the camera data preprocessor object.
const zchar_t * token
The JWT token used for session authentication.
IZoomVideoSDKVirtualAudioMic * virtualAudioMic
Pointer to the virtual microphone object. Use this to provide custom audio input.
const zchar_t * sessionPassword
The password for the session.
IZoomVideoSDKVirtualAudioSpeaker * virtualAudioSpeaker
Pointer to the virtual speaker object. Use this to receive and process audio output.
const zchar_t * userName
The display name of the user in the session.
IZoomVideoSDKVideoSource * externalVideoSource
Pointer to the virtual camera source object. Use this to provide your own external video stream.
unsigned int sessionIdleTimeoutMins
The duration (in minutes) before an idle session times out. If set to 0, the session will never timeo...
bool autoLoadMutliStream
Whether to automatically load multiple video streams when joining a session.
const zchar_t * sessionName
The name of the session to join.

References autoLoadMutliStream, externalVideoSource, preProcessor, sessionIdleTimeoutMins, sessionName, sessionPassword, token, userName, virtualAudioMic, and virtualAudioSpeaker.

Field Documentation

◆ audioOption

ZoomVideoSDKAudioOption ZoomVideoSDKSessionContext::audioOption

Audio configuration options.

Note
Optional.

Definition at line 513 of file zoom_video_sdk_def.h.

◆ autoLoadMutliStream

bool ZoomVideoSDKSessionContext::autoLoadMutliStream

Whether to automatically load multiple video streams when joining a session.

Note
Optional. Default is true.

Definition at line 547 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ externalVideoSource

IZoomVideoSDKVideoSource* ZoomVideoSDKSessionContext::externalVideoSource

Pointer to the virtual camera source object. Use this to provide your own external video stream.

Note
Optional.

Definition at line 524 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ preProcessor

IZoomVideoSDKVideoSourcePreProcessor* ZoomVideoSDKSessionContext::preProcessor

Pointer to the camera data preprocessor object.

Note
Optional.

Definition at line 518 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ sessionIdleTimeoutMins

unsigned int ZoomVideoSDKSessionContext::sessionIdleTimeoutMins

The duration (in minutes) before an idle session times out. If set to 0, the session will never timeout automatically.

Note
Optional. Default is 40 minutes.

Definition at line 542 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ sessionName

const zchar_t* ZoomVideoSDKSessionContext::sessionName

The name of the session to join.

Note
This is required.

Definition at line 488 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ sessionPassword

const zchar_t* ZoomVideoSDKSessionContext::sessionPassword

The password for the session.

Note
Optional.

Definition at line 493 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ token

const zchar_t* ZoomVideoSDKSessionContext::token

The JWT token used for session authentication.

Note
This is required.

Definition at line 503 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ userName

const zchar_t* ZoomVideoSDKSessionContext::userName

The display name of the user in the session.

Note
This is required.

Definition at line 498 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ videoOption

ZoomVideoSDKVideoOption ZoomVideoSDKSessionContext::videoOption

Video configuration options.

Note
Optional.

Definition at line 508 of file zoom_video_sdk_def.h.

◆ virtualAudioMic

IZoomVideoSDKVirtualAudioMic* ZoomVideoSDKSessionContext::virtualAudioMic

Pointer to the virtual microphone object. Use this to provide custom audio input.

Note
Optional.

Definition at line 530 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

◆ virtualAudioSpeaker

IZoomVideoSDKVirtualAudioSpeaker* ZoomVideoSDKSessionContext::virtualAudioSpeaker

Pointer to the virtual speaker object. Use this to receive and process audio output.

Note
Optional.

Definition at line 536 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().