ELECTRON API DOCS WINDOWS

Sets the playback position of an audio effect file. Gets the duration of the audio effect file. Resumes playing a specified audio effect. Releases a specified audio effect from the memory. Preloads a specified audio effect file into the memory. Sets the channel mode of the current music file. Sets the playback speed of the current music file.

ELECTRON API DOCS WINDOWS

Specifies the playback track of the current music file (for Android, iOS, and Windows only). Gets the audio track index of the current music file (for Android, iOS, and Windows only). Sets the playback position of the music file. Gets the playback position (ms) of the music file. Retrieves the audio mixing volume for publishing. Resumes playing and mixing the music file.Īdjusts the volume of audio mixing for local playback.Īdjusts the volume of audio mixing for remote playback.Īdjusts the audio mixing volume for publishing (for remote users). Pauses playing and mixing the music file. Starts playing and mixing the music file. Sets the content hint when using the video source. Updates the screen sharing parameters when using the video source. Updates the screen sharing region when using the video source. Stops the local video preview when using the video source. Starts the local video preview when using the video source. Stops the screen sharing when using the video source. Sets the video profile for the video captured by the camera device. Shares the whole or part of a window by specifying the window ID when using the video source. Shares the whole or part of a screen by specifying the screen rect when using the video source. Sets the screen sharing scenario (for macOS and Windows only). Sets the content hint for screen sharing. Shares the whole or part of a window by specifying the window symbol. Shares the whole or part of a screen by specifying the screen symbol. Shares the whole or part of a screen by specifying the display ID (for macOS and Windows only).

Gets a list of shareable screens and windows (for macOS and Windows only). Provides callbacks that report events and statistics in a specified channel. Provides methods that enable real-time communications in a specified channel. (beta function)Ĭreates and gets an AgoraRtcChannel object. Video pre-process and post-process MethodĮnables/Disables the virtual background. Removes the rendered video with high frame rate. Sets the high frame rate of the rendered video.Īdds the rendered video with high frame rate. Sets the frame rate of the rendered video. Sets whether to receive all remote video streams by default. Stops/Resumes receiving all remote video streams. Stops/Resumes receiving a specified remote video stream. Stops/Resumes sending the local video stream. Sets whether to receive all remote audio streams by default.Įnables/Disables the local video capture. Stops/Resumes receiving all remote audio streams. Stops/Resumes receiving a specified remote audio stream. Stops/Resumes sending the local audio stream. Sets the audio parameters and application scenarios.Īdjusts the volume of the signal captured by the microphone.Īdjusts the volume of the signal captured by the sound card.Īdjusts the playback volume of the voice.Īdjusts the playback volume of a specified remote user.Įnables/disables the local audio capture. Stops monitoring the events during AgoraRtcEngine runtime. Monitors the events during AgoraRtcEngine runtime. Subscribes to the remote user and initializes the video sink Switches to a different channel (interactive live streaming only). Sets the role and level of the user (interactive live streaming only). Sets the role of the user (interactive live streaming only). The AgoraRtcChannel.on listens to events and statistics of a specified channel. By creating multiple AgoraRtcChannel objects, the user can join multiple channels. The AgoraRtcChannel class provides methods that enable real-time communications in a specified channel.

The AgoraRtcEngine.on listens to events during runtime. The AgoraRtcEngine class provides the main methods that can be invoked by your application. Agora provides ensured quality of experience (QoE) for worldwide Internet-based voice and video communications through a virtual global network optimized on all platforms. The Electron SDK supports all the functions of the Agora Native SDK. This Agora Electron SDK is developed upon the Native SDK for macOS and the Native SDK for Windows, with the Node.js C++ plug-in units.

Electron api docs