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

Aduio option used by ZoomVideoSDKSessionContext. More...

#include <zoom_video_sdk_def.h>

Public Member Functions

 ZoomVideoSDKAudioOption ()
 

Data Fields

bool connect
 Whether to connect the local audio when joining a session.
 
bool mute
 Whether to mute the audio initially.
 
bool isMyVoiceInMix
 Whether my voice should be included in the mixed audio raw data.
 
bool autoAdjustSpeakerVolume
 Whether to automatically adjust the speaker volume. If true, the SDK will automatically raise the volume if it's muted or too low.
 

Detailed Description

Aduio option used by ZoomVideoSDKSessionContext.

Definition at line 442 of file zoom_video_sdk_def.h.

Constructor & Destructor Documentation

◆ ZoomVideoSDKAudioOption()

ZoomVideoSDKAudioOption::ZoomVideoSDKAudioOption ( )
inline

Definition at line 465 of file zoom_video_sdk_def.h.

466 {
467 connect = true;
468 mute = false;
469 isMyVoiceInMix = true;
471 }
bool mute
Whether to mute the audio initially.
bool isMyVoiceInMix
Whether my voice should be included in the mixed audio raw data.
bool connect
Whether to connect the local audio when joining a session.
bool autoAdjustSpeakerVolume
Whether to automatically adjust the speaker volume. If true, the SDK will automatically raise the vol...

References autoAdjustSpeakerVolume, connect, isMyVoiceInMix, and mute.

Field Documentation

◆ autoAdjustSpeakerVolume

bool ZoomVideoSDKAudioOption::autoAdjustSpeakerVolume

Whether to automatically adjust the speaker volume. If true, the SDK will automatically raise the volume if it's muted or too low.

Note
Default is false.

Definition at line 464 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKAudioOption().

◆ connect

bool ZoomVideoSDKAudioOption::connect

Whether to connect the local audio when joining a session.

Note
Default is true. Whether to connect local audio or not.

Definition at line 448 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKAudioOption().

◆ isMyVoiceInMix

bool ZoomVideoSDKAudioOption::isMyVoiceInMix

Whether my voice should be included in the mixed audio raw data.

Note
Default is true.

Definition at line 458 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKAudioOption().

◆ mute

bool ZoomVideoSDKAudioOption::mute

Whether to mute the audio initially.

Note
Default is false.

Definition at line 453 of file zoom_video_sdk_def.h.

Referenced by ZoomVideoSDKAudioOption().