Search
Preparing search index...
The search index is not available
Voice SDK v3.7.0 API Reference for Electron
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
Voice SDK v3.7.0 API Reference for Electron
Index
Enumerations
AUDIENCE_
LATENCY_
LEVEL_
TYPE
AUDIO_
CODEC_
PROFILE_
TYPE
AUDIO_
EFFECT_
PRESET
AUDIO_
FILE_
INFO_
ERROR
AUDIO_
MIXING_
DUAL_
MONO_
MODE
AUDIO_
RECORDING_
POSITION
AUDIO_
RECORDING_
QUALITY_
TYPE
AUDIO_
ROUTE_
TYPE
Agora
Network
Quality
Audio
Device
Test
Volume
Type
Audio
Reverb
Preset
BACKGROUND_
BLUR_
DEGREE
BACKGROUND_
SOURCE_
TYPE
CAPTURE_
BRIGHTNESS_
LEVEL_
TYPE
CLIENT_
ROLE_
CHANGE_
FAILED_
REASON
CLIENT_
ROLE_
TYPE
CLOUD_
PROXY_
TYPE
CONNECTION_
CHANGED_
REASON_
TYPE
CONNECTION_
STATE_
TYPE
Capture
Out
Preference
Channel
Media
Relay
Error
Channel
Media
Relay
Event
Channel
Media
Relay
State
Degradation
Preference
ENCRYPTION_
MODE
FILT_
WINDOW_
ERROR
LIGHTENING_
CONTRAST_
LEVEL
LOCAL_
AUDIO_
STREAM_
ERROR
LOCAL_
AUDIO_
STREAM_
STATE
LOCAL_
PROXY_
MODE
LOCAL_
VIDEO_
STREAM_
ERROR
LOCAL_
VIDEO_
STREAM_
STATE
LOW_
LIGHT_
ENHANCE_
LEVEL
LOW_
LIGHT_
ENHANCE_
MODE
Media
Device
Type
NETWORK_
TYPE
Orientation
Mode
PROXY_
TYPE
Priority
Quality
Adapt
Indication
RTMP_
STREAMING_
EVENT
Remote
Audio
State
Remote
Audio
State
Reason
Remote
Video
State
Remote
Video
State
Reason
SCREEN_
SCENARIO_
TYPE
STREAM_
PUBLISH_
STATE
STREAM_
SUBSCRIBE_
STATE
Stream
Type
VIDEO_
CODEC_
TYPE
VIDEO_
CODEC_
TYPE_
FOR_
STREAM
VIDEO_
DENOISER_
LEVEL
VIDEO_
DENOISER_
MODE
VIDEO_
PROFILE_
TYPE
VIRTUAL_
BACKGROUND_
SOURCE_
STATE_
REASON
VOICE_
BEAUTIFIER_
PRESET
VOICE_
CONVERSION_
PRESET
Video
Content
Hint
Video
Mirror
Mode
Type
Voice
Changer
Preset
Classes
Agora
Rtc
Channel
Agora
Rtc
Engine
Interfaces
Audio
File
Info
Audio
Recording
Configuration
Beauty
Options
Camera
Capturer
Configuration
Capture
Param
Channel
Media
Info
Channel
Media
Options
Channel
Media
Relay
Configuration
Client
Role
Options
Color
Enhance
Options
Data
Stream
Config
Display
Id
Display
Info
Echo
Test
Configuration
Encryption
Config
Inject
Stream
Config
Lastmile
Probe
Config
Lastmile
Probe
One
Way
Result
Lastmile
Probe
Result
Live
Stream
Advanced
Feature
Local
Access
Point
Configuration
Local
Audio
Stats
Local
Video
Stats
Log
Config
Low
Light
Enhance
Options
Metadata
Rectangle
Remote
Audio
Stats
Remote
Audio
Transport
Stats
Remote
Video
Stats
Remote
Video
Transport
Stats
Renderer
Options
Rtc
Image
Rtc
Stats
SIZE
Screen
Capture
Info
Spatial
Audio
Params
Transcoding
Config
Transcoding
User
User
Info
Video
Denoiser
Options
Video
Encoder
Configuration
Virtual
Background
Source
Watermark
Options
Window
Info
Type aliases
AREA_
CODE
Capture
Rect
Mac
Screen
Symbol
Screen
Symbol
Uint8
Array
Buffer
Windows
Screen
Symbol
Variables
agora
Type aliases
AREA_
CODE
AREA_
CODE
:
1
|
2
|
4
|
8
|
16
|
32
|
4294967295
Regions for connection.
since
v3.2.0
1: Mainland China.
2: North America.
4: Europe.
8: Asia, excluding Mainland China.
16: Japan.
32: India.
0xFFFFFFFF: (Default) Global.
Capture
Rect
Capture
Rect
:
Rectangle
Mac
Screen
Symbol
Mac
Screen
Symbol
:
DisplayId
Screen
Symbol
Screen
Symbol
:
MacScreenSymbol
|
WindowsScreenSymbol
The screen symbol:
The screen symbol on the macOS platform, see
MacScreenSymbol
The screen symbol on the Windows platform, see
WindowsScreenSymbol
Uint8
Array
Buffer
Uint8
Array
Buffer
:
ArrayBuffer
Windows
Screen
Symbol
Windows
Screen
Symbol
:
Rectangle
Variables
Const
agora
agora
:
any
= require('../../build/Release/agora_node_ext')
Globals
AUDIENCE_
LATENCY_
LEVEL_
TYPE
AUDIO_
CODEC_
PROFILE_
TYPE
AUDIO_
EFFECT_
PRESET
AUDIO_
FILE_
INFO_
ERROR
AUDIO_
MIXING_
DUAL_
MONO_
MODE
AUDIO_
RECORDING_
POSITION
AUDIO_
RECORDING_
QUALITY_
TYPE
AUDIO_
ROUTE_
TYPE
Agora
Network
Quality
Audio
Device
Test
Volume
Type
Audio
Reverb
Preset
BACKGROUND_
BLUR_
DEGREE
BACKGROUND_
SOURCE_
TYPE
CAPTURE_
BRIGHTNESS_
LEVEL_
TYPE
CLIENT_
ROLE_
CHANGE_
FAILED_
REASON
CLIENT_
ROLE_
TYPE
CLOUD_
PROXY_
TYPE
CONNECTION_
CHANGED_
REASON_
TYPE
CONNECTION_
STATE_
TYPE
Capture
Out
Preference
Channel
Media
Relay
Error
Channel
Media
Relay
Event
Channel
Media
Relay
State
Degradation
Preference
ENCRYPTION_
MODE
FILT_
WINDOW_
ERROR
LIGHTENING_
CONTRAST_
LEVEL
LOCAL_
AUDIO_
STREAM_
ERROR
LOCAL_
AUDIO_
STREAM_
STATE
LOCAL_
PROXY_
MODE
LOCAL_
VIDEO_
STREAM_
ERROR
LOCAL_
VIDEO_
STREAM_
STATE
LOW_
LIGHT_
ENHANCE_
LEVEL
LOW_
LIGHT_
ENHANCE_
MODE
Media
Device
Type
NETWORK_
TYPE
Orientation
Mode
PROXY_
TYPE
Priority
Quality
Adapt
Indication
RTMP_
STREAMING_
EVENT
Remote
Audio
State
Remote
Audio
State
Reason
Remote
Video
State
Remote
Video
State
Reason
SCREEN_
SCENARIO_
TYPE
STREAM_
PUBLISH_
STATE
STREAM_
SUBSCRIBE_
STATE
Stream
Type
VIDEO_
CODEC_
TYPE
VIDEO_
CODEC_
TYPE_
FOR_
STREAM
VIDEO_
DENOISER_
LEVEL
VIDEO_
DENOISER_
MODE
VIDEO_
PROFILE_
TYPE
VIRTUAL_
BACKGROUND_
SOURCE_
STATE_
REASON
VOICE_
BEAUTIFIER_
PRESET
VOICE_
CONVERSION_
PRESET
Video
Content
Hint
Video
Mirror
Mode
Type
Voice
Changer
Preset
Agora
Rtc
Channel
Agora
Rtc
Engine
Audio
File
Info
Audio
Recording
Configuration
Beauty
Options
Camera
Capturer
Configuration
Capture
Param
Channel
Media
Info
Channel
Media
Options
Channel
Media
Relay
Configuration
Client
Role
Options
Color
Enhance
Options
Data
Stream
Config
Display
Id
Display
Info
Echo
Test
Configuration
Encryption
Config
Inject
Stream
Config
Lastmile
Probe
Config
Lastmile
Probe
One
Way
Result
Lastmile
Probe
Result
Live
Stream
Advanced
Feature
Local
Access
Point
Configuration
Local
Audio
Stats
Local
Video
Stats
Log
Config
Low
Light
Enhance
Options
Metadata
Rectangle
Remote
Audio
Stats
Remote
Audio
Transport
Stats
Remote
Video
Stats
Remote
Video
Transport
Stats
Renderer
Options
Rtc
Image
Rtc
Stats
SIZE
Screen
Capture
Info
Spatial
Audio
Params
Transcoding
Config
Transcoding
User
User
Info
Video
Denoiser
Options
Video
Encoder
Configuration
Virtual
Background
Source
Watermark
Options
Window
Info
AREA_
CODE
Capture
Rect
Mac
Screen
Symbol
Screen
Symbol
Uint8
Array
Buffer
Windows
Screen
Symbol
agora
Regions for connection.
v3.2.0