ZoomVideoSDKSessionContext Struct Reference

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

#include <zoom_video_sdk_def.h>

Public Member Functions
	ZoomVideoSDKSessionContext ()

Public Attributes
const zchar_t *	sessionName
	The name of the session to join.
const zchar_t *	sessionPassword
	The password for the session.
const zchar_t *	userName
	The display name of the user in the session.
const zchar_t *	token
	The JWT token used for session authentication.
ZoomVideoSDKVideoOption	videoOption
	Video configuration options.
ZoomVideoSDKAudioOption	audioOption
	Audio configuration options.
IZoomVideoSDKVideoSourcePreProcessor *	preProcessor
	Pointer to the camera data preprocessor object.
IZoomVideoSDKVideoSource *	externalVideoSource
	Pointer to the virtual camera source object. Use this to provide your own external video stream.
FrameDataFormat	externalVideoSourceDataFormat
	The frame data format for external video source initialization.
IZoomVideoSDKVirtualAudioMic *	virtualAudioMic
	Pointer to the virtual microphone object. Use this to provide custom audio input.
IZoomVideoSDKVirtualAudioSpeaker *	virtualAudioSpeaker
	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 583 of file zoom_video_sdk_def.h.

Constructor & Destructor Documentation

ZoomVideoSDKSessionContext()

ZoomVideoSDKSessionContext::ZoomVideoSDKSessionContext ( )

inline

Definition at line 656 of file zoom_video_sdk_def.h.

    {
        sessionName = nullptr;
        sessionPassword = nullptr;
        userName = nullptr;
        token = nullptr;
        preProcessor = nullptr;
        externalVideoSource = nullptr;
        virtualAudioMic = nullptr;
        virtualAudioSpeaker = nullptr;
        sessionIdleTimeoutMins = 40;
        autoLoadMutliStream = true;
        externalVideoSourceDataFormat = FrameDataFormat_I420_FULL;
    }

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

Member Data Documentation

audioOption

ZoomVideoSDKAudioOption ZoomVideoSDKSessionContext::audioOption

Audio configuration options.

Note

Optional.

Definition at line 614 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 654 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 625 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

externalVideoSourceDataFormat

FrameDataFormat ZoomVideoSDKSessionContext::externalVideoSourceDataFormat

The frame data format for external video source initialization.

Note

Optional. Effective when externalVideoSource is set. Default is FrameDataFormat_I420_FULL.

Definition at line 631 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 619 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 649 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 589 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 594 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 604 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 599 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().

videoOption

ZoomVideoSDKVideoOption ZoomVideoSDKSessionContext::videoOption

Video configuration options.

Note

Optional.

Definition at line 609 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 637 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 643 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKSessionContext().